Drag[en]gine Game Engine  1.0
deEffect Class Reference

Effect Class. More...

#include <deEffect.h>

Inheritance diagram for deEffect:
deResource deObject deEffectColorMatrix deEffectDistortImage deEffectFilterKernel deEffectOverlayImage

Public Member Functions

Management
bool GetEnabled () const
 
void SetEnabled (bool enabled)
 
System Peers
deBaseGraphicEffectGetGraphicEffect () const
 
void SetGraphicEffect (deBaseGraphicEffect *graEffect)
 
Visiting

Retrieves the physics system peer object. Sets the physics system peer object.

virtual void Visit (deEffectVisitor *visitor)
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deEffect (deEffectManager *manager)
 
virtual ~deEffect ()
 Clean up world. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Effect Class.

Effects describe alterations of a world before it is rendered. Such effects can alter the final image ( called post processing ) or alter the state of some objects. Various effects can be combined to achieve all sorts of complex effects.

Author
Pl├╝ss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deEffect()

deEffect::deEffect ( deEffectManager manager)

Creates a new world object with the given resource manager.

◆ ~deEffect()

virtual deEffect::~deEffect ( )
protectedvirtual

Clean up world.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetEnabled()

bool deEffect::GetEnabled ( ) const
inline

Determines if the effect is enabled.

References SetEnabled().

◆ GetGraphicEffect()

deBaseGraphicEffect* deEffect::GetGraphicEffect ( ) const
inline

Retrieves the graphic system peer object.

References SetGraphicEffect(), and Visit().

◆ SetEnabled()

void deEffect::SetEnabled ( bool  enabled)

Sets if the effect is enabled.

Referenced by GetEnabled().

◆ SetGraphicEffect()

void deEffect::SetGraphicEffect ( deBaseGraphicEffect graEffect)

Sets the graphic system peer object.

Referenced by GetGraphicEffect().

◆ Visit()

virtual void deEffect::Visit ( deEffectVisitor visitor)
virtual

Visits the effect.

Reimplemented in deEffectOverlayImage, deEffectFilterKernel, deEffectDistortImage, and deEffectColorMatrix.

Referenced by GetGraphicEffect().


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