Public Member Functions |
| Effect () |
| Effect (const Effect ©, const osg::CopyOp ©op=osg::CopyOp::SHALLOW_COPY) |
virtual bool | isSameKindAs (const osg::Object *obj) const |
| return true if this and obj are of the same kind of object.
|
virtual const char * | libraryName () const |
| return the name of the node's library.
|
virtual const char * | className () const |
| return the name of the node's class type.
|
virtual const char * | effectName () const =0 |
| get the name of this Effect
|
virtual const char * | effectDescription () const =0 |
| get a brief description of this Effect
|
virtual const char * | effectAuthor () const =0 |
| get the effect author's name
|
bool | getEnabled () const |
| get whether the effect is enabled or not
|
void | setEnabled (bool v) |
| set whether the effect is enabled or not
|
virtual void | setUpDemo () |
| optional: set effect parameters to produce a visually significant result to be used in demo applications like osgfxbrowser.
|
int | getNumTechniques () const |
| get the number of techniques defined for this Effect
|
Technique * | getTechnique (int i) |
| get the i-th Technique
|
const Technique * | getTechnique (int i) const |
| get the i-th const Technique
|
int | getSelectedTechnique () const |
| get the index of the currently selected Technique
|
void | selectTechnique (int i=AUTO_DETECT) |
| select a technique or enable automatic detection
|
virtual void | traverse (osg::NodeVisitor &nv) |
| custom traversal
|
void | inherited_traverse (osg::NodeVisitor &nv) |
| default traversal
|
| Group () |
| Group (const Group &, const CopyOp ©op=CopyOp::SHALLOW_COPY) |
| Copy constructor using CopyOp to manage deep vs shallow copy.
|
| META_Node (osg, Group) |
virtual Group * | asGroup () |
| convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
|
virtual const Group * | asGroup () const |
| convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
|
virtual bool | addChild (Node *child) |
| Add Node to Group.
|
virtual bool | insertChild (unsigned int index, Node *child) |
| Insert Node to Group at specific location.
|
bool | removeChild (Node *child) |
| Remove Node from Group.
|
bool | removeChild (unsigned int pos, unsigned int numChildrenToRemove=1) |
| Remove Node from Group.
|
virtual bool | removeChildren (unsigned int pos, unsigned int numChildrenToRemove) |
| Remove children from Group.
|
virtual bool | replaceChild (Node *origChild, Node *newChild) |
| Replace specified Node with another Node.
|
unsigned int | getNumChildren () const |
| Return the number of children nodes.
|
virtual bool | setChild (unsigned int i, Node *node) |
| Set child node at position i.
|
Node * | getChild (unsigned int i) |
| Return child node at position i.
|
const Node * | getChild (unsigned int i) const |
| Return child node at position i.
|
bool | containsNode (const Node *node) const |
| Return true if node is contained within Group.
|
unsigned int | getChildIndex (const Node *node) const |
| Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size().
|
virtual void | setThreadSafeRefUnref (bool threadSafe) |
| Set whether to use a mutex to ensure ref() and unref() are thread safe.
|
virtual void | resizeGLObjectBuffers (unsigned int maxSize) |
| Resize any per context GLObject buffers to specified size.
|
virtual void | releaseGLObjects (osg::State *=0) const |
| If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
|
virtual BoundingSphere | computeBound () const |
| Compute the bounding sphere around Node's geometry or children.
|
| Node () |
| Construct a node.
|
| Node (const Node &, const CopyOp ©op=CopyOp::SHALLOW_COPY) |
| Copy constructor using CopyOp to manage deep vs shallow copy.
|
virtual Object * | cloneType () const |
| clone an object of the same type as the node.
|
virtual Object * | clone (const CopyOp ©op) const |
| return a clone of a node, with Object* return type.
|
virtual Transform * | asTransform () |
| Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
|
virtual const Transform * | asTransform () const |
| convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
|
virtual Switch * | asSwitch () |
| Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
|
virtual const Switch * | asSwitch () const |
| convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
|
virtual Geode * | asGeode () |
| Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
|
virtual const Geode * | asGeode () const |
| convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
|
virtual osgTerrain::Terrain * | asTerrain () |
| Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
|
virtual const osgTerrain::Terrain * | asTerrain () const |
| convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
|
virtual void | accept (NodeVisitor &nv) |
| Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
|
virtual void | ascend (NodeVisitor &nv) |
| Traverse upwards : calls parents' accept method with NodeVisitor.
|
const ParentList & | getParents () const |
| Get the parent list of node.
|
ParentList | getParents () |
| Get the a copy of parent list of node.
|
Group * | getParent (unsigned int i) |
const Group * | getParent (unsigned int i) const |
| Get a single const parent of node.
|
unsigned int | getNumParents () const |
| Get the number of parents of node.
|
NodePathList | getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const |
| Get the list of node paths parent paths.
|
MatrixList | getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const |
| Get the list of matrices that transform this node from local coordinates to world coordinates.
|
void | setUpdateCallback (NodeCallback *nc) |
| Set update node callback, called during update traversal.
|
NodeCallback * | getUpdateCallback () |
| Get update node callback, called during update traversal.
|
const NodeCallback * | getUpdateCallback () const |
| Get const update node callback, called during update traversal.
|
void | addUpdateCallback (NodeCallback *nc) |
| Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
|
void | removeUpdateCallback (NodeCallback *nc) |
| Convenience method that removes a given callback from a node, even if that callback is nested.
|
unsigned int | getNumChildrenRequiringUpdateTraversal () const |
| Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
|
void | setEventCallback (NodeCallback *nc) |
| Set event node callback, called during event traversal.
|
NodeCallback * | getEventCallback () |
| Get event node callback, called during event traversal.
|
const NodeCallback * | getEventCallback () const |
| Get const event node callback, called during event traversal.
|
void | addEventCallback (NodeCallback *nc) |
| Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
|
void | removeEventCallback (NodeCallback *nc) |
| Convenience method that removes a given callback from a node, even if that callback is nested.
|
unsigned int | getNumChildrenRequiringEventTraversal () const |
| Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
|
void | setCullCallback (NodeCallback *nc) |
| Set cull node callback, called during cull traversal.
|
NodeCallback * | getCullCallback () |
| Get cull node callback, called during cull traversal.
|
const NodeCallback * | getCullCallback () const |
| Get const cull node callback, called during cull traversal.
|
void | addCullCallback (NodeCallback *nc) |
| Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
|
void | removeCullCallback (NodeCallback *nc) |
| Convenience method that removes a given callback from a node, even if that callback is nested.
|
void | setCullingActive (bool active) |
| Set the view frustum/small feature culling of this node to be active or inactive.
|
bool | getCullingActive () const |
| Get the view frustum/small feature _cullingActive flag for this node.
|
unsigned int | getNumChildrenWithCullingDisabled () const |
| Get the number of Children of this node which have culling disabled.
|
bool | isCullingActive () const |
| Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
|
unsigned int | getNumChildrenWithOccluderNodes () const |
| Get the number of Children of this node which are or have OccluderNode's.
|
bool | containsOccluderNodes () const |
| return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
|
void | setNodeMask (NodeMask nm) |
| Set the node mask.
|
NodeMask | getNodeMask () const |
| Get the node Mask.
|
void | setStateSet (osg::StateSet *stateset) |
| Set the node's StateSet.
|
osg::StateSet * | getOrCreateStateSet () |
| return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
|
osg::StateSet * | getStateSet () |
| Return the node's StateSet.
|
const osg::StateSet * | getStateSet () const |
| Return the node's const StateSet.
|
void | setDescriptions (const DescriptionList &descriptions) |
| Set the list of string descriptions.
|
DescriptionList & | getDescriptions () |
| Get the description list of the node.
|
const DescriptionList & | getDescriptions () const |
| Get the const description list of the const node.
|
const std::string & | getDescription (unsigned int i) const |
| Get a single const description of the const node.
|
std::string & | getDescription (unsigned int i) |
| Get a single description of the node.
|
unsigned int | getNumDescriptions () const |
| Get the number of descriptions of the node.
|
void | addDescription (const std::string &desc) |
| Add a description string to the node.
|
void | setInitialBound (const osg::BoundingSphere &bsphere) |
| Set the initial bounding volume to use when computing the overall bounding volume.
|
const BoundingSphere & | getInitialBound () const |
| Set the initial bounding volume to use when computing the overall bounding volume.
|
void | dirtyBound () |
| Mark this node's bounding sphere dirty.
|
const BoundingSphere & | getBound () const |
| Get the bounding sphere of node.
|
void | setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback) |
| Set the compute bound callback to override the default computeBound.
|
ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () |
| Get the compute bound callback.
|
const
ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () const |
| Get the const compute bound callback.
|
| Object () |
| Construct an object.
|
| Object (bool threadSafeRefUnref) |
| Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) |
| Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
|
virtual void | setName (const std::string &name) |
| Set the name of object using C++ style string.
|
void | setName (const char *name) |
| Set the name of object using a C style string.
|
const std::string & | getName () const |
| Get the name of object.
|
void | setDataVariance (DataVariance dv) |
| Set the data variance of this object.
|
DataVariance | getDataVariance () const |
| Get the data variance of this object.
|
virtual void | computeDataVariance () |
| Compute the DataVariance based on an assessment of callback etc.
|
void | setUserDataContainer (osg::UserDataContainer *udc) |
| set the UserDataContainer object.
|
osg::UserDataContainer * | getUserDataContainer () |
| get the UserDataContainer attached to this object.
|
const osg::UserDataContainer * | getUserDataContainer () const |
| get the const UserDataContainer attached to this object.
|
osg::UserDataContainer * | getOrCreateUserDataContainer () |
| Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
|
virtual void | setUserData (Referenced *obj) |
| Set user data, data must be subclassed from Referenced to allow automatic memory handling.
|
virtual Referenced * | getUserData () |
| Get user data.
|
virtual const Referenced * | getUserData () const |
| Get const user data.
|
template<typename T > |
bool | getUserValue (const std::string &name, T &value) const |
| Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
|
template<typename T > |
void | setUserValue (const std::string &name, const T &value) |
| Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
|
| Referenced () |
| Referenced (bool threadSafeRefUnref) |
| Referenced (const Referenced &) |
Referenced & | operator= (const Referenced &) |
bool | getThreadSafeRefUnref () const |
| Get whether a mutex is used to ensure ref() and unref() are thread safe.
|
OpenThreads::Mutex * | getRefMutex () const |
| Get the mutex used to ensure thread safety of ref()/unref().
|
int | ref () const |
| Increment the reference count by one, indicating that this object has another pointer which is referencing it.
|
int | unref () const |
| Decrement the reference count by one, indicating that a pointer to this object is referencing it.
|
int | unref_nodelete () const |
| Decrement the reference count by one, indicating that a pointer to this object is referencing it.
|
int | referenceCount () const |
| Return the number of pointers currently referencing this object.
|
ObserverSet * | getObserverSet () const |
| Get the ObserverSet if one is attached, otherwise return NULL.
|
ObserverSet * | getOrCreateObserverSet () const |
| Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
|
void | addObserver (Observer *observer) const |
| Add a Observer that is observing this object, notify the Observer when this object gets deleted.
|
void | removeObserver (Observer *observer) const |
| Remove Observer that is observing this object.
|
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.