OpenSceneGraph 3.6.5
osg::CullingSet Class Reference

A CullingSet class which contains a frustum and a list of occluders. More...

#include <CullingSet>

Inheritance diagram for osg::CullingSet:

Public Types

enum  MaskValues {
  NO_CULLING = 0x0 , VIEW_FRUSTUM_SIDES_CULLING = 0x1 , NEAR_PLANE_CULLING = 0x2 , FAR_PLANE_CULLING = 0x4 ,
  VIEW_FRUSTUM_CULLING , SMALL_FEATURE_CULLING = 0x8 , SHADOW_OCCLUSION_CULLING = 0x10 , DEFAULT_CULLING ,
  ENABLE_ALL_CULLING
}
typedef std::pair< osg::ref_ptr< osg::StateSet >, osg::PolytopeStateFrustumPair
typedef std::vector< StateFrustumPairStateFrustumList
typedef std::vector< ShadowVolumeOccluderOccluderList
typedef int Mask

Public Member Functions

 CullingSet ()
 CullingSet (const CullingSet &cs)
 CullingSet (const CullingSet &cs, const Matrix &matrix, const Vec4 &pixelSizeVector)
CullingSetoperator= (const CullingSet &cs)
void set (const CullingSet &cs)
void set (const CullingSet &cs, const Matrix &matrix, const Vec4 &pixelSizeVector)
void setCullingMask (Mask mask)
Mask getCullingMask () const
void setFrustum (Polytope &cv)
PolytopegetFrustum ()
const PolytopegetFrustum () const
void addStateFrustum (StateSet *stateset, Polytope &polytope)
void getStateFrustumList (StateFrustumList &sfl)
StateFrustumListgetStateFrustumList ()
void addOccluder (ShadowVolumeOccluder &cv)
void setPixelSizeVector (const Vec4 &v)
Vec4getPixelSizeVector ()
const Vec4getPixelSizeVector () const
void setSmallFeatureCullingPixelSize (float value)
 Threshold at which small features are culled.
float & getSmallFeatureCullingPixelSize ()
float getSmallFeatureCullingPixelSize () const
float pixelSize (const Vec3 &v, float radius) const
 Compute the pixel of an object at position v, with specified radius.
float pixelSize (const BoundingSphere &bs) const
 Compute the pixel of a bounding sphere.
float clampedPixelSize (const Vec3 &v, float radius) const
 Compute the pixel of an object at position v, with specified radius.
float clampedPixelSize (const BoundingSphere &bs) const
 Compute the pixel of a bounding sphere.
bool isCulled (const std::vector< Vec3 > &vertices)
bool isCulled (const BoundingBox &bb)
bool isCulled (const BoundingSphere &bs)
void pushCurrentMask ()
void popCurrentMask ()
void resetCullingMask ()
void disableAndPushOccludersCurrentMask (NodePath &nodePath)
void popOccludersCurrentMask (NodePath &nodePath)
virtual ~CullingSet ()
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.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static osg::Vec4 computePixelSizeVector (const Viewport &W, const Matrix &P, const Matrix &M)
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Protected Attributes

Mask _mask
Polytope _frustum
StateFrustumList _stateFrustumList
OccluderList _occluderList
Vec4 _pixelSizeVector
float _smallFeatureCullingPixelSize
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Detailed Description

A CullingSet class which contains a frustum and a list of occluders.

Member Typedef Documentation

◆ Mask

typedef int osg::CullingSet::Mask

◆ OccluderList

◆ StateFrustumList

◆ StateFrustumPair

Member Enumeration Documentation

◆ MaskValues

Enumerator
NO_CULLING 
VIEW_FRUSTUM_SIDES_CULLING 
NEAR_PLANE_CULLING 
FAR_PLANE_CULLING 
VIEW_FRUSTUM_CULLING 
SMALL_FEATURE_CULLING 
SHADOW_OCCLUSION_CULLING 
DEFAULT_CULLING 
ENABLE_ALL_CULLING 

Constructor & Destructor Documentation

◆ CullingSet() [1/3]

osg::CullingSet::CullingSet ( )

◆ CullingSet() [2/3]

◆ CullingSet() [3/3]

osg::CullingSet::CullingSet ( const CullingSet & cs,
const Matrix & matrix,
const Vec4 & pixelSizeVector )
inline

◆ ~CullingSet()

virtual osg::CullingSet::~CullingSet ( )
virtual

Member Function Documentation

◆ addOccluder()

void osg::CullingSet::addOccluder ( ShadowVolumeOccluder & cv)
inline

References _occluderList.

◆ addStateFrustum()

