OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::ClearNode Class Reference

#include <ClearNode.h>

Inheritance diagram for osg::ClearNode:
Inheritance graph
[legend]
Collaboration diagram for osg::ClearNode:
Collaboration graph
[legend]

Public Member Functions

 ClearNode ()
 
 ClearNode (const ClearNode &cs, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, ClearNode)
 
void setRequiresClear (bool requiresClear)
 
bool getRequiresClear () const
 
void setClearColor (const Vec4 &color)
 
const Vec4 & getClearColor () const
 
void setClearMask (GLbitfield mask)
 
GLbitfield getClearMask () const
 
- Public Member Functions inherited from osg::Group
 Group ()
 
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_Node (osg, Group)
 
virtual Group * asGroup ()
 
virtual const Group * asGroup () const
 
virtual void traverse (NodeVisitor &nv)
 
virtual bool addChild (Node *child)
 
virtual bool insertChild (unsigned int index, Node *child)
 
virtual 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)
 
virtual unsigned int getNumChildren () const
 
virtual bool setChild (unsigned int i, Node *node)
 
Node * getChild (unsigned int i)
 
const Node * getChild (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 Object * cloneType () const
 
virtual Object * clone (const CopyOp &copyop) const
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual Drawable * asDrawable ()
 
virtual const Drawable * asDrawable () const
 
virtual Geometry * asGeometry ()
 
virtual const Geometry * asGeometry () const
 
virtual Transform * asTransform ()
 
virtual const Transform * asTransform () const
 
virtual Camera * asCamera ()
 
virtual const Camera * asCamera () const
 
virtual Switch * asSwitch ()
 
virtual const Switch * asSwitch () const
 
virtual Geode * asGeode ()
 
virtual const Geode * asGeode () const
 
virtual osgTerrain::Terrain * asTerrain ()
 
virtual const osgTerrain::Terrain * asTerrain () const
 
virtual void accept (NodeVisitor &nv)
 
virtual void ascend (NodeVisitor &nv)
 
const ParentList & getParents () const
 
ParentList getParents ()
 
Group * getParent (unsigned int i)
 
const Group * getParent (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 (Callback *nc)
 
Callback * getUpdateCallback ()
 
const Callback * getUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
void removeUpdateCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
Callback * getEventCallback ()
 
const Callback * getEventCallback () const
 
void addEventCallback (Callback *nc)
 
void removeEventCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
Callback * getCullCallback ()
 
const Callback * getCullCallback () const
 
void addCullCallback (Callback *nc)
 
void removeCullCallback (Callback *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::StateSet * getOrCreateStateSet ()
 
osg::StateSet * getStateSet ()
 
const osg::StateSet * getStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionList & getDescriptions ()
 
const DescriptionList & getDescriptions () 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 BoundingSphere & getInitialBound () const
 
void dirtyBound ()
 
const BoundingSphere & getBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
ComputeBoundingSphereCallback * getComputeBoundingSphereCallback ()
 
const
ComputeBoundingSphereCallback * 		getComputeBoundingSphereCallback () const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
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::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () 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
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~ClearNode ()
 
- 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 *parent)
 
void removeParent (osg::Group *parent)
 
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

bool _requiresClear
 
Vec4 _clearColor
 
GLbitfield _clearMask
 
- 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< Callback > _updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback > _eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback > _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

- 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 }
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Detailed Description

A Group node for clearing the color and depth buffers. Use setClearColor to change the clear color, and setRequiresClear to disable/enable the call clearing. You might want to disable clearing if you perform your clear by drawing fullscreen geometry. If you do this, add child nodes to perform such drawing. The default StateSet associated with this node places children in render bin -1 to ensure that children are rendered prior to the rest of the scene graph.

Definition at line 30 of file ClearNode.h.

Constructor & Destructor Documentation

osg::ClearNode::ClearNode ( )
osg::ClearNode::ClearNode ( const ClearNode &  cs,
const CopyOp &  copyop = CopyOp::SHALLOW_COPY 
)
inline

Definition at line 36 of file ClearNode.h.

virtual osg::ClearNode::~ClearNode ( )
inlineprotectedvirtual

Definition at line 66 of file ClearNode.h.

Member Function Documentation

const Vec4& osg::ClearNode::getClearColor ( ) const
inline

Returns the clear color.

Definition at line 55 of file ClearNode.h.

GLbitfield osg::ClearNode::getClearMask ( ) const
inline

Get the clear mask.

Definition at line 62 of file ClearNode.h.

bool osg::ClearNode::getRequiresClear ( ) const
inline

Gets whether clearing is enabled or disabled.

Definition at line 49 of file ClearNode.h.

osg::ClearNode::META_Node ( osg  ,
ClearNode   
)
void osg::ClearNode::setClearColor ( const Vec4 &  color)
inline

Sets the clear color.

Definition at line 52 of file ClearNode.h.

void osg::ClearNode::setClearMask ( GLbitfield  mask)
inline

Set the clear mask used in glClear(..). Defaults to GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT.

Definition at line 59 of file ClearNode.h.

void osg::ClearNode::setRequiresClear ( bool  requiresClear)
inline

Enable/disable clearing via glClear.

Definition at line 46 of file ClearNode.h.

Member Data Documentation

Vec4 osg::ClearNode::_clearColor
protected

Definition at line 69 of file ClearNode.h.

GLbitfield osg::ClearNode::_clearMask
protected

Definition at line 70 of file ClearNode.h.

bool osg::ClearNode::_requiresClear
protected

Definition at line 68 of file ClearNode.h.

The documentation for this class was generated from the following file:
Generated on Tue Oct 4 2016 19:20:49 for OSG by   doxygen 1.8.8