class SG_EXPORT osg::ClipNode

Node for defining the position of ClipPlanes in the scene

Inheritance:


Public Methods

[more] ClipNode()
[more] ClipNode(const ClipNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY)
[more] META_Node(osg, ClipNode)
[more]void createClipBox(const BoundingBox& bb, unsigned int clipPlaneNumberBase=0)
Create a 6 clip planes to create a clip box
[more]bool addClipPlane(ClipPlane* clipplane)
Add a ClipPlane to a ClipNode.
[more]bool removeClipPlane(ClipPlane* clipplane)
Remove ClipPlane from a ClipNode.
[more]bool removeClipPlane(unsigned int pos)
Remove ClipPlane, at specified index, from a ClipNode.
[more]inline unsigned int getNumClipPlanes() const
return the number of ClipPlanes
[more]inline ClipPlane* getClipPlane(unsigned int pos)
Get ClipPlane at specificed index position
[more]inline const ClipPlane* getClipPlane(unsigned int pos) const
Get const ClipPlane at specificed index position
[more]inline ClipPlaneList& getClipPlaneList()
Get the ClipPlaneList
[more]inline const ClipPlaneList& getClipPlaneList() const
Get the const ClipPlaneList
[more]void setStateSetModes(StateSet&, StateAttribute::GLModeValue) const
Set the GLModes on StateSet associated with the ClipPlanes
[more]void setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON)
Set up the local StateSet

Public

[more]typedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList

Protected Fields

[more]StateAttribute::GLModeValue _value
[more]ClipPlaneList _planes

Protected Methods

[more]virtual ~ClipNode()
[more]virtual bool computeBound() const


Inherited from Group:

Public Methods

ovirtual Group* asGroup()
ovirtual const Group* asGroup() const
ovirtual void traverse(NodeVisitor& nv)
ovirtual bool addChild( Node* child )
ovirtual bool insertChild( unsigned int index, Node* child )
ovirtual bool removeChild( Node* child )
ovirtual bool removeChild(unsigned int pos, unsigned int numChildrenToRemove=1)
ovirtual bool replaceChild( Node* origChild, Node* newChild )
oinline unsigned int getNumChildren() const
ovirtual bool setChild( unsigned int i, Node* node )
oinline Node* getChild( unsigned int i )
oinline const Node* getChild( unsigned int i ) const
oinline bool containsNode( const Node* node ) const
oinline unsigned int getChildIndex( const Node* node ) const

Protected Fields

oNodeList _children

Protected Methods

ovirtual void childRemoved(unsigned int , unsigned int )
ovirtual void childInserted(unsigned int )


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* libraryName() const
ovirtual const char* className() const
ovirtual Transform* asTransform()
ovirtual const Transform* asTransform() 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(unsigned int i)
oinline const Group* getParent(unsigned int i) const
oinline unsigned int getNumParents() const
ovoid setUpdateCallback(NodeCallback* nc)
oinline NodeCallback* getUpdateCallback()
oinline const NodeCallback* getUpdateCallback() const
oinline unsigned int getNumChildrenRequiringUpdateTraversal() const
ovoid setCullCallback(NodeCallback* nc)
oinline NodeCallback* getCullCallback()
oinline const NodeCallback* getCullCallback() const
ovoid setCullingActive(bool active)
oinline bool getCullingActive() const
oinline unsigned int getNumChildrenWithCullingDisabled() const
oinline bool isCullingActive() const
oinline unsigned int getNumChildrenWithOccluderNodes() const
obool containsOccluderNodes() const
oinline void setNodeMask(NodeMask nm)
oinline NodeMask getNodeMask() const
oinline const DescriptionList& getDescriptions() const
oinline DescriptionList& getDescriptions()
oinline const std::string& getDescription(unsigned int i) const
oinline std::string& getDescription(unsigned int i)
oinline unsigned int getNumDescriptions() const
ovoid addDescription(const std::string& desc)
oinline void setStateSet(osg::StateSet* dstate)
oosg::StateSet* getOrCreateStateSet()
oinline osg::StateSet* getStateSet()
oinline const osg::StateSet* getStateSet() const
oinline const BoundingSphere& getBound() const
ovoid dirtyBound()

Public

otypedef std::vector<Group*> ParentList
otypedef unsigned int NodeMask
otypedef std::vector<std::string> DescriptionList

Protected Fields

omutable BoundingSphere _bsphere
omutable bool _bsphere_computed
ostd::string _name
oParentList _parents
oref_ptr<NodeCallback> _updateCallback
ounsigned int _numChildrenRequiringUpdateTraversal
oref_ptr<NodeCallback> _cullCallback
obool _cullingActive
ounsigned int _numChildrenWithCullingDisabled
ounsigned int _numChildrenWithOccluderNodes
oNodeMask _nodeMask
oDescriptionList _descriptions
oref_ptr<StateSet> _stateset

Protected Methods

ovoid addParent(osg::Group* node)
ovoid removeParent(osg::Group* node)
ovoid setNumChildrenRequiringUpdateTraversal(unsigned int num)
ovoid setNumChildrenWithCullingDisabled(unsigned int num)
ovoid setNumChildrenWithOccluderNodes(unsigned int num)


Inherited from Object:

Public Classes

oenum DataVariance

Public Methods

oinline void setDataVariance(DataVariance dv)
oinline DataVariance getDataVariance() const
oinline void setUserData(Referenced* obj)
oinline Referenced* getUserData()
oinline const Referenced* getUserData() const

Protected Fields

oDataVariance _dataVariance
oref_ptr<Referenced> _userData


Inherited from Referenced:

Public Methods

oinline Referenced& operator = (const Referenced&)
ostatic void setDeleteHandler(DeleteHandler* handler)
ostatic DeleteHandler* getDeleteHandler()
oinline void ref() const
oinline void unref_nodelete() const
oinline int referenceCount() const
oinline void unref() const

Protected Fields

omutable OpenThreads::Mutex _refMutex
omutable int _refCount


Documentation

Node for defining the position of ClipPlanes in the scene
otypedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList

o ClipNode()

o ClipNode(const ClipNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY)

o META_Node(osg, ClipNode)

ovoid createClipBox(const BoundingBox& bb, unsigned int clipPlaneNumberBase=0)
Create a 6 clip planes to create a clip box

obool addClipPlane(ClipPlane* clipplane)
Add a ClipPlane to a ClipNode. Return true if plane is added, return false if plane already exists in ClipNode, or clipplane is false.

obool removeClipPlane(ClipPlane* clipplane)
Remove ClipPlane from a ClipNode. Return true if plane is removed, return false if plane does not exists in ClipNode.

obool removeClipPlane(unsigned int pos)
Remove ClipPlane, at specified index, from a ClipNode. Return true if plane is removed, return false if plane does not exists in ClipNode.

oinline unsigned int getNumClipPlanes() const
return the number of ClipPlanes

oinline ClipPlane* getClipPlane(unsigned int pos)
Get ClipPlane at specificed index position

oinline const ClipPlane* getClipPlane(unsigned int pos) const
Get const ClipPlane at specificed index position

oinline ClipPlaneList& getClipPlaneList()
Get the ClipPlaneList

oinline const ClipPlaneList& getClipPlaneList() const
Get the const ClipPlaneList

ovoid setStateSetModes(StateSet&, StateAttribute::GLModeValue) const
Set the GLModes on StateSet associated with the ClipPlanes

ovoid setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON)
Set up the local StateSet

ovirtual ~ClipNode()

ovirtual bool computeBound() const

oStateAttribute::GLModeValue _value

oClipPlaneList _planes


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



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