Effect Class Reference

#include <effect.h>

Inheritance diagram for Effect:

Collaboration diagram for Effect:

Public Member Functions
	Effect ()
virtual	~Effect ()
virtual Effect *	clone () const =0
virtual void	enable (unsigned int pass=0) const =0
virtual void	disable () const =0
std::string	getName () const
virtual bool	writeState (std::ofstream &f, unsigned int format, unsigned int depth) const =0
virtual bool	readState (xmlNodePtr n)=0
virtual bool	needCamUpdate () const
virtual bool	willDoSomething () const =0
	Returns true if the effect has any influence on the output. More...
virtual unsigned int	numPassesNeeded () const
virtual unsigned int	getType () const

Static Public Member Functions
static void	setCurCam (Camera *c)
static void	setBoundingCube (const BoundCube &c)

Protected Attributes
unsigned int	effectType

Static Protected Attributes
static Camera *	curCam =0
static BoundCube	bc

Constructor & Destructor Documentation

Effect()

Effect::Effect

(

)

References COMPILE_ASSERT, EFFECT_NAMES, NUM_EFFECTS, and THREEDEP_ARRAYSIZE.

~Effect()

virtual Effect::~Effect ( )

inlinevirtual

References clone(), disable(), enable(), getName(), readState(), and writeState().

Member Function Documentation

clone()

virtual Effect* Effect::clone ( ) const

pure virtual

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by AnaglyphEffect::~AnaglyphEffect(), BoxCropEffect::~BoxCropEffect(), and ~Effect().

Here is the caller graph for this function:

disable()

virtual void Effect::disable ( ) const

pure virtual

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by AnaglyphEffect::~AnaglyphEffect(), BoxCropEffect::~BoxCropEffect(), and ~Effect().

Here is the caller graph for this function:

enable()

virtual void Effect::enable ( unsigned int  pass = 0 ) const

pure virtual

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by BoxCropEffect::useCamCoords(), AnaglyphEffect::~AnaglyphEffect(), BoxCropEffect::~BoxCropEffect(), and ~Effect().

Here is the caller graph for this function:

getName()

std::string Effect::getName

(

)

const

References EFFECT_NAMES, and getType().

Referenced by ~Effect().

Here is the caller graph for this function:

getType()

virtual unsigned int Effect::getType ( ) const

inlinevirtual

References effectType.

Referenced by getName().

Here is the caller graph for this function:

needCamUpdate()

virtual bool Effect::needCamUpdate ( ) const

inlinevirtual

Reimplemented in AnaglyphEffect.

References willDoSomething().

numPassesNeeded()

virtual unsigned int Effect::numPassesNeeded ( ) const

inlinevirtual

Reimplemented in AnaglyphEffect.

readState()

virtual bool Effect::readState ( xmlNodePtr  n )

pure virtual

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by AnaglyphEffect::~AnaglyphEffect(), BoxCropEffect::~BoxCropEffect(), and ~Effect().

Here is the caller graph for this function:

setBoundingCube()

static void Effect::setBoundingCube ( const BoundCube &  c )

inlinestatic

Referenced by Scene::~Scene().

Here is the caller graph for this function:

setCurCam()

static void Effect::setCurCam ( Camera *  c )

inlinestatic

Referenced by Scene::draw().

Here is the caller graph for this function:

willDoSomething()

virtual bool Effect::willDoSomething ( ) const

pure virtual

Returns true if the effect has any influence on the output.

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by needCamUpdate(), and BoxCropEffect::~BoxCropEffect().

Here is the caller graph for this function:

writeState()

virtual bool Effect::writeState ( std::ofstream &  f, unsigned int  format, unsigned int  depth  ) const

pure virtual

Implemented in AnaglyphEffect, and BoxCropEffect.

Referenced by AnaglyphEffect::~AnaglyphEffect(), BoxCropEffect::~BoxCropEffect(), and ~Effect().

Here is the caller graph for this function:

Member Data Documentation

bc

BoundCube Effect::bc

staticprotected

Referenced by BoxCropEffect::enable().

curCam

Camera * Effect::curCam =0

staticprotected

Referenced by AnaglyphEffect::disable(), BoxCropEffect::enable(), and AnaglyphEffect::enable().

effectType

unsigned int Effect::effectType

protected

Referenced by AnaglyphEffect::AnaglyphEffect(), BoxCropEffect::BoxCropEffect(), and getType().

---

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

• effect.h
• effect.cpp