openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
osgFX::Effect Class Referenceabstract
Inheritance diagram for osgFX::Effect:
osg::Group osg::Node osg::Object osg::Referenced osgFX::AnisotropicLighting osgFX::BumpMapping osgFX::Cartoon osgFX::Outline osgFX::Scribe osgFX::SpecularHighlights

Public Types

enum  TechniqueSelection { AUTO_DETECT = -1 }
 
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
 
typedef unsigned int NodeMask
 
typedef std::vector< std::string > DescriptionList
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Effect ()
 
 Effect (const Effect &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual const char * effectName () const =0
 
virtual const char * effectDescription () const =0
 
virtual const char * effectAuthor () const =0
 
bool getEnabled () const
 
void setEnabled (bool v)
 
virtual void setUpDemo ()
 
int getNumTechniques () const
 
TechniquegetTechnique (int i)
 
const TechniquegetTechnique (int i) const
 
int getSelectedTechnique () const
 
void selectTechnique (int i=AUTO_DETECT)
 
virtual void traverse (osg::NodeVisitor &nv)
 
void inherited_traverse (osg::NodeVisitor &nv)
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Group)
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual bool addChild (Node *child)
 
virtual bool insertChild (unsigned int index, Node *child)
 
bool removeChild (Node *child)
 
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 
virtual bool replaceChild (Node *origChild, Node *newChild)
 
unsigned int getNumChildren () const
 
virtual bool setChild (unsigned int i, Node *node)
 
NodegetChild (unsigned int i)
 
const NodegetChild (unsigned int i) const
 
bool containsNode (const Node *node) const
 
unsigned int getChildIndex (const Node *node) const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
virtual BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setUpdateCallback (NodeCallback *nc)
 
NodeCallbackgetUpdateCallback ()
 
const NodeCallbackgetUpdateCallback () const
 
void addUpdateCallback (NodeCallback *nc)
 
void removeUpdateCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (NodeCallback *nc)
 
NodeCallbackgetEventCallback ()
 
const NodeCallbackgetEventCallback () const
 
void addEventCallback (NodeCallback *nc)
 
void removeEventCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (NodeCallback *nc)
 
NodeCallbackgetCullCallback ()
 
const NodeCallbackgetCullCallback () const
 
void addCullCallback (NodeCallback *nc)
 
void removeCullCallback (NodeCallback *nc)
 
void setCullingActive (bool active)
 
bool getCullingActive () const
 
unsigned int getNumChildrenWithCullingDisabled () const
 
bool isCullingActive () const
 
unsigned int getNumChildrenWithOccluderNodes () const
 
bool containsOccluderNodes () const
 
void setNodeMask (NodeMask nm)
 
NodeMask getNodeMask () const
 
void setStateSet (osg::StateSet *stateset)
 
osg::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () const
 
const std::string & getDescription (unsigned int i) const
 
std::string & getDescription (unsigned int i)
 
unsigned int getNumDescriptions () const
 
void addDescription (const std::string &desc)
 
void setInitialBound (const osg::BoundingSphere &bsphere)
 
const BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~Effect ()
 
Effectoperator= (const Effect &)
 
void dirtyTechniques ()
 
void addTechnique (Technique *tech)
 
virtual bool define_techniques ()=0
 
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
 
virtual void childRemoved (unsigned int, unsigned int)
 
virtual void childInserted (unsigned int)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *node)
 
void removeParent (osg::Group *node)
 
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
 
void setNumChildrenRequiringEventTraversal (unsigned int num)
 
void setNumChildrenWithCullingDisabled (unsigned int num)
 
void setNumChildrenWithOccluderNodes (unsigned int num)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Friends

class Validator
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- Protected Attributes inherited from osg::Group
NodeList _children
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< NodeCallback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< NodeCallback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< NodeCallback_cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet_stateset
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

