dtCore::Effect Class Reference

The base class of all effects. More...

#include <effectmanager.h>

Inheritance diagram for dtCore::Effect:

List of all members.

Public Member Functions
	Effect (osg::Node *node, double timeToLive)
	Constructor.
osg::Node *	GetNode ()
	Returns the effect's OpenSceneGraph node.
const osg::Node *	GetNode () const
void	SetTimeToLive (double timeToLive)
	Sets the remaining lifespan of this effect.
double	GetTimeToLive ()
	Returns the remaining lifespan of this effect.
void	SetDying (bool dying)
	Sets the dying flag.
bool	IsDying ()
	Checks the dying flag.
Protected Member Functions
virtual	~Effect ()
	Destructor.

---

Detailed Description

The base class of all effects.

---

Constructor & Destructor Documentation

dtCore::Effect::Effect	(	osg::Node *	node,
		double	timeToLive
	)

Constructor.

Parameters:

	node	the effect's OpenSceneGraph node
	timeToLive	the lifespan of the effect in seconds, or 0.0 for unlimited

dtCore::Effect::~Effect

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

osg::Node * dtCore::Effect::GetNode

(

)

Returns the effect's OpenSceneGraph node.

Returns:

the effect's OpenSceneGraph node

const osg::Node * dtCore::Effect::GetNode

(

)

const

void dtCore::Effect::SetTimeToLive

(

double

timeToLive

)

Sets the remaining lifespan of this effect.

Parameters:

timeToLive

the remaining lifespan, in seconds, or 0.0 for unlimited

double dtCore::Effect::GetTimeToLive

(

)

Returns the remaining lifespan of this effect.

Returns:

the remaining lifespan, in seconds, or 0.0 for unlimited

the remaining lifespan, in seconds, or 0.0 for unlimited

void dtCore::Effect::SetDying

(

bool

dying

)

Sets the dying flag.

Parameters:

dying

the new value of the dying flag

bool dtCore::Effect::IsDying

(

)

Checks the dying flag.

Returns:

the value of the dying flag

---