Shadow Class Reference

#include <Shadow.h>

Inherited by W3DProjectedShadow, and W3DVolumetricShadow.

Classes
struct	ShadowTypeInfo

Public Member Functions
	Shadow (void)
	if this is set, then no render will occur, even if enableShadowRender() is enabled. Used by Shroud.
void	enableShadowInvisible (Bool isEnabled)
void	enableShadowRender (Bool isEnabled)
Bool	isRenderEnabled (void)
Bool	isInvisibleEnabled (void)
virtual void	release (void)=0
	release this shadow from suitable manager.
void	setOpacity (Int value)
	adjust opacity of decal/shadow
void	setColor (Color value)
	adjust ARGB color of decal/shadow
void	setAngle (Real angle)
	adjust orientation around z-axis
void	setPosition (Real x, Real y, Real z)
void	setSize (Real sizeX, Real sizeY)

Protected Attributes
Bool	m_isEnabled
Bool	m_isInvisibleEnabled
	toggle to turn rendering of this shadow on/off.
UnsignedInt	m_opacity
	if set, overrides and causes no rendering.
UnsignedInt	m_color
	color in ARGB format. (Alpha is ignored).
ShadowType	m_type
Int	m_diffuse
	type of projection
Real	m_x
	diffuse color used to tint/fade shadow.
Real	m_y
Real	m_z
Real	m_oowDecalSizeX
	world position of shadow center when not bound to robj/drawable.
Real	m_oowDecalSizeY
	1/(world space extent of texture in x direction)
Real	m_decalSizeX
	1/(world space extent of texture in y direction)
Real	m_decalSizeY
	1/(world space extent of texture in x direction)
Real	m_localAngle
	1/(world space extent of texture in y direction)

Detailed Description

Definition at line 72 of file Shadow.h.

Constructor & Destructor Documentation

Shadow()

Shadow::Shadow ( void )

inline

if this is set, then no render will occur, even if enableShadowRender() is enabled. Used by Shroud.

Definition at line 89 of file Shadow.h.

Member Function Documentation

enableShadowInvisible()

void Shadow::enableShadowInvisible ( Bool isEnabled )

inline

Definition at line 148 of file Shadow.h.

enableShadowRender()

void Shadow::enableShadowRender ( Bool isEnabled )

inline

Definition at line 143 of file Shadow.h.

isInvisibleEnabled()

Bool Shadow::isInvisibleEnabled ( void )

inline

Definition at line 95 of file Shadow.h.

isRenderEnabled()

Bool Shadow::isRenderEnabled ( void )

inline

Definition at line 94 of file Shadow.h.

release()

virtual void Shadow::release ( void )

pure virtual

release this shadow from suitable manager.

Implemented in W3DProjectedShadow, and W3DVolumetricShadow.

setAngle()

void Shadow::setAngle ( Real angle )

inline

adjust orientation around z-axis

Definition at line 200 of file Shadow.h.

setColor()

void Shadow::setColor ( Color value )

inline

adjust ARGB color of decal/shadow

Definition at line 175 of file Shadow.h.

setOpacity()

void Shadow::setOpacity ( Int value )

inline

adjust opacity of decal/shadow

Todo

: Pull these out so casting, etc. is only done for visible decals.

Definition at line 154 of file Shadow.h.

setPosition()

void Shadow::setPosition ( Real x, Real y, Real z )

inline

Definition at line 195 of file Shadow.h.

setSize()

void Shadow::setSize ( Real sizeX, Real sizeY )

inline

Definition at line 102 of file Shadow.h.

Member Data Documentation

m_color

UnsignedInt Shadow::m_color

protected

color in ARGB format. (Alpha is ignored).

Definition at line 128 of file Shadow.h.

m_decalSizeX

Real Shadow::m_decalSizeX

protected

1/(world space extent of texture in y direction)

Definition at line 134 of file Shadow.h.

m_decalSizeY

Real Shadow::m_decalSizeY

protected

1/(world space extent of texture in x direction)

Definition at line 135 of file Shadow.h.

m_diffuse

Int Shadow::m_diffuse

protected

type of projection

Definition at line 130 of file Shadow.h.

m_isEnabled

Bool Shadow::m_isEnabled

protected

Definition at line 125 of file Shadow.h.

m_isInvisibleEnabled

Bool Shadow::m_isInvisibleEnabled

protected

toggle to turn rendering of this shadow on/off.

Definition at line 126 of file Shadow.h.

m_localAngle

Real Shadow::m_localAngle

protected

1/(world space extent of texture in y direction)

Definition at line 136 of file Shadow.h.

m_oowDecalSizeX

Real Shadow::m_oowDecalSizeX

protected

world position of shadow center when not bound to robj/drawable.

Definition at line 132 of file Shadow.h.

m_oowDecalSizeY

Real Shadow::m_oowDecalSizeY

protected

1/(world space extent of texture in x direction)

Definition at line 133 of file Shadow.h.

m_opacity

UnsignedInt Shadow::m_opacity

protected

if set, overrides and causes no rendering.

value between 0 (transparent) and 255 (opaque)

Definition at line 127 of file Shadow.h.

m_type

ShadowType Shadow::m_type

protected

Definition at line 129 of file Shadow.h.

m_x

Real Shadow::m_x

protected

diffuse color used to tint/fade shadow.

Definition at line 131 of file Shadow.h.

m_y

Real Shadow::m_y

protected

Definition at line 131 of file Shadow.h.

m_z

Real Shadow::m_z

protected

Definition at line 131 of file Shadow.h.

---

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

• Code/GameEngine/Include/GameClient/Shadow.h