void osg::CullingSet::addStateFrustum ( StateSet * stateset,
Polytope & polytope )
inline

References _stateFrustumList.

◆ clampedPixelSize() [1/2]

float osg::CullingSet::clampedPixelSize ( const BoundingSphere & bs) const
inline

Compute the pixel of a bounding sphere.

fabs()ed to always be positive.

References pixelSize().

◆ clampedPixelSize() [2/2]

float osg::CullingSet::clampedPixelSize ( const Vec3 & v,
float radius ) const
inline

Compute the pixel of an object at position v, with specified radius.

fabs()ed to always be positive.

References pixelSize().

◆ computePixelSizeVector()

osg::Vec4 osg::CullingSet::computePixelSizeVector ( const Viewport & W,
const Matrix & P,
const Matrix & M )
static

◆ disableAndPushOccludersCurrentMask()

void osg::CullingSet::disableAndPushOccludersCurrentMask ( NodePath & nodePath)

◆ getCullingMask()

Mask osg::CullingSet::getCullingMask ( ) const
inline

References _mask.

◆ getFrustum() [1/2]

Polytope & osg::CullingSet::getFrustum ( )
inline

References _frustum.

◆ getFrustum() [2/2]

const Polytope & osg::CullingSet::getFrustum ( ) const
inline

References _frustum.

◆ getPixelSizeVector() [1/2]

Vec4 & osg::CullingSet::getPixelSizeVector ( )
inline

References _pixelSizeVector.

◆ getPixelSizeVector() [2/2]

const Vec4 & osg::CullingSet::getPixelSizeVector ( ) const
inline

References _pixelSizeVector.

◆ getSmallFeatureCullingPixelSize() [1/2]

float & osg::CullingSet::getSmallFeatureCullingPixelSize ( )
inline

◆ getSmallFeatureCullingPixelSize() [2/2]

float osg::CullingSet::getSmallFeatureCullingPixelSize ( ) const
inline

◆ getStateFrustumList() [1/2]

StateFrustumList & osg::CullingSet::getStateFrustumList ( )
inline

References _stateFrustumList.

◆ getStateFrustumList() [2/2]

void osg::CullingSet::getStateFrustumList ( StateFrustumList & sfl)
inline

References _stateFrustumList.

◆ isCulled() [1/3]

bool osg::CullingSet::isCulled ( const BoundingBox & bb)
inline

◆ isCulled() [2/3]

◆ isCulled() [3/3]

bool osg::CullingSet::isCulled ( const std::vector< Vec3 > & vertices)
inline

◆ operator=()

CullingSet & osg::CullingSet::operator= ( const CullingSet & cs)
inline

◆ pixelSize() [1/2]

float osg::CullingSet::pixelSize ( const BoundingSphere & bs) const
inline

◆ pixelSize() [2/2]

float osg::CullingSet::pixelSize ( const Vec3 & v,
float radius ) const
inline

Compute the pixel of an object at position v, with specified radius.

References _pixelSizeVector.

Referenced by clampedPixelSize(), and clampedPixelSize().

◆ popCurrentMask()

void osg::CullingSet::popCurrentMask ( )
inline

◆ popOccludersCurrentMask()

void osg::CullingSet::popOccludersCurrentMask ( NodePath & nodePath)

◆ pushCurrentMask()

void osg::CullingSet::pushCurrentMask ( )
inline

◆ resetCullingMask()

void osg::CullingSet::resetCullingMask ( )
inline

References _frustum.

◆ set() [1/2]

void osg::CullingSet::set ( const CullingSet & cs)
inline

◆ set() [2/2]

void osg::CullingSet::set ( const CullingSet & cs,
const Matrix & matrix,
const Vec4 & pixelSizeVector )
inline

◆ setCullingMask()

void osg::CullingSet::setCullingMask ( Mask mask)
inline

References _mask.

◆ setFrustum()

void osg::CullingSet::setFrustum ( Polytope & cv)
inline

References _frustum.

◆ setPixelSizeVector()

void osg::CullingSet::setPixelSizeVector ( const Vec4 & v)
inline

References _pixelSizeVector.

◆ setSmallFeatureCullingPixelSize()

void osg::CullingSet::setSmallFeatureCullingPixelSize ( float value)
inline

Threshold at which small features are culled.

Parameters
valueBounding volume size in screen space. Default is 2.0.

References _smallFeatureCullingPixelSize.

Member Data Documentation

◆ _frustum

◆ _mask

◆ _occluderList

◆ _pixelSizeVector

◆ _smallFeatureCullingPixelSize

◆ _stateFrustumList


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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.