makVrv::DtOsgCullVisitorParameters Class Reference

The osg cull vistor parameters class provides additional culling and intersector parameters for choosing the LOD, and cull operations. More...

Inheritance diagram for makVrv::DtOsgCullVisitorParameters:

Public Member Functions
	DtOsgCullVisitorParameters ()
	CTOR.
void	setCameraMagnification (double mag)
	Set the camera Magnification that affects LODing and paging.
double	cameraMagnification () const
	Return the current camera magnification.
void	setCameraResolution (double factor)
	Set the zoom factor that effects LODing.
double	cameraResolution () const
	Get the zoom factor.
void	setCameraVelocity (double velocity)
	Set the camera velocity.
double	cameraVelocity () const
	Get the camera velocity.
void	setTerrainRadius (double rad)
	Set the terrain radius.
void	setAltitude2D (double altitude)
	Set the (implied) altitude when orthoCulling.
double	altitude2D () const
	Return the (implied) 2D altitude.
unsigned int	modelSet () const
	Get the model set currently being rendered.
void	setModelSet (unsigned int modelSet)
	Set the model set currently being rendered.
double	terrainRadius () const
	Get the terrain radius.
void	setOrthoCulling (bool ortho)
	Set whether the culling should be doing in orthographic mode.
bool	orthoCulling () const
	Get whether the culling is to be done in 2D orthographic mode.
void	setSkyRendering (bool renderSky)
	Set whether the sky is being rendered.
bool	skyRendering () const
	Get whether the sky is being rendered.
void	setDynamicLights (bool enabled)
	Set whether dynamic lights are enabled.
bool	dynamicLights () const
	Get whether dynamic lights rendering is enabled.
void	setDynamicOcean (bool enabled)
	Set whether a dynamic ocean rendering is enabled.
bool	dynamicOcean () const
	Get whether a dynamic ocean rendering is enabled.
void	setScaling (bool scaling)
	Set whether scalable groups should be scaled by distance.
bool	scaling () const
	Get whether scalable groups should be scaled by distance.
void	setScaleFactor (double scaleFactor)
	Set the additional (on top of distance) scale factor to apply.
double	scaleFactor () const
	Get the additional (on top of distance) scale factor to apply.
void	setCoordinateSystemChanged (bool changed)
	Set whether the coordinate system changed this frame.
bool	coordinateSystemChanged () const
	Get whether the coordinate system changed this frame.
void	setNodeXRScaler (DtOsgNodeXRScaler *scaler)
	Set the XR scaler to use.
double	calculateXRScale (const osg::Camera &camera, const osg::Node &node)
	calculate the XR scale using the registered XR scaler.
void	setScaleType (DtObserverObject::ScaleType scaleType)
	Set the type of model scaling to perform.
DtObserverObject::ScaleType	scaleType () const
	Get the type of model scaling to perform.
void	setClampedPixelSize (double d)
	Set the clamped pixel size calculated when using DtOsgFixedScaleParameters.
double	clampedPixelSize () const
	Retrieve the clamped pixel size set in setClampedPixelSize.
void	setDynamicWaterVisibilityEnable (bool enable)
	Set dynamic water visibility, based on altitude.
bool	dynamicWaterVisibilityEnable () const
	Get whether dynamic water is enabled.
void	setDynamicWaterVisibilityMax (double visMax)
	Set the maximum value to which water visibility will be set when dynamic water visibility is enabled.
double	dynamicWaterVisibilityMax () const
	Get the maximum value to which water visibility will be set when dynamic water visibility is enabled.
void	setPagedLodMagnificationScaleFactor (float factor)
	Set the amount that any view magnification value is reduced by when determining the distance to a paged LOD.
float	pagedLodMagnificationScaleFactor () const
	Get the amount that any view magnification value is reduced by when determining the distance to a paged LOD.
void	setPagedLodMagnificationHighLodAngle (float radians)
	Set the angle used when paging in high LOD tiles, the angle (radians) represents the half angle, so view dir +/- angle is used like a camera FOV A smaller number results in fewer high LOD tiles and saves memory.
