Inheritance diagram for osg::CullSettings:

Classes
struct	ClampProjectionMatrixCallback
	Callback for overriding the CullVisitor's default clamping of the projection matrix to computed near and far values. More...

Public Types
enum	VariablesMask { COMPUTE_NEAR_FAR_MODE = (0x1 << 0), CULLING_MODE = (0x1 << 1), LOD_SCALE = (0x1 << 2), SMALL_FEATURE_CULLING_PIXEL_SIZE = (0x1 << 3), CLAMP_PROJECTION_MATRIX_CALLBACK = (0x1 << 4), NEAR_FAR_RATIO = (0x1 << 5), IMPOSTOR_ACTIVE = (0x1 << 6), DEPTH_SORT_IMPOSTOR_SPRITES = (0x1 << 7), IMPOSTOR_PIXEL_ERROR_THRESHOLD = (0x1 << 8), NUM_FRAMES_TO_KEEP_IMPOSTORS_SPRITES = (0x1 << 9), CULL_MASK = (0x1 << 10), CULL_MASK_LEFT = (0x1 << 11), CULL_MASK_RIGHT = (0x1 << 12), CLEAR_COLOR = (0x1 << 13), CLEAR_MASK = (0x1 << 14), LIGHTING_MODE = (0x1 << 15), LIGHT = (0x1 << 16), DRAW_BUFFER = (0x1 << 17), READ_BUFFER = (0x1 << 18), NO_VARIABLES = 0x00000000, ALL_VARIABLES = 0x7FFFFFFF }

enum	InheritanceMaskActionOnAttributeSetting { DISABLE_ASSOCIATED_INHERITANCE_MASK_BIT, DO_NOT_MODIFY_INHERITANCE_MASK }

enum	ComputeNearFarMode { DO_NOT_COMPUTE_NEAR_FAR = 0, COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES, COMPUTE_NEAR_FAR_USING_PRIMITIVES, COMPUTE_NEAR_USING_PRIMITIVES }

enum	CullingModeValues { 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, CLUSTER_CULLING = 0x20, DEFAULT_CULLING, ENABLE_ALL_CULLING }

typedef int	InheritanceMask

typedef int	CullingMode

Public Member Functions
	CullSettings ()

	CullSettings (ArgumentParser &arguments)

	CullSettings (const CullSettings &cs)

virtual	~CullSettings ()

CullSettings &	operator= (const CullSettings &settings)

virtual void	setDefaults ()

void	setInheritanceMask (InheritanceMask mask)
	Set the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object. More...

InheritanceMask	getInheritanceMask () const
	Get the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object. More...

void	setCullSettings (const CullSettings &settings)
	Set the local cull settings values from specified CullSettings object. More...

virtual void	inheritCullSettings (const CullSettings &settings)
	Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask. More...

virtual void	inheritCullSettings (const CullSettings &settings, unsigned int inheritanceMask)
	Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask. More...

void	readEnvironmentalVariables ()
	read the environmental variables. More...

void	readCommandLine (ArgumentParser &arguments)
	read the commandline arguments. More...

void	setInheritanceMaskActionOnAttributeSetting (InheritanceMaskActionOnAttributeSetting action)

InheritanceMaskActionOnAttributeSetting	getInheritanceMaskActionOnAttributeSetting () const

void	applyMaskAction (unsigned int maskBit)
	Apply the action, specified by the InheritanceMaskActionOnAttributeSetting, to apply to the inheritance bit mask. More...

void	setImpostorsActive (bool active)
	Switch the creation of Impostors on or off. More...

bool	getImpostorsActive () const
	Get whether impostors are active or not. More...

void	setImpostorPixelErrorThreshold (float numPixels)
	Set the impostor error threshold. More...

float	getImpostorPixelErrorThreshold () const
	Get the impostor error threshold. More...

void	setDepthSortImpostorSprites (bool doDepthSort)
	Set whether ImpostorSprite's should be placed in a depth sorted bin for rendering. More...

bool	getDepthSortImpostorSprites () const
	Get whether ImpostorSprite's are depth sorted bin for rendering. More...

