makVrv::DtChannelConfiguration Class Reference

Configuration for a single channel Serialized and sent to remote displays as necessary to configure remote channels. More...

Inheritance diagram for makVrv::DtChannelConfiguration:

Public Types
enum	ProjectionUnits { NoUnits, FieldOfViewAngles, DatabaseUnits }
enum	ProjectionResizePolicy { FIXED = 0, HORIZONTAL, VERTICAL, NONE }
enum	NearFarClipPolicy { NEAR_FAR_FIXED, NEAR_FAR_DYNAMIC_REDUCE_NEAR_CLIP, NEAR_FAR_DYNAMIC_REDUCE_Z_FIGHT, NEAR_FAR_DYNAMIC_NEAR_CLIP_MAG_CLAMP }
enum	DynamicNearClipAttachedObjectPolicy { IGNORE_ATTACHED = 0, FIXED_NEAR_CLIP_ATTACHED, DISTANCE_TO_ATTACHED }
Public Types inherited from makVrv::DtConfiguration
typedef std::map< std::string, std::string >	ParameterMap

Public Member Functions
	DtChannelConfiguration (const std::string &name=DefaultChannelString)
	CTOR The default channel configuration. More...
	DtChannelConfiguration (const DtChannelConfiguration &)
	Copy CTOR. More...
DtChannelConfiguration &	operator= (const DtChannelConfiguration &)
	Assignment operator. More...
virtual	~DtChannelConfiguration ()
	DTOR. More...
virtual void	setParentChannel (const std::string &displayName, const std::string &windowName, const std::string &channelName)
	Set the parent channel that this channel's camera will be "locked" to. More...
virtual void	getParentChannel (std::string &displayEngineNameOut, std::string &windowNameOut, std::string &channelNameOut) const
	Get the parent channel that this channel's camera will be "locked" to. More...
virtual void	setProjection (ProjectionUnits units, double left, double right, double bottom, double top, double zNear, double zFar)
	Set projection. More...
virtual void	getProjection (ProjectionUnits &units, double &left, double &right, double &bottom, double &top, double &zNear, double &zFar) const
	Get projection. More...
virtual ProjectionUnits	projectionUnits () const
	ProjectionUnits accessor. More...
virtual void	setProjectionUnits (ProjectionUnits units)
	ProjectionUnits setter. More...
virtual void	getClearColor (float &r, float &g, float &b, float &a) const
	Get the clear color. More...
virtual void	setClearColor (float r, float g, float b, float a)
	Set the clear color. More...
virtual void	setCameraPositionOffset (double x, double y, double z)
	Set the camera position offset. More...
virtual void	getCameraPositionOffset (double &x, double &y, double &z) const
	Get the camera position offset. More...
virtual void	setCameraOrientationOffset (double psi, double theta, double phi)
	Set the camera orientation offset. More...
virtual void	getCameraOrientationOffset (double &psi, double &theta, double &phi) const
	Get the camera orientation offset. More...
virtual void	getViewport (double &left, double &right, double &bottom, double &top) const
	Get the viewport. Values are percentages of the window's dimensions. More...
virtual void	setViewport (double left, double right, double bottom, double top)
	Set the viewport. Values are percentages of the window's dimensions. More...
virtual const std::string &	observerName () const
	Get the observer name. More...
virtual void	setObserverName (const std::string &observerName)
	Set the observer name. More...
virtual const std::string &	sensorName () const
	Get the sensor name. More...
virtual void	setSensorName (const std::string &sensorName)
	Set the sensor name. More...
virtual ProjectionResizePolicy	projectionResizePolicy () const
	ProjectionResizePolicy accessor. More...
virtual void	setProjectionResizePolicy (ProjectionResizePolicy policy)
	ProjectionResizePolicy setter. More...
virtual double	cameraMagnification () const
	Get the 3D camera's magnification for this channel. More...
virtual void	setCameraMagnification (double mag)
	Set the 3D camera's magnification for this channel (default is 1.0) More...
virtual float	lodScale () const
	Get the lodScale for this channel. More...
