openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::ClipNode Class Reference
Inheritance diagram for osg::ClipNode:
osg::Group osg::Node osg::Object osg::Referenced

Public Types

enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
typedef std::vector< ref_ptr
< ClipPlane > > 
ClipPlaneList

Public Member Functions

 ClipNode ()
 ClipNode (const ClipNode &es, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, ClipNode)
void setReferenceFrame (ReferenceFrame rf)
ReferenceFrame getReferenceFrame () const
void createClipBox (const BoundingBox &bb, unsigned int clipPlaneNumberBase=0)
bool addClipPlane (ClipPlane *clipplane)
bool removeClipPlane (ClipPlane *clipplane)
bool removeClipPlane (unsigned int pos)
unsigned int getNumClipPlanes () const
ClipPlanegetClipPlane (unsigned int pos)
const ClipPlanegetClipPlane (unsigned int pos) const
void setClipPlaneList (const ClipPlaneList &cpl)
ClipPlaneListgetClipPlaneList ()
const ClipPlaneListgetClipPlaneList () const
void setStateSetModes (StateSet &, StateAttribute::GLModeValue) const
void setLocalStateSetModes (StateAttribute::GLModeValue=StateAttribute::ON)
virtual BoundingSphere computeBound () const
- 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 void traverse (NodeVisitor &nv)
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
- 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 bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual TransformasTransform ()
virtual const TransformasTransform () 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
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () 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)
- 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 ~ClipNode ()
- 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

Protected Attributes

StateAttribute::GLModeValue _value
ClipPlaneList _planes
ReferenceFrame _referenceFrame
- 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

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 ()

Detailed Description

Node for defining the position of ClipPlanes in the scene.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
RELATIVE_RF 
ABSOLUTE_RF 

Constructor & Destructor Documentation

osg::ClipNode::ClipNode ( )
osg::ClipNode::ClipNode ( const ClipNode es,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
virtual osg::ClipNode::~ClipNode ( )
protectedvirtual

Member Function Documentation

bool osg::ClipNode::addClipPlane ( ClipPlane clipplane)

Adds the clipplane. Returns true on success, and false if the plane has already been added, or if clipplane is NULL.

virtual BoundingSphere osg::ClipNode::computeBound ( ) const
virtual

Compute the bounding sphere around Node's geometry or children. This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

void osg::ClipNode::createClipBox ( const BoundingBox bb,
unsigned int  clipPlaneNumberBase = 0 
)

Creates six clip planes corresponding to the given BoundingBox.

ClipPlane* osg::ClipNode::getClipPlane ( unsigned int  pos)
inline

Get ClipPlane at the given index position.

const ClipPlane* osg::ClipNode::getClipPlane ( unsigned int  pos) const
inline

Get const ClipPlane at the given index position.

ClipPlaneList& osg::ClipNode::getClipPlaneList ( )
inline

Get the ClipPlaneList.

const ClipPlaneList& osg::ClipNode::getClipPlaneList ( ) const
inline

Get the const ClipPlaneList.

unsigned int osg::ClipNode::getNumClipPlanes ( ) const
inline

Returns the number of ClipPlanes.

ReferenceFrame osg::ClipNode::getReferenceFrame ( ) const
inline
osg::ClipNode::META_Node ( osg  ,
ClipNode   
)
bool osg::ClipNode::removeClipPlane ( ClipPlane clipplane)

Removes the clipplane. Returns true on success, false if clipplane isn't in this ClipNode.

bool osg::ClipNode::removeClipPlane ( unsigned int  pos)

Remove the ClipPlane with the given index. Returns true on success, false if pos is not a valid plane index.

void osg::ClipNode::setClipPlaneList ( const ClipPlaneList cpl)
inline

Set the ClipPlaneList.

void osg::ClipNode::setLocalStateSetModes ( StateAttribute::GLModeValue  = StateAttribute::ON)

Set up the local StateSet.

void osg::ClipNode::setReferenceFrame ( ReferenceFrame  rf)

Set the light sources's ReferenceFrame, either to be relative to its parent reference frame, or relative to an absolute coordinate frame. RELATIVE_RF is the default. Note: setting the ReferenceFrame to be ABSOLUTE_RF will also set the CullingActive flag on the light source, and hence all of its parents, to false, thereby disabling culling of it and all its parents. This is necessary to prevent inappropriate culling, but may impact cull times if the absolute light source is deep in the scene graph. It is therefore recommended to only use absolute light source at the top of the scene.

void osg::ClipNode::setStateSetModes ( StateSet ,
StateAttribute::GLModeValue   
) const

Set the GLModes for all ClipPlanes, on the StateSet.

Member Data Documentation

ClipPlaneList osg::ClipNode::_planes
protected
ReferenceFrame osg::ClipNode::_referenceFrame
protected
StateAttribute::GLModeValue osg::ClipNode::_value
protected

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