class SG_EXPORT osg::CullSettings

Inheritance:

Public Classes

enum ComputeNearFarMode

enum CullingModeValues

struct ClampProjectionMatrixCallback: public osg::Referenced

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

Public Methods

CullSettings()

CullSettings(ArgumentParser& arguments)

CullSettings(const CullSettings& cs)

virtual ~CullSettings()

CullSettings& operator = (const CullSettings& settings)

void setCullSettings(const CullSettings& settings)

void setDefaults()

void readEnvironmentalVariables()

read the environmental variables

void readCommandLine(ArgumentParser& arguments)

read the commandline arguments

void setImpostorsActive(bool active)

Switch the creation of Impostors on or off.

bool getImpostorsActive() const

Get whether impostors are active or not.

void setImpostorPixelErrorThreshold(float numPixels)

Set the impostor error threshold.

float getImpostorPixelErrorThreshold() const

Get the impostor error threshold

void setDepthSortImpostorSprites(bool doDepthSort)

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

bool setDepthSortImpostorSprites() const

Get whether ImpostorSprite's are depth sorted bin for rendering

void setNumberOfFrameToKeepImpostorSprites(int numFrames)

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

int getNumberOfFrameToKeepImpostorSprites() const

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

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

CullingMode getCullingMode() const

Returns the current CullingMode

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

osg::Node::NodeMask getCullMask() const

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

osg::Node::NodeMask getCullMaskLeft() const

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

osg::Node::NodeMask getCullMaskRight() const

void setLODScale(float bias)

Set the LOD bias for the CullVisitor to use

float getLODScale() const

Get the LOD bias

void setSmallFeatureCullingPixelSize(float value)

Set the Small Feature Culling Pixel Size

float getSmallFeatureCullingPixelSize() const

Get the Small Feature Culling Pixel Size

void setClampProjectionMatrixCallback(ClampProjectionMatrixCallback* cpmc)

set the ClampProjectionMatrixCallback

ClampProjectionMatrixCallback* getClampProjectionMatrixCallback()

get the non const ClampProjectionMatrixCallback

const ClampProjectionMatrixCallback* getClampProjectionMatrixCallback() const

get the const ClampProjectionMatrixCallback

Public

typedef unsigned int CullingMode

Protected Fields

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

Documentation

CullSettings()

CullSettings(ArgumentParser& arguments)

CullSettings(const CullSettings& cs)

virtual ~CullSettings()

CullSettings& operator = (const CullSettings& settings)

void setCullSettings(const CullSettings& settings)

void setDefaults()

void readEnvironmentalVariables()

read the environmental variables

void readCommandLine(ArgumentParser& arguments)

read the commandline arguments

void setImpostorsActive(bool active)

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.

bool getImpostorsActive() const

Get whether impostors are active or not.

void setImpostorPixelErrorThreshold(float numPixels)

Set the impostor error threshold. Used in calculation of whether impostors remain valid.

float getImpostorPixelErrorThreshold() const

Get the impostor error threshold

void setDepthSortImpostorSprites(bool doDepthSort)

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

bool setDepthSortImpostorSprites() const

Get whether ImpostorSprite's are depth sorted bin for rendering

void setNumberOfFrameToKeepImpostorSprites(int numFrames)

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

int getNumberOfFrameToKeepImpostorSprites() const

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

enum ComputeNearFarMode

DO_NOT_COMPUTE_NEAR_FAR

COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES

COMPUTE_NEAR_FAR_USING_PRIMITIVES

void setComputeNearFarMode(ComputeNearFarMode cnfm)

ComputeNearFarMode getComputeNearFarMode() const

void setNearFarRatio(double ratio)

double getNearFarRatio() const

enum CullingModeValues

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

typedef unsigned int CullingMode

void setCullingMode(CullingMode mode)

Set the culling mode for the CullVisitor to use

CullingMode getCullingMode() const

Returns the current CullingMode

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

osg::Node::NodeMask getCullMask() const

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

osg::Node::NodeMask getCullMaskLeft() const

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

osg::Node::NodeMask getCullMaskRight() const

void setLODScale(float bias)

Set the LOD bias for the CullVisitor to use

float getLODScale() const

Get the LOD bias

void setSmallFeatureCullingPixelSize(float value)

Set the Small Feature Culling Pixel Size

float getSmallFeatureCullingPixelSize() const

Get the Small Feature Culling Pixel Size

struct ClampProjectionMatrixCallback: public osg::Referenced

Callback for overriding the CullVisitor's default clamping of the projection matrix to computed near and far values. Note, both Matrixf and Matrixd versions of clampProjectionMatrixImplementation must be implemented as the CullVisitor can target either Matrix data type, configured at compile time.

virtual bool clampProjectionMatrixImplementation(osg::Matrixf& projection, double& znear, double& zfar) const

virtual bool clampProjectionMatrixImplementation(osg::Matrixd& projection, double& znear, double& zfar) const

void setClampProjectionMatrixCallback(ClampProjectionMatrixCallback* cpmc)

set the ClampProjectionMatrixCallback

ClampProjectionMatrixCallback* getClampProjectionMatrixCallback()

get the non const ClampProjectionMatrixCallback

const ClampProjectionMatrixCallback* getClampProjectionMatrixCallback() const

get the const ClampProjectionMatrixCallback

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

Direct child classes:

CullStack

Alphabetic index HTML hierarchy of classes or Java