OpenSceneGraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::ClusterCullingCallback Class Reference

Implements cluster culling to cull back facing subgraphs and drawables. More...

Inheritance diagram for osg::ClusterCullingCallback:
Inheritance graph
[legend]

Public Member Functions

 ClusterCullingCallback ()
 
 ClusterCullingCallback (const ClusterCullingCallback &ccc, const CopyOp &copyop)
 
 ClusterCullingCallback (const osg::Vec3 &controlPoint, const osg::Vec3 &normal, float deviation, float radius=-1.0f)
 
 ClusterCullingCallback (const osg::Drawable *drawable)
 
 META_Object (osg, ClusterCullingCallback)
 
virtual NodeCallbackasNodeCallback ()
 
virtual const NodeCallbackasNodeCallback () const
 
virtual DrawableCullCallbackasDrawableCullCallback ()
 
virtual const DrawableCullCallbackasDrawableCullCallback () const
 
virtual bool run (osg::Object *object, osg::Object *data)
 NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method. More...
 
void computeFrom (const osg::Drawable *drawable)
 Computes the control point, normal, and deviation from the given drawable contents. More...
 
void transform (const osg::Matrixd &matrix)
 Transform the ClusterCullingCallback's positional members to a new coordinate frame. More...
 
void set (const osg::Vec3 &controlPoint, const osg::Vec3 &normal, float deviation, float radius)
 
void setControlPoint (const osg::Vec3 &controlPoint)
 
const osg::Vec3getControlPoint () const
 
void setNormal (const osg::Vec3 &normal)
 
const osg::Vec3getNormal () const
 
void setRadius (float radius)
 
float getRadius () const
 
void setDeviation (float deviation)
 
float getDeviation () const
 
virtual bool cull (osg::NodeVisitor *, osg::Drawable *, osg::State *) const
 deprecated. More...
 
virtual void operator() (Node *node, NodeVisitor *nv)
 Callback method called by the NodeVisitor when visiting a node. More...
 
- Public Member Functions inherited from osg::DrawableCullCallback
 DrawableCullCallback ()
 
 DrawableCullCallback (const DrawableCullCallback &org, const CopyOp &copyop)
 
 META_Object (osg, DrawableCullCallback)
 
virtual bool cull (osg::NodeVisitor *nv, osg::Drawable *drawable, osg::RenderInfo *renderInfo) const
 do customized cull code, return true if drawable should be culled. More...
 
- Public Member Functions inherited from osg::Callback
 Callback ()
 
 Callback (const Callback &cb, const CopyOp &copyop)
 
 META_Object (osg, Callback)
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual StateAttributeCallbackasStateAttributeCallback ()
 
virtual const StateAttributeCallbackasStateAttributeCallback () const
 
virtual UniformCallbackasUniformCallback ()
 
virtual const UniformCallbackasUniformCallback () const
 
virtual DrawableUpdateCallbackasDrawableUpdateCallback ()
 
virtual const DrawableUpdateCallbackasDrawableUpdateCallback () const
 
virtual DrawableEventCallbackasDrawableEventCallback ()
 
virtual const DrawableEventCallbackasDrawableEventCallback () const
 
virtual osgGA::EventHandlerasEventHandler ()
 
virtual const osgGA::EventHandlerasEventHandler () const
 
bool traverse (osg::Object *object, osg::Object *data)
 traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node, and data is NodeVisitor. More...
 
void setNestedCallback (osg::Callback *cb)
 
osg::CallbackgetNestedCallback ()
 
const osg::CallbackgetNestedCallback () const
 
void addNestedCallback (osg::Callback *nc)
 
void removeNestedCallback (osg::Callback *nc)
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 
- Public Member Functions inherited from osg::NodeCallback
 NodeCallback ()
 
 NodeCallback (const NodeCallback &nc, const CopyOp &copyop)
 
 META_Object (osg, NodeCallback)
 

Protected Member Functions

virtual ~ClusterCullingCallback ()
 
- Protected Member Functions inherited from osg::Callback
virtual ~Callback ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from osg::NodeCallback
virtual ~NodeCallback ()
 

Protected Attributes

osg::Vec3 _controlPoint
 
osg::Vec3 _normal
 
float _radius
 
float _deviation
 
- Protected Attributes inherited from osg::Callback
ref_ptr< Callback_nestedCallback
 
- 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::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- Static Public Member Functions inherited from osg::Callback
template<typename T >
static T * findNestedCallback (osg::Callback *callback)
 Convenience method to find a nested callback by type. More...
 
template<typename T >
static const T * findNestedCallback (const osg::Callback *callback)
 Convenience method to find a nested callback by type. More...
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

Implements cluster culling to cull back facing subgraphs and drawables.

Derived from Drawable::CullCallback and osg::NodeCallback.

This culling callback is intended to be attached to a node using the setCullCallback method. If the node is a drawable cull(osg::NodeVisitor*, osg::Drawable*, osg::State*) otherwise operator()(Node*, NodeVisitor*) will be called during the cull traversal.

