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

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::Polytope >	StateFrustumPair

typedef std::vector< StateFrustumPair >	StateFrustumList

typedef std::vector< ShadowVolumeOccluder >	OccluderList

typedef int	Mask

Public Member Functions
	CullingSet ()

	CullingSet (const CullingSet &cs)

	CullingSet (const CullingSet &cs, const Matrix &matrix, const Vec4 &pixelSizeVector)

CullingSet &	operator= (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)

Polytope &	getFrustum ()

const Polytope &	getFrustum () const

void	addStateFrustum (StateSet *stateset, Polytope &polytope)

void	getStateFrustumList (StateFrustumList &sfl)

StateFrustumList &	getStateFrustumList ()

void	addOccluder (ShadowVolumeOccluder &cv)

void	setPixelSizeVector (const Vec4 &v)

Vec4 &	getPixelSizeVector ()

const Vec4 &	getPixelSizeVector () const

void	setSmallFeatureCullingPixelSize (float value)
	Threshold at which small features are culled. More...

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. More...

float	pixelSize (const BoundingSphere &bs) const
	Compute the pixel of a bounding sphere. More...

float	clampedPixelSize (const Vec3 &v, float radius) const
	Compute the pixel of an object at position v, with specified radius. More...

float	clampedPixelSize (const BoundingSphere &bs) const
	Compute the pixel of a bounding sphere. More...

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. More...

	Referenced (const Referenced &)

Referenced &	operator= (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. More...

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () 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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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...

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. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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

typedef std::vector<ShadowVolumeOccluder> osg::CullingSet::OccluderList

◆ StateFrustumList

typedef std::vector< StateFrustumPair > osg::CullingSet::StateFrustumList

◆ StateFrustumPair

typedef std::pair< osg::ref_ptr<osg::StateSet>, osg::Polytope > osg::CullingSet::StateFrustumPair

Member Enumeration Documentation

◆ MaskValues

enum osg::CullingSet::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]

osg::CullingSet::CullingSet ( const CullingSet & cs )

inline

◆ 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

◆ addStateFrustum()

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

inline

◆ clampedPixelSize() [1/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.

◆ clampedPixelSize() [2/2]

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

inline

Compute the pixel of a bounding sphere.

fabs()ed to always be positive.

◆ computePixelSizeVector()

static 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

◆ getFrustum() [1/2]

Polytope& osg::CullingSet::getFrustum ( )

inline

◆ getFrustum() [2/2]

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

inline

◆ getPixelSizeVector() [1/2]

Vec4& osg::CullingSet::getPixelSizeVector ( )

inline

◆ getPixelSizeVector() [2/2]

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

inline

◆ getSmallFeatureCullingPixelSize() [1/2]

float& osg::CullingSet::getSmallFeatureCullingPixelSize ( )

inline

◆ getSmallFeatureCullingPixelSize() [2/2]

float osg::CullingSet::getSmallFeatureCullingPixelSize ( ) const

inline

◆ getStateFrustumList() [1/2]

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

inline

◆ getStateFrustumList() [2/2]

StateFrustumList& osg::CullingSet::getStateFrustumList ( )

inline

◆ isCulled() [1/3]

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

inline

◆ isCulled() [2/3]

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

inline

◆ isCulled() [3/3]

bool osg::CullingSet::isCulled ( const BoundingSphere & bs )

inline

References osg::BoundingSphereImpl< VT >::center(), and osg::BoundingSphereImpl< VT >::radius().

◆ operator=()

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

inline

References _frustum, _mask, _occluderList, _pixelSizeVector, _smallFeatureCullingPixelSize, and _stateFrustumList.

◆ pixelSize() [1/2]

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

inline

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

◆ pixelSize() [2/2]

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

inline

Compute the pixel of a bounding sphere.

References osg::BoundingSphereImpl< VT >::center(), and osg::BoundingSphereImpl< VT >::radius().

◆ 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

◆ 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

◆ setFrustum()

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

inline

◆ setPixelSizeVector()

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

inline

◆ setSmallFeatureCullingPixelSize()

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

inline

Threshold at which small features are culled.

Parameters

value Bounding volume size in screen space. Default is 2.0.

Member Data Documentation

◆ _frustum

Polytope osg::CullingSet::_frustum

protected

Referenced by operator=().

◆ _mask

Mask osg::CullingSet::_mask

protected

Referenced by operator=().

◆ _occluderList

OccluderList osg::CullingSet::_occluderList

protected

Referenced by operator=().

◆ _pixelSizeVector

Vec4 osg::CullingSet::_pixelSizeVector

protected

Referenced by operator=().

◆ _smallFeatureCullingPixelSize

float osg::CullingSet::_smallFeatureCullingPixelSize

protected

Referenced by operator=().

◆ _stateFrustumList

StateFrustumList osg::CullingSet::_stateFrustumList

protected

Referenced by operator=().

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

osg/CullingSet

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mask

◆ OccluderList

◆ StateFrustumList

◆ StateFrustumPair

Member Enumeration Documentation

◆ MaskValues

Constructor & Destructor Documentation

◆ CullingSet() [1/3]

◆ CullingSet() [2/3]

◆ CullingSet() [3/3]

◆ ~CullingSet()

Member Function Documentation

◆ addOccluder()

◆ addStateFrustum()

◆ clampedPixelSize() [1/2]

◆ clampedPixelSize() [2/2]

◆ computePixelSizeVector()

◆ disableAndPushOccludersCurrentMask()

◆ getCullingMask()

◆ getFrustum() [1/2]

◆ getFrustum() [2/2]

◆ getPixelSizeVector() [1/2]

◆ getPixelSizeVector() [2/2]

◆ getSmallFeatureCullingPixelSize() [1/2]

◆ getSmallFeatureCullingPixelSize() [2/2]

◆ getStateFrustumList() [1/2]

◆ getStateFrustumList() [2/2]

◆ isCulled() [1/3]

◆ isCulled() [2/3]

◆ isCulled() [3/3]

◆ operator=()

◆ pixelSize() [1/2]

◆ pixelSize() [2/2]

◆ popCurrentMask()

◆ popOccludersCurrentMask()

◆ pushCurrentMask()

◆ resetCullingMask()

◆ set() [1/2]

◆ set() [2/2]

◆ setCullingMask()

◆ setFrustum()

◆ setPixelSizeVector()

◆ setSmallFeatureCullingPixelSize()

Member Data Documentation

◆ _frustum

◆ _mask

◆ _occluderList

◆ _pixelSizeVector

◆ _smallFeatureCullingPixelSize

◆ _stateFrustumList