deComponentModifier Class Reference

Scene Component Modifier. More...

#include <deComponentModifier.h>

List of all members.

Public Member Functions
Constructors and Destructors
	deComponentModifier (int index)
	Creates a new modifier.
	~deComponentModifier ()
	Cleans up the modifier.
Management
int	GetModifierIndex () const
	Retrieves the index of the tracked render modifier.
deSkin *	GetSkin () const
	Retrieves the skin to set or NULL if no skin replacement has to be done.
void	SetSkin (deSkin *skin)
	Sets the skin to set or NULL if no skin replacement has to be done.
deEffect *	GetEffect () const
	Retrieves the effect to enable or NULL if no effect enabling has to be done.
void	SetEffect (deEffect *effect)
	Sets the effect to enable or NULL if no effect enabling has to be done.

---

Detailed Description

Scene Component Modifier.

Components can use the render modifiers set in the rendering camera object to adjust their skin and effects on the fly. An enabled render modifier alters the component before rendering. Render modifiers with a higher index overwrite the changes made by lower ranking render modifiers. The following modifications can be done:

• Skin: If set replaces the base skin of the component.
• Effect: If set enables the given effect.

Notifications

If you change the content of the modifier after it has been added to a component you have to call the NotifyModifierChanged of the component yourself to make sure the changes propagate correctly.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deComponentModifier::deComponentModifier

(

int

index )

Creates a new modifier.

deComponentModifier::~deComponentModifier

(

)

Cleans up the modifier.

---

Member Function Documentation

deEffect* deComponentModifier::GetEffect

(

)

const [inline]

Retrieves the effect to enable or NULL if no effect enabling has to be done.

int deComponentModifier::GetModifierIndex

(

)

const [inline]

Retrieves the index of the tracked render modifier.

deSkin* deComponentModifier::GetSkin

(

)

const [inline]

Retrieves the skin to set or NULL if no skin replacement has to be done.

void deComponentModifier::SetEffect

(

deEffect *

effect )

Sets the effect to enable or NULL if no effect enabling has to be done.

void deComponentModifier::SetSkin

(

deSkin *

skin )

Sets the skin to set or NULL if no skin replacement has to be done.

---

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

• deComponentModifier.h