void	setNumberOfFrameToKeepImpostorSprites (int numFrames)
	Set the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled. More...

int	getNumberOfFrameToKeepImpostorSprites () const
	Get the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled. More...

void	setComputeNearFarMode (ComputeNearFarMode cnfm)

ComputeNearFarMode	getComputeNearFarMode () const

void	setNearFarRatio (double ratio)

double	getNearFarRatio () const

void	setCullingMode (CullingMode mode)
	Set the culling mode for the CullVisitor to use. More...

CullingMode	getCullingMode () const
	Returns the current CullingMode. More...

void	setCullMask (osg::Node::NodeMask nm)

osg::Node::NodeMask	getCullMask () const

void	setCullMaskLeft (osg::Node::NodeMask nm)

osg::Node::NodeMask	getCullMaskLeft () const

void	setCullMaskRight (osg::Node::NodeMask nm)

osg::Node::NodeMask	getCullMaskRight () const

void	setLODScale (float scale)
	Set the LOD bias for the CullVisitor to use. More...

float	getLODScale () const
	Get the LOD bias. More...

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

float	getSmallFeatureCullingPixelSize () const
	Get the Small Feature Culling Pixel Size. More...

void	setClampProjectionMatrixCallback (ClampProjectionMatrixCallback *cpmc)
	set the ClampProjectionMatrixCallback. More...

ClampProjectionMatrixCallback *	getClampProjectionMatrixCallback ()
	get the non const ClampProjectionMatrixCallback. More...

const ClampProjectionMatrixCallback *	getClampProjectionMatrixCallback () const
	get the const ClampProjectionMatrixCallback. More...

void	write (std::ostream &out)
	Write out internal settings of CullSettings. More...

Member Typedef Documentation

◆ CullingMode

typedef int osg::CullSettings::CullingMode

◆ InheritanceMask

typedef int osg::CullSettings::InheritanceMask

Member Enumeration Documentation

◆ ComputeNearFarMode

enum osg::CullSettings::ComputeNearFarMode

Enumerator
DO_NOT_COMPUTE_NEAR_FAR
COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES
COMPUTE_NEAR_FAR_USING_PRIMITIVES
COMPUTE_NEAR_USING_PRIMITIVES

◆ CullingModeValues

enum osg::CullSettings::CullingModeValues

Enumerator
NO_CULLING
VIEW_FRUSTUM_SIDES_CULLING
NEAR_PLANE_CULLING
FAR_PLANE_CULLING
VIEW_FRUSTUM_CULLING
SMALL_FEATURE_CULLING
SHADOW_OCCLUSION_CULLING
CLUSTER_CULLING
DEFAULT_CULLING
ENABLE_ALL_CULLING

◆ InheritanceMaskActionOnAttributeSetting

enum osg::CullSettings::InheritanceMaskActionOnAttributeSetting

Enumerator
DISABLE_ASSOCIATED_INHERITANCE_MASK_BIT
DO_NOT_MODIFY_INHERITANCE_MASK

◆ VariablesMask

enum osg::CullSettings::VariablesMask

Enumerator
COMPUTE_NEAR_FAR_MODE
CULLING_MODE
LOD_SCALE
SMALL_FEATURE_CULLING_PIXEL_SIZE
CLAMP_PROJECTION_MATRIX_CALLBACK
NEAR_FAR_RATIO
IMPOSTOR_ACTIVE
DEPTH_SORT_IMPOSTOR_SPRITES
IMPOSTOR_PIXEL_ERROR_THRESHOLD
NUM_FRAMES_TO_KEEP_IMPOSTORS_SPRITES
CULL_MASK
CULL_MASK_LEFT
CULL_MASK_RIGHT
CLEAR_COLOR
CLEAR_MASK
LIGHTING_MODE
LIGHT
DRAW_BUFFER
READ_BUFFER
NO_VARIABLES
ALL_VARIABLES

Constructor & Destructor Documentation

◆ CullSettings() [1/3]

osg::CullSettings::CullSettings ( )

