class SG_EXPORT osg::Switch

Switch is a Group node which allows switching between children.

Inheritance:


Public Methods

[more] Switch()
[more] Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy
[more] META_Node(Switch)
[more]virtual void traverse(NodeVisitor& nv)
[more]inline void setValue(const int value)
Selects the active child Node or enables a special SwitchType mode.
[more]inline const int getValue() const
Returns the number of the active child Node or the SwitchType

Public Members

[more]enum SwitchType
Special mode values for the Switch.

Protected Fields

[more]int _value
The current Switch value.

Protected Methods

[more]virtual ~Switch()


Inherited from Group:

Public Methods

ovirtual bool addChild( Node* child )
ovirtual bool removeChild( Node* child )
ovirtual bool replaceChild( Node* origChild, Node* newChild )
oinline const int getNumChildren() const
oinline Node* getChild( const int i )
oinline const Node* getChild( const int i ) const
oinline bool containsNode( const Node* node ) const
oinline ChildList::iterator findNode( const Node* node )
oinline ChildList::const_iterator findNode( const Node* node ) const

Protected Fields

oChildList _children

Protected Methods

ovirtual const bool computeBound() const


Inherited from Node:

Public Methods

ovirtual Object* cloneType() const
ovirtual Object* clone(const CopyOp& copyop) const
ovirtual bool isSameKindAs(const Object* obj) const
ovirtual const char* className() const
ovirtual void accept(NodeVisitor& nv)
ovirtual void ascend(NodeVisitor& nv)
oinline void setName( const std::string& name )
oinline void setName( const char* name )
oinline const std::string& getName() const
oinline const ParentList& getParents() const
oinline ParentList getParents()
oinline Group* getParent(const int i)
oinline const Group* getParent(const int i) const
oinline const int getNumParents() const
ovoid setAppCallback(NodeCallback* nc)
oinline NodeCallback* getAppCallback()
oinline const NodeCallback* getAppCallback() const
oinline const int getNumChildrenRequiringAppTraversal() const
ovoid setCullingActive(const bool active)
oinline const bool getCullingActive() const
oinline const int getNumChildrenWithCullingDisabled() const
oinline void setUserData(osg::Referenced* obj)
oinline Referenced* getUserData()
oinline const Referenced* getUserData() const
oinline void setNodeMask(const NodeMask nm)
oinline const NodeMask getNodeMask() const
oinline const DescriptionList& getDescriptions() const
oinline DescriptionList& getDescriptions()
oinline const std::string& getDescription(const int i) const
oinline std::string& getDescription(const int i)
oinline const int getNumDescriptions() const
ovoid addDescription(const std::string& desc)
oinline void setStateSet(osg::StateSet* dstate)
oinline osg::StateSet* getStateSet()
oinline const osg::StateSet* getStateSet() const
oinline const BoundingSphere& getBound() const
ovoid dirtyBound()

Public Members

otypedef std::vector<Group*> ParentList
otypedef std::vector<std::string> DescriptionList

Protected Fields

omutable BoundingSphere _bsphere
omutable bool _bsphere_computed
ostd::string _name
oParentList _parents
oref_ptr<NodeCallback> _appCallback
oint _numChildrenRequiringAppTraversal
obool _cullingActive
oint _numChildrenWithCullingDisabled
oosg::ref_ptr<Referenced> _userData
oNodeMask _nodeMask
oDescriptionList _descriptions
oref_ptr<StateSet> _dstate

Protected Methods

ovoid addParent(osg::Group* node)
ovoid removeParent(osg::Group* node)
ovoid setNumChildrenRequiringAppTraversal(const int num)
ovoid setNumChildrenWithCullingDisabled(const int num)


Inherited from Object:


Inherited from Referenced:

Public Methods

oinline Referenced& operator = (Referenced&)
oinline void ref() const
oinline void unref() const
oinline const int referenceCount() const

Protected Fields

omutable int _refCount


Documentation

Switch is a Group node which allows switching between children. Typical uses would be for objects which might need to be rendered differently at different times, for instance a switch could be used to represent the different states of a traffic light.
oenum SwitchType
Special mode values for the Switch. Use these if you want to turn on/off all child nodes.

o ALL_CHILDREN_ON
Turn on all children.

o ALL_CHILDREN_OFF
Turn off all children.

o Switch()

o Switch(const Switch&, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
Copy constructor using CopyOp to manage deep vs shallow copy

o META_Node(Switch)

ovirtual void traverse(NodeVisitor& nv)

oinline void setValue(const int value)
Selects the active child Node or enables a special SwitchType mode.
Parameters:
value - the number of the active child (first child == number 0) or SwitchType. Invalid values will be ignored.

oinline const int getValue() const
Returns the number of the active child Node or the SwitchType

ovirtual ~Switch()

oint _value
The current Switch value.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.