fluidvis
Public Member Functions | List of all members
sx::Effect Class Reference
Inheritance diagram for sx::Effect:
sx::SXResource

Public Member Functions

EX Effect (const string &id)
 
EX ~Effect ()
 
EX void load ()
 
EX bool isLoaded () const
 
EX void setVisible (bool visible)
 
EX bool isVisible () const
 
EX vector< EffectCommand > & getObjects ()
 
EX void render ()
 
- Public Member Functions inherited from sx::SXResource
virtual EX ~SXResource ()
 
EX const string & getID () const
 

Additional Inherited Members

- Protected Attributes inherited from sx::SXResource
string id
 

Constructor & Destructor Documentation

EX sx::Effect::Effect ( const string &  id)

constructor

EX sx::Effect::~Effect ( )

deconstructor

Member Function Documentation

EX vector<EffectCommand>& sx::Effect::getObjects ( )

Returns a vector containing all EffectObjects rendered by method render. The passes are rendered in the order given by the returned vector.

EX bool sx::Effect::isLoaded ( ) const
virtual

as this is always loaded, the return value is always true

Implements sx::SXResource.

EX bool sx::Effect::isVisible ( ) const

getter

EX void sx::Effect::load ( )
virtual

as this is always loaded, this method has no effect on this

Implements sx::SXResource.

EX void sx::Effect::render ( )

Calls execute in all EffectObjects in the order given by vector objects, and provides them with the input associated with them through struct EffectCommand through the parameter of method execute. If visible is false, the method doesn't do anything.

EX void sx::Effect::setVisible ( bool  visible)

setter


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