float	pagedLodMagnificationHighLodAngle () const
	Get the viewing angle within which high LOD tiles will be used ex.
void	setIncludeLightPoints (bool flag)
	set the flag for including light points in this cull visitor traversal. If false then light points will be ignored.
bool	includeLightPoints () const
	get the flag for including light points in this cull visitor traversal. If false then light points will be ignored.
float	currentTraversalScaleFactor ()
	get the scale factor for the current place in the cull visitor traversal.
void	setCurrentTraversalScaleFactor (float currentScaleFactor)
	set the scale factor for the current place in the cull visitor traversal.

Protected Attributes
double	myCameraMagnification
double	myCameraResolution
double	myTerrainRadius
double	myAltitude2D
double	myAltitude3D
bool	mySkyFlag
bool	myDynamicLightsFlag
bool	myDynamicOceanFlag
bool	myOrthoFlag
bool	myScalingFlag
double	myScaleFactor
double	myClampedPixelSize
DtObserverObject::ScaleType	myScaleType
bool	myCoordinateSystemChanged
bool	myDynamicWaterVisibilityEnable
double	myDynamicWaterVisibilityMax
osg::ref_ptr< DtOsgNodeXRScaler >	myNodeXRScaler
float	myPagedLodMagnificationScaleFactor
float	myPagedLodMagnificationHighLodAngle
double	myCameraVelocity
unsigned int	myModelSet
bool	myIncludeLightPoints
float	myCurrentScaleFactor

Detailed Description

The osg cull vistor parameters class provides additional culling and intersector parameters for choosing the LOD, and cull operations.

Constructor & Destructor Documentation

makVrv::DtOsgCullVisitorParameters::DtOsgCullVisitorParameters ( )

inline

CTOR.

Member Function Documentation

void makVrv::DtOsgCullVisitorParameters::setCameraMagnification ( double  mag )

inline

Set the camera Magnification that affects LODing and paging.

double makVrv::DtOsgCullVisitorParameters::cameraMagnification ( ) const

inline

Return the current camera magnification.

void makVrv::DtOsgCullVisitorParameters::setCameraResolution ( double  factor )

inline

Set the zoom factor that effects LODing.

double makVrv::DtOsgCullVisitorParameters::cameraResolution ( ) const

inline

Get the zoom factor.

void makVrv::DtOsgCullVisitorParameters::setCameraVelocity ( double  velocity )

inline

Set the camera velocity.

double makVrv::DtOsgCullVisitorParameters::cameraVelocity ( ) const

inline

Get the camera velocity.

void makVrv::DtOsgCullVisitorParameters::setTerrainRadius ( double  rad )

inline

Set the terrain radius.

void makVrv::DtOsgCullVisitorParameters::setAltitude2D ( double  altitude )

inline

Set the (implied) altitude when orthoCulling.

double makVrv::DtOsgCullVisitorParameters::altitude2D ( ) const

inline

Return the (implied) 2D altitude.

unsigned int makVrv::DtOsgCullVisitorParameters::modelSet ( ) const

inline

Get the model set currently being rendered.

void makVrv::DtOsgCullVisitorParameters::setModelSet ( unsigned int  modelSet )

inline

Set the model set currently being rendered.

double makVrv::DtOsgCullVisitorParameters::terrainRadius ( ) const

inline

Get the terrain radius.

Referenced by makVrv::DtOsgFixedScaleParameters::calculateScaleFactors().

void makVrv::DtOsgCullVisitorParameters::setOrthoCulling ( bool  ortho )

inline

Set whether the culling should be doing in orthographic mode.

bool makVrv::DtOsgCullVisitorParameters::orthoCulling ( ) const

inline

Get whether the culling is to be done in 2D orthographic mode.

void makVrv::DtOsgCullVisitorParameters::setSkyRendering ( bool  renderSky )

inline

Set whether the sky is being rendered.