The base class for special effects. An effect is basically a collection of state attributes and an interface for configuring them in a predefined fashion. The Effect class does more however, as it handles multipass rendering transparently and it allows more than one "technique" to be defined. Each technique tries to implement the effect in a different way, often using different OpenGL extensions. The active technique can be selected either manually, with selectTechnique(), or automatically, in which case the first technique that is supported by all active rendering contexts is chosen. If you are an Effect user, then simply use it as a node group. Create an instance of your desired effect, add it to your scene graph and call its addChild() method to add a child node as you would do with a Group. If you are an Effect developer, you will have to implement the method define_techniques() to define the different techniques that can be used for obtaining the desired effect. In define_techniques() you will usually create one or more instances of custom classes derived from Technique and you will add them to the effect with addTechnique(). The order is important: techniques added first will have higher priority and will be used first as soon as all rendering contexts support it.

Member Enumeration Documentation

§ TechniqueSelection

Enumerator
AUTO_DETECT 

Constructor & Destructor Documentation

§ Effect() [1/2]

osgFX::Effect::Effect ( )

§ Effect() [2/2]

osgFX::Effect::Effect ( const Effect copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

§ ~Effect()

virtual osgFX::Effect::~Effect ( )
protectedvirtual

Member Function Documentation

§ addTechnique()

void osgFX::Effect::addTechnique ( Technique tech)
inlineprotected

add a technique to the Effect

§ className()

virtual const char* osgFX::Effect::className ( ) const
inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

§ define_techniques()

virtual bool osgFX::Effect::define_techniques ( )
protectedpure virtual

abstract method to be implemented in derived classes; its purpose if to create the techniques that can be used for obtaining the desired effect. You will usually call addTechnique() inside this method.

Implemented in osgFX::BumpMapping, osgFX::AnisotropicLighting, osgFX::Outline, osgFX::SpecularHighlights, osgFX::Cartoon, and osgFX::Scribe.

§ dirtyTechniques()

void osgFX::Effect::dirtyTechniques ( )
inlineprotected

force rebuilding of techniques on next traversal

§ effectAuthor()

virtual const char* osgFX::Effect::effectAuthor ( ) const
pure virtual

get the effect author's name

§ effectDescription()

virtual const char* osgFX::Effect::effectDescription ( ) const
pure virtual

get a brief description of this Effect

§ effectName()

virtual const char* osgFX::Effect::effectName ( ) const
pure virtual

get the name of this Effect

§ getEnabled()

bool osgFX::Effect::getEnabled ( ) const
inline

get whether the effect is enabled or not

§ getNumTechniques()

int osgFX::Effect::getNumTechniques ( ) const
inline

get the number of techniques defined for this Effect

§ getSelectedTechnique()

int osgFX::Effect::getSelectedTechnique ( ) const
inline

get the index of the currently selected Technique

§ getTechnique() [1/2]

Technique * osgFX::Effect::getTechnique ( int  i)
inline

get the i-th Technique

§ getTechnique() [2/2]

const Technique * osgFX::Effect::getTechnique ( int  i) const
inline

get the i-th const Technique

§ inherited_traverse()

void osgFX::Effect::inherited_traverse ( osg::NodeVisitor nv)
inline

default traversal

§ isSameKindAs()

virtual bool osgFX::Effect::isSameKindAs ( const osg::Object obj) const
inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

§ libraryName()

virtual const char* osgFX::Effect::libraryName ( ) const
inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

§ operator=()

Effect& osgFX::Effect::operator= ( const Effect )
inlineprotected

§ selectTechnique()

void osgFX::Effect::selectTechnique ( int  i = AUTO_DETECT)
inline

select a technique or enable automatic detection

§ setEnabled()

void osgFX::Effect::setEnabled ( bool  v)
inline

set whether the effect is enabled or not

§ setUpDemo()

virtual void osgFX::Effect::setUpDemo ( )
inlinevirtual

optional: set effect parameters to produce a visually significant result to be used in demo applications like osgfxbrowser. Default is to do nothing.

Reimplemented in osgFX::BumpMapping.

§ traverse()

virtual void osgFX::Effect::traverse ( osg::NodeVisitor nv)
virtual

custom traversal

Reimplemented from osg::Group.

Friends And Related Function Documentation

§ Validator

friend class Validator
friend

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