virtual void	setLodScale (float lodScale)
	Set the lod scale for this channel. More...
virtual void	setNearFarClipPolicy (NearFarClipPolicy policy)
	When using dynamic near/far clipping planes, optimize for z fighting reduction (keeping the near/far ratio small if true. More...
virtual NearFarClipPolicy	nearFarClipPolicy () const
	Get whether dynamic near/far clipping is using z-fighting reduction. More...
virtual void	setZFightReductionRatio (double ratio)
	When using z-fighting reduction, set the ratio that we attempt to maintain. More...
virtual double	zFightReductionRatio () const
	Get the near/far ratio used when dynamic near/far clipping is using z-fighting reduction. More...
virtual void	setDynamicNearClipAttachedObjectPolicy (DynamicNearClipAttachedObjectPolicy useAttached)
	When dynamic clipping planes is enabled, consider attached objects above a specified altitude when calculating the near clipping plane. More...
virtual DynamicNearClipAttachedObjectPolicy	dynamicNearClipAttachedObjectPolicy () const
	Get whether attached objects are considered for calculating the near clipping plane. More...
virtual void	setAltitudeForUseAttachedNearClip (double altitude)
	Specify the altitude to use when considering attached objects when calculating the near clipping plane. More...
virtual double	altitudeForUseAttachedNearClip () const
	Get the altitude being used when considering attached objects when calculating the near clipping plane. More...
virtual void	setNearClipWhenAttached (double distance)
	Set the near clipping distance used when attached, useAttachedForNearClip is true, and useFixedNearClipWhenAttached is true. More...
virtual double	nearClipWhenAttached () const
	Get the near clipping distance used when attached, useAttachedForNearClip is true, and useFixedNearClipWhenAttached is true. More...
virtual void	setDynamicWaterVisibilityEnable (bool enable)
	Set dynamic water visibility, based on altitude. More...
virtual bool	dynamicWaterVisibilityEnable () const
	Get whether dynamic water is enabled. More...
virtual void	setDynamicWaterVisibilityMax (double visMax)
	Set the maximum value to which water visibility will be set when dynamic water visibility is enabled. More...
virtual double	dynamicWaterVisibilityMax () const
	Get the maximum value to which water visibility will be set when dynamic water visibility is enabled. More...
virtual void	setRenderOrder (int order)
	order number for this channel to render. More...
virtual int	renderOrder () const
	get the render order for this channel which is used to order the channels rendering. More...
virtual double	minZNear (double value) const
	get the minimum value to which the passed in z near value to setProjection gets automatically clamped to default value is 0.01 More...
virtual void	setMinZNear (double value)
	set the minimum value to which the passed in z near value to setProjection gets automatically clamped to default value is 0.01 More...
virtual float	pixelRatio () const
	get the pixel ratio for high dpi scaling More...
virtual void	setPixelRatio (float ratio)
	set the pixel ratio for high dpi scaling default value is 1.0 More...
Public Member Functions inherited from makVrv::DtConfiguration
	DtConfiguration (const std::string &name="")
	CTOR. More...
	DtConfiguration (const DtConfiguration &)
	Copy CTOR. More...
DtConfiguration &	operator= (const DtConfiguration &)
	Assignment OP. More...
virtual	~DtConfiguration ()
	DTOR. More...
virtual const std::string &	name () const
	Get the configuration name. More...
virtual void	setName (const std::string &name)
	Set the configuration name. More...
virtual const std::string *	findOptionalParameter (const std::string &name) const
	Find an optional parameters. More...
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter. More...
virtual void	setOptionalParameters (const ParameterMap &)
	Set an optional parameters. More...
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter. More...
const ParameterMap &	optionalParameters () const
	Get the optional parameters. More...
Public Member Functions inherited from makVrv::DtKeywordMixin
	DtKeywordMixin ()
	CTOR. More...
virtual	~DtKeywordMixin ()
	DTOR. More...
virtual void	addKeyword (const std::string &keyword)
	Add a keyword. More...
virtual void	removeKeyword (const std::string &keyword)
	Remove a keyword. More...
virtual void	clearKeywords ()
	Clear the keywords. More...
virtual const std::set < std::string > &	keywords () const
	Get the keywords. More...
virtual bool	findKeywords (const std::set< std::string > &) const
	Check to see if the class has any of the supplied keywords For best performance sort the keywords (from most frequent to less frequent) and for keywords with the same frequency shortest to longest. More...
virtual bool	findKeyword (const std::string &word) const
	Check to see if a single keyword is in the set. More...

Static Public Attributes
static const char *	DefaultChannelString
static const char *	UseObserverSensorString
	Special sensor name that indicates this channel should use the sensor specified by its observer. More...

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive. More...
Protected Member Functions inherited from makVrv::DtConfiguration
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive example: fstream fo("test.xml",std;:ios_base::out); xml_oarchive os(fo); DtConfiguration aConfig; aConfig.serialize(os,0);. More...

Protected Attributes
std::string	myParentDisplayEngineName
std::string	myParentWindowName
std::string	myParentChannelName
float	myPixelRatio
float	myClearColorR
float	myClearColorG
float	myClearColorB
float	myClearColorA
double	myViewportLeft
double	myViewportRight
double	myViewportBottom
double	myViewportTop
double	myCameraPositionOffsetX
double	myCameraPositionOffsetY
double	myCameraPositionOffsetZ
double	myCameraOrientationOffsetPsi
double	myCameraOrientationOffsetTheta
double	myCameraOrientationOffsetPhi
double	myFrustumLeft
	Projection stuff. More...
double	myFrustumRight
double	myFrustumTop
double	myFrustumBottom
double	myNearZ
double	myFarZ
double	myMinZNear
bool	myDynamicNearFar
double	myNearFarRatio
double	myCameraMagnification
float	myLodScale
ProjectionUnits	myProjectionUnits
std::string	myObserverName
std::string	mySensorName
ProjectionResizePolicy	myProjectionResizePolicy
NearFarClipPolicy	myNearFarClipPolicy
double	myZFightReductionRatio
DynamicNearClipAttachedObjectPolicy	myDynamicNearClipAttachedObjectPolicy
double	myAltitudeForUseAttachedNearClip
double	myNearClipWhenAttached
bool	myDynamicWaterVisibilityEnable
double	myDynamicWaterVisibilityMax
int	myRenderOrder
Protected Attributes inherited from makVrv::DtConfiguration
std::string	myName
ParameterMap	myOptionalParameters
DtProxyWP	myAttachedInterface
Protected Attributes inherited from makVrv::DtKeywordMixin
std::set< std::string >	myKeywords

Detailed Description

Configuration for a single channel Serialized and sent to remote displays as necessary to configure remote channels.

Examples

• exampleConfiguration

Member Enumeration Documentation

enum makVrv::DtChannelConfiguration::ProjectionUnits

Enumerator
NoUnits
FieldOfViewAngles
DatabaseUnits

enum makVrv::DtChannelConfiguration::ProjectionResizePolicy

Enumerator
FIXED
HORIZONTAL	Keep the projection matrix fixed, despite window resizes.
VERTICAL	Adjust the HORIZOTNAL field of view on window resizes.
NONE	Adjust the VERTICAL field of view on window resizes.

enum makVrv::DtChannelConfiguration::NearFarClipPolicy

Enumerator
NEAR_FAR_FIXED
NEAR_FAR_DYNAMIC_REDUCE_NEAR_CLIP
NEAR_FAR_DYNAMIC_REDUCE_Z_FIGHT
NEAR_FAR_DYNAMIC_NEAR_CLIP_MAG_CLAMP

enum makVrv::DtChannelConfiguration::DynamicNearClipAttachedObjectPolicy

Enumerator
IGNORE_ATTACHED
FIXED_NEAR_CLIP_ATTACHED	Ignore attached objects when setting near clipping plane.
DISTANCE_TO_ATTACHED	Used a fixed near clipping plane distance when attached. Use the distance to the attached object (and its bounding volume)

Constructor & Destructor Documentation

makVrv::DtChannelConfiguration::DtChannelConfiguration

(

const std::string &

name = DefaultChannelString

)

CTOR The default channel configuration.

makVrv::DtChannelConfiguration::DtChannelConfiguration

(

const DtChannelConfiguration &

)

Copy CTOR.

virtual makVrv::DtChannelConfiguration::~DtChannelConfiguration ( )

virtual

DTOR.

Member Function Documentation

DtChannelConfiguration& makVrv::DtChannelConfiguration::operator=

(

const DtChannelConfiguration &

)

Assignment operator.

virtual void makVrv::DtChannelConfiguration::setParentChannel ( const std::string &  displayName, const std::string &  windowName, const std::string &  channelName  )

virtual

Set the parent channel that this channel's camera will be "locked" to.

virtual void makVrv::DtChannelConfiguration::getParentChannel ( std::string &  displayEngineNameOut, std::string &  windowNameOut, std::string &  channelNameOut  ) const

virtual

Get the parent channel that this channel's camera will be "locked" to.

virtual void makVrv::DtChannelConfiguration::setProjection ( ProjectionUnits  units, double  left, double  right, double  bottom, double  top, double  zNear, double  zFar  )

virtual

Set projection.

virtual void makVrv::DtChannelConfiguration::getProjection ( ProjectionUnits &  units, double &  left, double &  right, double &  bottom, double &  top, double &  zNear, double &  zFar  ) const

virtual

Get projection.

virtual ProjectionUnits makVrv::DtChannelConfiguration::projectionUnits ( ) const

virtual

ProjectionUnits accessor.

virtual void makVrv::DtChannelConfiguration::setProjectionUnits ( ProjectionUnits  units )

virtual

ProjectionUnits setter.

virtual void makVrv::DtChannelConfiguration::getClearColor ( float &  r, float &  g, float &  b, float &  a  ) const

virtual

Get the clear color.

Each color will be between [0 - 1] inclusively.

virtual void makVrv::DtChannelConfiguration::setClearColor ( float  r, float  g, float  b, float  a  )

virtual

Set the clear color.

Each color should be between [0 - 1] inclusively.

virtual void makVrv::DtChannelConfiguration::setCameraPositionOffset ( double  x, double  y, double  z  )

virtual

Set the camera position offset.

virtual void makVrv::DtChannelConfiguration::getCameraPositionOffset ( double &  x, double &  y, double &  z  ) const

virtual

Get the camera position offset.

virtual void makVrv::DtChannelConfiguration::setCameraOrientationOffset ( double  psi, double  theta, double  phi  )

virtual

Set the camera orientation offset.

virtual void makVrv::DtChannelConfiguration::getCameraOrientationOffset ( double &  psi, double &  theta, double &  phi  ) const

virtual

Get the camera orientation offset.

virtual void makVrv::DtChannelConfiguration::getViewport ( double &  left, double &  right, double &  bottom, double &  top  ) const

virtual

Get the viewport. Values are percentages of the window's dimensions.

virtual void makVrv::DtChannelConfiguration::setViewport ( double  left, double  right, double  bottom, double  top  )

virtual

Set the viewport. Values are percentages of the window's dimensions.

virtual const std::string& makVrv::DtChannelConfiguration::observerName ( ) const

virtual

Get the observer name.

virtual void makVrv::DtChannelConfiguration::setObserverName ( const std::string &  observerName )

virtual

Set the observer name.

virtual const std::string& makVrv::DtChannelConfiguration::sensorName ( ) const

virtual

Get the sensor name.

virtual void makVrv::DtChannelConfiguration::setSensorName ( const std::string &  sensorName )

virtual

Set the sensor name.

virtual ProjectionResizePolicy makVrv::DtChannelConfiguration::projectionResizePolicy ( ) const

virtual

ProjectionResizePolicy accessor.

virtual void makVrv::DtChannelConfiguration::setProjectionResizePolicy ( ProjectionResizePolicy  policy )

virtual

ProjectionResizePolicy setter.

virtual double makVrv::DtChannelConfiguration::cameraMagnification ( ) const

virtual

Get the 3D camera's magnification for this channel.

virtual void makVrv::DtChannelConfiguration::setCameraMagnification ( double  mag )

virtual

Set the 3D camera's magnification for this channel (default is 1.0)

virtual float makVrv::DtChannelConfiguration::lodScale ( ) const

virtual

Get the lodScale for this channel.

virtual void makVrv::DtChannelConfiguration::setLodScale ( float  lodScale )

virtual

Set the lod scale for this channel.

During cull (when LOD's are determined) distances will be scaled by the product of this value and the camera magnification (users will typically use either view magnification or modify FOV angles + lod scaling)

virtual void makVrv::DtChannelConfiguration::setNearFarClipPolicy ( NearFarClipPolicy  policy )

virtual

When using dynamic near/far clipping planes, optimize for z fighting reduction (keeping the near/far ratio small if true.

If false, use the original scheme which tried to keep the near clipping plane as small as reasonable

virtual NearFarClipPolicy makVrv::DtChannelConfiguration::nearFarClipPolicy ( ) const

virtual

Get whether dynamic near/far clipping is using z-fighting reduction.

virtual void makVrv::DtChannelConfiguration::setZFightReductionRatio ( double  ratio )

virtual

When using z-fighting reduction, set the ratio that we attempt to maintain.

virtual double makVrv::DtChannelConfiguration::zFightReductionRatio ( ) const

virtual

Get the near/far ratio used when dynamic near/far clipping is using z-fighting reduction.

virtual void makVrv::DtChannelConfiguration::setDynamicNearClipAttachedObjectPolicy ( DynamicNearClipAttachedObjectPolicy  useAttached )

virtual

When dynamic clipping planes is enabled, consider attached objects above a specified altitude when calculating the near clipping plane.

virtual DynamicNearClipAttachedObjectPolicy makVrv::DtChannelConfiguration::dynamicNearClipAttachedObjectPolicy ( ) const

virtual

Get whether attached objects are considered for calculating the near clipping plane.

virtual void makVrv::DtChannelConfiguration::setAltitudeForUseAttachedNearClip ( double  altitude )

virtual

Specify the altitude to use when considering attached objects when calculating the near clipping plane.

virtual double makVrv::DtChannelConfiguration::altitudeForUseAttachedNearClip ( ) const

virtual

Get the altitude being used when considering attached objects when calculating the near clipping plane.

virtual void makVrv::DtChannelConfiguration::setNearClipWhenAttached ( double  distance )

virtual

Set the near clipping distance used when attached, useAttachedForNearClip is true, and useFixedNearClipWhenAttached is true.

virtual double makVrv::DtChannelConfiguration::nearClipWhenAttached ( ) const

virtual

Get the near clipping distance used when attached, useAttachedForNearClip is true, and useFixedNearClipWhenAttached is true.

virtual void makVrv::DtChannelConfiguration::setDynamicWaterVisibilityEnable ( bool  enable )

virtual

Set dynamic water visibility, based on altitude.

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

virtual bool makVrv::DtChannelConfiguration::dynamicWaterVisibilityEnable ( ) const

virtual

Get whether dynamic water is enabled.

virtual void makVrv::DtChannelConfiguration::setDynamicWaterVisibilityMax ( double  visMax )

virtual

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

virtual double makVrv::DtChannelConfiguration::dynamicWaterVisibilityMax ( ) const

virtual

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

virtual void makVrv::DtChannelConfiguration::setRenderOrder ( int  order )

virtual

order number for this channel to render.

Lower order numbered channels render first For DtOsgChannel this sets the channels scene and rtt camera's render orders.

virtual int makVrv::DtChannelConfiguration::renderOrder ( ) const

virtual

get the render order for this channel which is used to order the channels rendering.

virtual double makVrv::DtChannelConfiguration::minZNear ( double  value ) const

virtual

get the minimum value to which the passed in z near value to setProjection gets automatically clamped to default value is 0.01

virtual void makVrv::DtChannelConfiguration::setMinZNear ( double  value )

virtual

set the minimum value to which the passed in z near value to setProjection gets automatically clamped to default value is 0.01

virtual float makVrv::DtChannelConfiguration::pixelRatio ( ) const

virtual

get the pixel ratio for high dpi scaling

virtual void makVrv::DtChannelConfiguration::setPixelRatio ( float  ratio )

virtual

set the pixel ratio for high dpi scaling default value is 1.0

template<class Archive >

void makVrv::DtChannelConfiguration::_serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.

Member Data Documentation

const char* makVrv::DtChannelConfiguration::DefaultChannelString

static

const char* makVrv::DtChannelConfiguration::UseObserverSensorString

static

Special sensor name that indicates this channel should use the sensor specified by its observer.

std::string makVrv::DtChannelConfiguration::myParentDisplayEngineName

protected

std::string makVrv::DtChannelConfiguration::myParentWindowName

protected

std::string makVrv::DtChannelConfiguration::myParentChannelName

protected

float makVrv::DtChannelConfiguration::myPixelRatio

protected

float makVrv::DtChannelConfiguration::myClearColorR

protected

float makVrv::DtChannelConfiguration::myClearColorG

protected

float makVrv::DtChannelConfiguration::myClearColorB

protected

float makVrv::DtChannelConfiguration::myClearColorA

protected

double makVrv::DtChannelConfiguration::myViewportLeft

protected

double makVrv::DtChannelConfiguration::myViewportRight

protected

double makVrv::DtChannelConfiguration::myViewportBottom

protected

double makVrv::DtChannelConfiguration::myViewportTop

protected

double makVrv::DtChannelConfiguration::myCameraPositionOffsetX

protected

double makVrv::DtChannelConfiguration::myCameraPositionOffsetY

protected

double makVrv::DtChannelConfiguration::myCameraPositionOffsetZ

protected

double makVrv::DtChannelConfiguration::myCameraOrientationOffsetPsi

protected

double makVrv::DtChannelConfiguration::myCameraOrientationOffsetTheta

protected

double makVrv::DtChannelConfiguration::myCameraOrientationOffsetPhi

protected

double makVrv::DtChannelConfiguration::myFrustumLeft

protected

Projection stuff.

double makVrv::DtChannelConfiguration::myFrustumRight

protected

double makVrv::DtChannelConfiguration::myFrustumTop

protected

double makVrv::DtChannelConfiguration::myFrustumBottom

protected

double makVrv::DtChannelConfiguration::myNearZ

protected

double makVrv::DtChannelConfiguration::myFarZ

protected

double makVrv::DtChannelConfiguration::myMinZNear

protected

bool makVrv::DtChannelConfiguration::myDynamicNearFar

protected

double makVrv::DtChannelConfiguration::myNearFarRatio

protected

double makVrv::DtChannelConfiguration::myCameraMagnification

protected

float makVrv::DtChannelConfiguration::myLodScale

protected

ProjectionUnits makVrv::DtChannelConfiguration::myProjectionUnits

protected

std::string makVrv::DtChannelConfiguration::myObserverName

protected

std::string makVrv::DtChannelConfiguration::mySensorName

protected

ProjectionResizePolicy makVrv::DtChannelConfiguration::myProjectionResizePolicy

protected

NearFarClipPolicy makVrv::DtChannelConfiguration::myNearFarClipPolicy

protected

double makVrv::DtChannelConfiguration::myZFightReductionRatio

protected

DynamicNearClipAttachedObjectPolicy makVrv::DtChannelConfiguration::myDynamicNearClipAttachedObjectPolicy

protected

double makVrv::DtChannelConfiguration::myAltitudeForUseAttachedNearClip

protected

double makVrv::DtChannelConfiguration::myNearClipWhenAttached

protected

bool makVrv::DtChannelConfiguration::myDynamicWaterVisibilityEnable

protected

double makVrv::DtChannelConfiguration::myDynamicWaterVisibilityMax

protected

int makVrv::DtChannelConfiguration::myRenderOrder

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvUtil/DtChannelConfiguration.h