inline

◆ CullSettings() [2/3]

osg::CullSettings::CullSettings ( ArgumentParser & arguments )

inline

References osgDB::readCommandLine().

◆ CullSettings() [3/3]

osg::CullSettings::CullSettings ( const CullSettings & cs )

◆ ~CullSettings()

virtual osg::CullSettings::~CullSettings ( )

inlinevirtual

Member Function Documentation

◆ applyMaskAction()

void osg::CullSettings::applyMaskAction ( unsigned int maskBit )

inline

Apply the action, specified by the InheritanceMaskActionOnAttributeSetting, to apply to the inheritance bit mask.

This method is called by CullSettings::set*() parameter methods to ensure that CullSettings inheritance mechanisms doesn't overwrite the local parameter settings.

◆ getClampProjectionMatrixCallback() [1/2]

ClampProjectionMatrixCallback* osg::CullSettings::getClampProjectionMatrixCallback ( )

inline

get the non const ClampProjectionMatrixCallback.

◆ getClampProjectionMatrixCallback() [2/2]

const ClampProjectionMatrixCallback* osg::CullSettings::getClampProjectionMatrixCallback ( ) const

inline

get the const ClampProjectionMatrixCallback.

◆ getComputeNearFarMode()

ComputeNearFarMode osg::CullSettings::getComputeNearFarMode ( ) const

inline

◆ getCullingMode()

CullingMode osg::CullSettings::getCullingMode ( ) const

inline

Returns the current CullingMode.

◆ getCullMask()

osg::Node::NodeMask osg::CullSettings::getCullMask ( ) const

inline

◆ getCullMaskLeft()

osg::Node::NodeMask osg::CullSettings::getCullMaskLeft ( ) const

inline

◆ getCullMaskRight()

osg::Node::NodeMask osg::CullSettings::getCullMaskRight ( ) const

inline

◆ getDepthSortImpostorSprites()

bool osg::CullSettings::getDepthSortImpostorSprites ( ) const

inline

Get whether ImpostorSprite's are depth sorted bin for rendering.

◆ getImpostorPixelErrorThreshold()

float osg::CullSettings::getImpostorPixelErrorThreshold ( ) const

inline

Get the impostor error threshold.

◆ getImpostorsActive()

bool osg::CullSettings::getImpostorsActive ( ) const

inline

Get whether impostors are active or not.

◆ getInheritanceMask()

InheritanceMask osg::CullSettings::getInheritanceMask ( ) const

inline

Get the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object.

◆ getInheritanceMaskActionOnAttributeSetting()

InheritanceMaskActionOnAttributeSetting osg::CullSettings::getInheritanceMaskActionOnAttributeSetting ( ) const

inline

◆ getLODScale()

float osg::CullSettings::getLODScale ( ) const

inline

Get the LOD bias.

◆ getNearFarRatio()

double osg::CullSettings::getNearFarRatio ( ) const

inline

◆ getNumberOfFrameToKeepImpostorSprites()

int osg::CullSettings::getNumberOfFrameToKeepImpostorSprites ( ) const

inline

Get the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled.

◆ getSmallFeatureCullingPixelSize()

float osg::CullSettings::getSmallFeatureCullingPixelSize ( ) const

inline

Get the Small Feature Culling Pixel Size.

◆ inheritCullSettings() [1/2]

virtual void osg::CullSettings::inheritCullSettings ( const CullSettings & settings )

inlinevirtual

Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.

Reimplemented in osgUtil::SceneView.

References inheritCullSettings(), and osgDB::readCommandLine().

Referenced by inheritCullSettings().

◆ inheritCullSettings() [2/2]

virtual void osg::CullSettings::inheritCullSettings	(	const CullSettings &	settings,
		unsigned int	inheritanceMask
	)

virtual

Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.

Reimplemented in osg::Camera, and osgUtil::SceneView.

◆ operator=()

CullSettings& osg::CullSettings::operator= ( const CullSettings & settings )

inline

◆ readCommandLine()

void osg::CullSettings::readCommandLine ( ArgumentParser & arguments )