bool makVrv::DtOsgCullVisitorParameters::skyRendering ( ) const

inline

Get whether the sky is being rendered.

void makVrv::DtOsgCullVisitorParameters::setDynamicLights ( bool  enabled )

inline

Set whether dynamic lights are enabled.

bool makVrv::DtOsgCullVisitorParameters::dynamicLights ( ) const

inline

Get whether dynamic lights rendering is enabled.

void makVrv::DtOsgCullVisitorParameters::setDynamicOcean ( bool  enabled )

inline

Set whether a dynamic ocean rendering is enabled.

bool makVrv::DtOsgCullVisitorParameters::dynamicOcean ( ) const

inline

Get whether a dynamic ocean rendering is enabled.

void makVrv::DtOsgCullVisitorParameters::setScaling ( bool  scaling )

inline

Set whether scalable groups should be scaled by distance.

bool makVrv::DtOsgCullVisitorParameters::scaling ( ) const

inline

Get whether scalable groups should be scaled by distance.

void makVrv::DtOsgCullVisitorParameters::setScaleFactor ( double  scaleFactor )

inline

Set the additional (on top of distance) scale factor to apply.

double makVrv::DtOsgCullVisitorParameters::scaleFactor ( ) const

inline

Get the additional (on top of distance) scale factor to apply.

void makVrv::DtOsgCullVisitorParameters::setCoordinateSystemChanged ( bool  changed )

inline

Set whether the coordinate system changed this frame.

bool makVrv::DtOsgCullVisitorParameters::coordinateSystemChanged ( ) const

inline

Get whether the coordinate system changed this frame.

void makVrv::DtOsgCullVisitorParameters::setNodeXRScaler ( DtOsgNodeXRScaler *  scaler )

inline

Set the XR scaler to use.

This will not typically be called by users to change the XR Node Scaler, register a new DtOsgNodeXRScalerCreator

double makVrv::DtOsgCullVisitorParameters::calculateXRScale ( const osg::Camera &  camera, const osg::Node &  node  )

inline

calculate the XR scale using the registered XR scaler.

References makVrv::DtOsgNodeXRScaler::calculateXRScale().

void makVrv::DtOsgCullVisitorParameters::setScaleType ( DtObserverObject::ScaleType  scaleType )

inline

Set the type of model scaling to perform.

DtObserverObject::ScaleType makVrv::DtOsgCullVisitorParameters::scaleType ( ) const

inline

Get the type of model scaling to perform.

void makVrv::DtOsgCullVisitorParameters::setClampedPixelSize ( double  d )

inline

Set the clamped pixel size calculated when using DtOsgFixedScaleParameters.

This is ust used to pass the value from one form of calculateScaleFactors to the other

Referenced by makVrv::DtOsgFixedScaleParameters::calculateScaleFactors().

double makVrv::DtOsgCullVisitorParameters::clampedPixelSize ( ) const

inline

Retrieve the clamped pixel size set in setClampedPixelSize.

Referenced by makVrv::DtOsgFixedScaleParameters::calculateScaleFactors().

void makVrv::DtOsgCullVisitorParameters::setDynamicWaterVisibilityEnable ( bool  enable )

inline

Set dynamic water visibility, based on altitude.

Water visibility will be scaled from its specified value at 0 alt to the max value specified.

bool makVrv::DtOsgCullVisitorParameters::dynamicWaterVisibilityEnable ( ) const

inline

Get whether dynamic water is enabled.

void makVrv::DtOsgCullVisitorParameters::setDynamicWaterVisibilityMax ( double  visMax )

inline

Set the maximum value to which water visibility will be set when dynamic water visibility is enabled.

double makVrv::DtOsgCullVisitorParameters::dynamicWaterVisibilityMax ( ) const

inline

Get the maximum value to which water visibility will be set when dynamic water visibility is enabled.

void makVrv::DtOsgCullVisitorParameters::setPagedLodMagnificationScaleFactor ( float  factor )

inline

Set the amount that any view magnification value is reduced by when determining the distance to a paged LOD.

