PLScene::SNLight Class Reference

Abstract light scene node base class. More...

#include <SNLight.h>

Inheritance diagram for PLScene::SNLight:

List of all members.

Public Types
enum	EFlags { Flares = 1<<10, Corona = 1<<11, Blend = 1<<12 }
	Scene node flags (SceneNode flags extension) More...
Public Member Functions
virtual PLS_API bool	IsPointLight () const
	Returns whether this scene node is a point light (SNPointLight) or not.
virtual PLS_API bool	IsProjectivePointLight () const
	Returns whether this scene node is a projective point light (SNProjectivePointLight) or not.
virtual PLS_API bool	IsSpotLight () const
	Returns whether this scene node is a spot light (SNSpotLight) or not.
virtual PLS_API bool	IsProjectiveSpotLight () const
	Returns whether this scene node is a projective spot light (SNProjectiveSpotLight) or not.
virtual PLS_API bool	IsDirectionalLight () const
	Returns whether this scene node is a directional light (SNDirectionalLight) or not.
Protected Member Functions
PLS_API	SNLight ()
	Default constructor.
virtual PLS_API	~SNLight ()
	Destructor.

---

Detailed Description

Abstract light scene node base class.

Note:

• Scene node scale is ignored

---

Member Enumeration Documentation

enum PLScene::SNLight::EFlags

Scene node flags (SceneNode flags extension)

Enumerator:

Flares	Lens flares
Corona	Corona around the light
Blend	Brighten the screen (blend effect)

Reimplemented from PLScene::SceneNode.

Reimplemented in PLScene::SNSpotLight, PLScene::SNProjectiveSpotLight, and PLScene::SNProjectivePointLight.

---

Constructor & Destructor Documentation

PLS_API PLScene::SNLight::SNLight

(

)

[protected]

Default constructor.

virtual PLS_API PLScene::SNLight::~SNLight

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

virtual PLS_API bool PLScene::SNLight::IsPointLight

(

)

const [virtual]

Returns whether this scene node is a point light (SNPointLight) or not.

Returns:

'true' if this scene node is a point light, else 'false'

Note:

• More performant than IsInstanceOf("PLScene::SNPointLight")

Reimplemented in PLScene::SNPointLight.

virtual PLS_API bool PLScene::SNLight::IsProjectivePointLight

(

)

const [virtual]

Returns whether this scene node is a projective point light (SNProjectivePointLight) or not.

Returns:

'true' if this scene node is a projective point light, else 'false'

Note:

• More performant than IsInstanceOf("PLScene::SNProjectivePointLight")

Reimplemented in PLScene::SNProjectivePointLight.

virtual PLS_API bool PLScene::SNLight::IsSpotLight

(

)

const [virtual]

Returns whether this scene node is a spot light (SNSpotLight) or not.

Returns:

'true' if this scene node is a spot light, else 'false'

Note:

• More performant than IsInstanceOf("PLScene::SNSpotLight")

Reimplemented in PLScene::SNSpotLight.

virtual PLS_API bool PLScene::SNLight::IsProjectiveSpotLight

(

)

const [virtual]

Returns whether this scene node is a projective spot light (SNProjectiveSpotLight) or not.

Returns:

'true' if this scene node is a projective spot light, else 'false'

Note:

• More performant than IsInstanceOf("PLScene::SNProjectiveSpotLight")

Reimplemented in PLScene::SNProjectiveSpotLight.

virtual PLS_API bool PLScene::SNLight::IsDirectionalLight

(

)

const [virtual]

Returns whether this scene node is a directional light (SNDirectionalLight) or not.

Returns:

'true' if this scene node is a directional light, else 'false'

Note:

• More performant than IsInstanceOf("PLScene::SNDirectionalLight")

Reimplemented in PLScene::SNDirectionalLight.

---

The documentation for this class was generated from the following file:

• SNLight.h