To decide whether the node (in case of a drawable) or its children (in case of any other node type) are to be culled depends on four parameters:

The node is culled if the following two conditions are fulfilled:

Remarks
As the deviation is representing the cosine of an enclosed angle its value should be within the the interval [-1; 1]. A value of one will cull all nodes while a value of -1 will never cull a node. The deviation will normally have negative values because then the enclosed angle between the normal and the eye/view point is larger than 90 degrees (and therefore the eye sees the "back" from the control point).

Constructor & Destructor Documentation

◆ ClusterCullingCallback() [1/4]

osg::ClusterCullingCallback::ClusterCullingCallback ( )

◆ ClusterCullingCallback() [2/4]

osg::ClusterCullingCallback::ClusterCullingCallback ( const ClusterCullingCallback ccc,
const CopyOp copyop 
)

◆ ClusterCullingCallback() [3/4]

osg::ClusterCullingCallback::ClusterCullingCallback ( const osg::Vec3 controlPoint,
const osg::Vec3 normal,
float  deviation,
float  radius = -1.0f 
)

◆ ClusterCullingCallback() [4/4]

osg::ClusterCullingCallback::ClusterCullingCallback ( const osg::Drawable drawable)

◆ ~ClusterCullingCallback()

virtual osg::ClusterCullingCallback::~ClusterCullingCallback ( )
inlineprotectedvirtual

Member Function Documentation

◆ asDrawableCullCallback() [1/2]

virtual DrawableCullCallback* osg::ClusterCullingCallback::asDrawableCullCallback ( )
inlinevirtual

◆ asDrawableCullCallback() [2/2]

virtual const DrawableCullCallback* osg::ClusterCullingCallback::asDrawableCullCallback ( ) const
inlinevirtual

◆ asNodeCallback() [1/2]

virtual NodeCallback* osg::ClusterCullingCallback::asNodeCallback ( )
inlinevirtual

Reimplemented from osg::NodeCallback.

References osg::NodeCallback::asNodeCallback().

◆ asNodeCallback() [2/2]

virtual const NodeCallback* osg::ClusterCullingCallback::asNodeCallback ( ) const
inlinevirtual

Reimplemented from osg::NodeCallback.

References osg::NodeCallback::asNodeCallback().

◆ computeFrom()

void osg::ClusterCullingCallback::computeFrom ( const osg::Drawable drawable)

Computes the control point, normal, and deviation from the given drawable contents.

◆ cull()

virtual bool osg::ClusterCullingCallback::cull ( osg::NodeVisitor ,
osg::Drawable ,
osg::State  
) const
virtual

deprecated.

Reimplemented from osg::DrawableCullCallback.

◆ getControlPoint()

const osg::Vec3& osg::ClusterCullingCallback::getControlPoint ( ) const
inline

◆ getDeviation()

float osg::ClusterCullingCallback::getDeviation ( ) const
inline

◆ getNormal()

const osg::Vec3& osg::ClusterCullingCallback::getNormal ( ) const
inline

◆ getRadius()

float osg::ClusterCullingCallback::getRadius ( ) const
inline

◆ META_Object()

osg::ClusterCullingCallback::META_Object ( osg  ,
ClusterCullingCallback   
)

◆ operator()()

virtual void osg::ClusterCullingCallback::operator() ( Node node,
NodeVisitor nv 
)
virtual

Callback method called by the NodeVisitor when visiting a node.

Reimplemented from osg::NodeCallback.

◆ run()

virtual bool osg::ClusterCullingCallback::run ( osg::Object object,
osg::Object data 
)
inlinevirtual

NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(Node* node, NodeVisitor* nv) method.

Reimplemented from osg::NodeCallback.

References osg::NodeCallback::run().

◆ set()

void osg::ClusterCullingCallback::set ( const osg::Vec3 controlPoint,
const osg::Vec3 normal,
float  deviation,
float  radius 
)

◆ setControlPoint()

void osg::ClusterCullingCallback::setControlPoint ( const osg::Vec3 controlPoint)
inline

◆ setDeviation()

void osg::ClusterCullingCallback::setDeviation ( float  deviation)
inline

◆ setNormal()

void osg::ClusterCullingCallback::setNormal ( const osg::Vec3 normal)
inline

◆ setRadius()

void osg::ClusterCullingCallback::setRadius ( float  radius)
inline

◆ transform()

void osg::ClusterCullingCallback::transform ( const osg::Matrixd matrix)

Transform the ClusterCullingCallback's positional members to a new coordinate frame.

Member Data Documentation

◆ _controlPoint

osg::Vec3 osg::ClusterCullingCallback::_controlPoint
protected

◆ _deviation

float osg::ClusterCullingCallback::_deviation
protected

◆ _normal

osg::Vec3 osg::ClusterCullingCallback::_normal
protected

◆ _radius

float osg::ClusterCullingCallback::_radius
protected

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