read the commandline arguments.

◆ readEnvironmentalVariables()

void osg::CullSettings::readEnvironmentalVariables ( )

read the environmental variables.

◆ setClampProjectionMatrixCallback()

void osg::CullSettings::setClampProjectionMatrixCallback ( ClampProjectionMatrixCallback * cpmc )

inline

set the ClampProjectionMatrixCallback.

◆ setComputeNearFarMode()

void osg::CullSettings::setComputeNearFarMode ( ComputeNearFarMode cnfm )

inline

◆ setCullingMode()

void osg::CullSettings::setCullingMode ( CullingMode mode )

inline

Set the culling mode for the CullVisitor to use.

◆ setCullMask()

void osg::CullSettings::setCullMask ( osg::Node::NodeMask nm )

inline

◆ setCullMaskLeft()

void osg::CullSettings::setCullMaskLeft ( osg::Node::NodeMask nm )

inline

◆ setCullMaskRight()

void osg::CullSettings::setCullMaskRight ( osg::Node::NodeMask nm )

inline

◆ setCullSettings()

void osg::CullSettings::setCullSettings ( const CullSettings & settings )

Set the local cull settings values from specified CullSettings object.

◆ setDefaults()

virtual void osg::CullSettings::setDefaults ( )

virtual

Reimplemented in osgUtil::SceneView.

◆ setDepthSortImpostorSprites()

void osg::CullSettings::setDepthSortImpostorSprites ( bool doDepthSort )

inline

Set whether ImpostorSprite's should be placed in a depth sorted bin for rendering.

◆ setImpostorPixelErrorThreshold()

void osg::CullSettings::setImpostorPixelErrorThreshold ( float numPixels )

inline

Set the impostor error threshold.

Used in calculation of whether impostors remain valid.

◆ setImpostorsActive()

void osg::CullSettings::setImpostorsActive ( bool active )

inline

Switch the creation of Impostors on or off.

Setting active to false forces the CullVisitor to use the Impostor LOD children for rendering. Setting active to true forces the CullVisitor to create the appropriate pre-rendering stages which render to the ImpostorSprite's texture.

◆ setInheritanceMask()

void osg::CullSettings::setInheritanceMask ( InheritanceMask mask )

inline

Set the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object.

◆ setInheritanceMaskActionOnAttributeSetting()

void osg::CullSettings::setInheritanceMaskActionOnAttributeSetting ( InheritanceMaskActionOnAttributeSetting action )

inline

◆ setLODScale()

void osg::CullSettings::setLODScale ( float scale )

inline

Set the LOD bias for the CullVisitor to use.

◆ setNearFarRatio()

void osg::CullSettings::setNearFarRatio ( double ratio )

inline

◆ setNumberOfFrameToKeepImpostorSprites()

void osg::CullSettings::setNumberOfFrameToKeepImpostorSprites ( int numFrames )

inline

Set the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled.

◆ setSmallFeatureCullingPixelSize()

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

inline

Threshold at which small features are culled.

Parameters

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

◆ write()

void osg::CullSettings::write ( std::ostream & out )

Write out internal settings of CullSettings.

Member Data Documentation

◆ _clampProjectionMatrixCallback

ref_ptr<ClampProjectionMatrixCallback> osg::CullSettings::_clampProjectionMatrixCallback

protected

◆ _computeNearFar

ComputeNearFarMode osg::CullSettings::_computeNearFar

protected

◆ _cullingMode

CullingMode osg::CullSettings::_cullingMode

protected

◆ _cullMask

Node::NodeMask osg::CullSettings::_cullMask

protected

◆ _cullMaskLeft

Node::NodeMask osg::CullSettings::_cullMaskLeft

protected

◆ _cullMaskRight

Node::NodeMask osg::CullSettings::_cullMaskRight

protected

◆ _depthSortImpostorSprites

bool osg::CullSettings::_depthSortImpostorSprites

protected

◆ _impostorActive

bool osg::CullSettings::_impostorActive

protected

◆ _impostorPixelErrorThreshold

float osg::CullSettings::_impostorPixelErrorThreshold