float makVrv::DtOsgCullVisitorParameters::pagedLodMagnificationScaleFactor ( ) const

inline

Get the amount that any view magnification value is reduced by when determining the distance to a paged LOD.

void makVrv::DtOsgCullVisitorParameters::setPagedLodMagnificationHighLodAngle ( float  radians )

inline

Set the angle used when paging in high LOD tiles, the angle (radians) represents the half angle, so view dir +/- angle is used like a camera FOV A smaller number results in fewer high LOD tiles and saves memory.

A larger number will prevent cracks between tiles by bringing in more nearby high LOD tiles but will use more memory.

float makVrv::DtOsgCullVisitorParameters::pagedLodMagnificationHighLodAngle ( ) const

inline

Get the viewing angle within which high LOD tiles will be used ex.

rad angle=0.26179 = 15 degrees, so view direction + 15 and -15 (so 30 deg total) will be used. Any tile centers in that range will use high LOD.

void makVrv::DtOsgCullVisitorParameters::setIncludeLightPoints ( bool  flag )

inline

set the flag for including light points in this cull visitor traversal. If false then light points will be ignored.

bool makVrv::DtOsgCullVisitorParameters::includeLightPoints ( ) const

inline

get the flag for including light points in this cull visitor traversal. If false then light points will be ignored.

float makVrv::DtOsgCullVisitorParameters::currentTraversalScaleFactor ( )

inline

get the scale factor for the current place in the cull visitor traversal.

this is used by the light point node so it can know how much to scale the light point size.

void makVrv::DtOsgCullVisitorParameters::setCurrentTraversalScaleFactor ( float  currentScaleFactor )

inline

set the scale factor for the current place in the cull visitor traversal.

this is used by the light point node so it can know how much to scale the light point size.

Member Data Documentation

double makVrv::DtOsgCullVisitorParameters::myCameraMagnification

protected

double makVrv::DtOsgCullVisitorParameters::myCameraResolution

protected

double makVrv::DtOsgCullVisitorParameters::myTerrainRadius

protected

double makVrv::DtOsgCullVisitorParameters::myAltitude2D

protected

double makVrv::DtOsgCullVisitorParameters::myAltitude3D

protected

bool makVrv::DtOsgCullVisitorParameters::mySkyFlag

protected

bool makVrv::DtOsgCullVisitorParameters::myDynamicLightsFlag

protected

bool makVrv::DtOsgCullVisitorParameters::myDynamicOceanFlag

protected

bool makVrv::DtOsgCullVisitorParameters::myOrthoFlag

protected

bool makVrv::DtOsgCullVisitorParameters::myScalingFlag

protected

double makVrv::DtOsgCullVisitorParameters::myScaleFactor

protected

double makVrv::DtOsgCullVisitorParameters::myClampedPixelSize

protected

DtObserverObject::ScaleType makVrv::DtOsgCullVisitorParameters::myScaleType

protected

bool makVrv::DtOsgCullVisitorParameters::myCoordinateSystemChanged

protected

bool makVrv::DtOsgCullVisitorParameters::myDynamicWaterVisibilityEnable

protected

double makVrv::DtOsgCullVisitorParameters::myDynamicWaterVisibilityMax

protected

osg::ref_ptr<DtOsgNodeXRScaler> makVrv::DtOsgCullVisitorParameters::myNodeXRScaler

protected

float makVrv::DtOsgCullVisitorParameters::myPagedLodMagnificationScaleFactor

protected

float makVrv::DtOsgCullVisitorParameters::myPagedLodMagnificationHighLodAngle

protected

double makVrv::DtOsgCullVisitorParameters::myCameraVelocity

protected

unsigned int makVrv::DtOsgCullVisitorParameters::myModelSet

protected

bool makVrv::DtOsgCullVisitorParameters::myIncludeLightPoints

protected

float makVrv::DtOsgCullVisitorParameters::myCurrentScaleFactor

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvOsg/DtOsgCullVisitorParameters.h