lse::CLightBase Class Reference

The base class for lights, which provides common functionality and data between all lights, such as diffuse colors, etc. More...

#include <LSELightBase.h>

Inheritance diagram for lse::CLightBase:

List of all members.

Public Member Functions
virtual LSE_LIGHT_TYPE LSE_CALL	LightType () const
LSE_INLINE const CVector3 &LSE_CALL	Diffuse () const
LSE_INLINE CVector3 &LSE_CALL	Diffuse ()
LSE_INLINE const CVector3 &LSE_CALL	Ambient () const
LSE_INLINE CVector3 &LSE_CALL	Ambient ()
LSE_INLINE const CVector3 &LSE_CALL	Specular () const
LSE_INLINE CVector3 &LSE_CALL	Specular ()
LSE_INLINE LSREAL LSE_CALL	Size () const
LSE_INLINE LSREAL &LSE_CALL	Size ()
LSE_INLINE LSBOOL LSE_CALL	Active () const
LSE_INLINE LSVOID LSE_CALL	SetActive (LSBOOL _bVal)
LSE_INLINE LSBOOL LSE_CALL	CastsShadows () const
LSE_INLINE LSVOID LSE_CALL	SetCastsShadows (LSBOOL _bVal)
Protected Attributes
CVector3	m_vDiffuse
CVector3	m_vAmbient
CVector3	m_vSpecular
LSREAL	m_fSize
LSBOOL	m_bActive
LSBOOL	m_bShadows

---

Detailed Description

The base class for lights, which provides common functionality and data between all lights, such as diffuse colors, etc.

Class CLightBase Description: The base class for lights, which provides common functionality and data between all lights, such as diffuse colors, etc.

---

Member Function Documentation

LSE_INLINE LSBOOL LSE_CALL lse::CLightBase::Active

(

)

const

Gets whether the light is on.

Returns:

Returns true if the light is on.

LSE_INLINE const CVector3 &LSE_CALL lse::CLightBase::Ambient

(

)

const

Gets the ambient color of the light.

Returns:

Returns the ambient color of the light.

LSE_INLINE CVector3 &LSE_CALL lse::CLightBase::Ambient

(

)

Sets the ambient color of the light.

Returns:

Returns the ambient color of the light for modification.

LSE_INLINE LSBOOL LSE_CALL lse::CLightBase::CastsShadows

(

)

const

Gets whether the light casts a shadow.

Returns:

Returns true if the light casts a shadow.

LSE_INLINE const CVector3 &LSE_CALL lse::CLightBase::Diffuse

(

)

const

Gets the diffuse color of the light.

Returns:

Returns the diffuse color of the light.

LSE_INLINE CVector3 &LSE_CALL lse::CLightBase::Diffuse

(

)

Sets the diffuse color of the light.

Returns:

Returns the diffuse color of the light for modification.

virtual LSE_LIGHT_TYPE LSE_CALL lse::CLightBase::LightType

(

)

const [virtual]

Gets the light type. Must be overridden.

Returns:

Returns the type of this light.

LSE_INLINE LSVOID LSE_CALL lse::CLightBase::SetActive

(

LSBOOL

_bVal

)

Sets whether or not the light is active.

Parameters:

_bVal

Any non-zero value indicates the light is on, otherwise off.

LSE_INLINE LSVOID LSE_CALL lse::CLightBase::SetCastsShadows

(

LSBOOL

_bVal

)

Sets whether or not the light casts a shadow.

Parameters:

_bVal

Any non-zero value indicates the light casts a shadow, otherwise it does not.

LSE_INLINE LSREAL LSE_CALL lse::CLightBase::Size

(

)

const

Gets the size of the light.

Returns:

Returns the size of the light.

LSE_INLINE LSREAL &LSE_CALL lse::CLightBase::Size

(

)

Sets the size of the light.

Returns:

Returns the size of the light for modification.

LSE_INLINE CVector3 &LSE_CALL lse::CLightBase::Specular

(

)

Sets the specular color of the light.

Returns:

Returns the specular color of the light for modification.

LSE_INLINE const CVector3 &LSE_CALL lse::CLightBase::Specular

(

)

const

Gets the specular color of the light.

Returns:

Returns the specular color of the light.

---

Member Data Documentation

LSBOOL lse::CLightBase::m_bActive [protected]

Is the light on?

LSBOOL lse::CLightBase::m_bShadows [protected]

Does the light cast a shadow?

LSREAL lse::CLightBase::m_fSize [protected]

The size of the light (for soft shadows).

CVector3 lse::CLightBase::m_vAmbient [protected]

The ambient color.

CVector3 lse::CLightBase::m_vDiffuse [protected]

The diffuse color.

CVector3 lse::CLightBase::m_vSpecular [protected]

The specular color.

---

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

• F:/My Projects/LSEngine/Modules/LSEngine/Src/Lights/LSELightBase.h