protected

◆ _inheritanceMask

InheritanceMask osg::CullSettings::_inheritanceMask

protected

◆ _inheritanceMaskActionOnAttributeSetting

InheritanceMaskActionOnAttributeSetting osg::CullSettings::_inheritanceMaskActionOnAttributeSetting

protected

◆ _LODScale

float osg::CullSettings::_LODScale

protected

◆ _nearFarRatio

double osg::CullSettings::_nearFarRatio

protected

◆ _numFramesToKeepImpostorSprites

int osg::CullSettings::_numFramesToKeepImpostorSprites

protected

◆ _smallFeatureCullingPixelSize

float osg::CullSettings::_smallFeatureCullingPixelSize

protected

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

osg/CullSettings

Protected Attributes
InheritanceMask	_inheritanceMask

InheritanceMaskActionOnAttributeSetting	_inheritanceMaskActionOnAttributeSetting

ComputeNearFarMode	_computeNearFar

CullingMode	_cullingMode

float	_LODScale

float	_smallFeatureCullingPixelSize

ref_ptr< ClampProjectionMatrixCallback >	_clampProjectionMatrixCallback

double	_nearFarRatio

bool	_impostorActive

bool	_depthSortImpostorSprites

float	_impostorPixelErrorThreshold

int	_numFramesToKeepImpostorSprites

Node::NodeMask	_cullMask

Node::NodeMask	_cullMaskLeft

Node::NodeMask	_cullMaskRight

Classes

Public Types

Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ CullingMode

◆ InheritanceMask

Member Enumeration Documentation

◆ ComputeNearFarMode

◆ CullingModeValues

◆ InheritanceMaskActionOnAttributeSetting

◆ VariablesMask

Constructor & Destructor Documentation

◆ CullSettings() [1/3]

◆ CullSettings() [2/3]

◆ CullSettings() [3/3]

◆ ~CullSettings()

Member Function Documentation

◆ applyMaskAction()

◆ getClampProjectionMatrixCallback() [1/2]

◆ getClampProjectionMatrixCallback() [2/2]

◆ getComputeNearFarMode()

◆ getCullingMode()

◆ getCullMask()

◆ getCullMaskLeft()

◆ getCullMaskRight()

◆ getDepthSortImpostorSprites()

◆ getImpostorPixelErrorThreshold()

◆ getImpostorsActive()

◆ getInheritanceMask()

◆ getInheritanceMaskActionOnAttributeSetting()

◆ getLODScale()

◆ getNearFarRatio()

◆ getNumberOfFrameToKeepImpostorSprites()

◆ getSmallFeatureCullingPixelSize()

◆ inheritCullSettings() [1/2]

◆ inheritCullSettings() [2/2]

◆ operator=()

◆ readCommandLine()

◆ readEnvironmentalVariables()

◆ setClampProjectionMatrixCallback()

◆ setComputeNearFarMode()

◆ setCullingMode()

◆ setCullMask()

◆ setCullMaskLeft()

◆ setCullMaskRight()

◆ setCullSettings()

◆ setDefaults()

◆ setDepthSortImpostorSprites()

◆ setImpostorPixelErrorThreshold()

◆ setImpostorsActive()

◆ setInheritanceMask()

◆ setInheritanceMaskActionOnAttributeSetting()

◆ setLODScale()

◆ setNearFarRatio()

◆ setNumberOfFrameToKeepImpostorSprites()

◆ setSmallFeatureCullingPixelSize()

◆ write()

Member Data Documentation

◆ _clampProjectionMatrixCallback

◆ _computeNearFar

◆ _cullingMode

◆ _cullMask

◆ _cullMaskLeft

◆ _cullMaskRight

◆ _depthSortImpostorSprites

◆ _impostorActive

◆ _impostorPixelErrorThreshold

◆ _inheritanceMask

◆ _inheritanceMaskActionOnAttributeSetting

◆ _LODScale

◆ _nearFarRatio

◆ _numFramesToKeepImpostorSprites

◆ _smallFeatureCullingPixelSize