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

Inheritance diagram for makVrv::DtChannelConfiguration:

[legend]

List of all members.

Public Types
enum	ProjectionUnits { NoUnits, FieldOfViewAngles, DatabaseUnits }
enum	ProjectionResizePolicy { FIXED = 0, HORIZONTAL, VERTICAL, NONE }
Public Member Functions
	DtChannelConfiguration (const std::string &name=DefaultChannelString)
	CTOR The default channel configuration.
	DtChannelConfiguration (const DtChannelConfiguration &)
	Copy CTOR.
DtChannelConfiguration &	operator= (const DtChannelConfiguration &)
	Assignment operator.
virtual	~DtChannelConfiguration ()
	DTOR.
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.
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.
virtual void	setProjection (ProjectionUnits units, double left, double right, double bottom, double top, double zNear, double zFar)
	Set projection.
virtual void	getProjection (ProjectionUnits &units, double &left, double &right, double &bottom, double &top, double &zNear, double &zFar) const
	Get projection.
bool	dynamicNearFar () const
	Get if the channel uses dynamic near and far clipping planes.
void	setDynamicNearFar (bool enabled)
	Enable/Disable if the channel uses dynamic near and far clipping planes.
double	nearFarRatio () const
	Get the channel the near and far clipping plane ratio.
void	setNearFarRatio (double ratio)
	Set the channel the near and far clipping plane ratio.
virtual ProjectionUnits	projectionUnits () const
	ProjectionUnits accessor.
virtual void	setProjectionUnits (ProjectionUnits units)
	ProjectionUnits setter.
virtual void	getClearColor (float &r, float &g, float &b, float &a) const
	Get the clear color.
virtual void	setClearColor (float r, float g, float b, float a)
	Set the clear color.
virtual void	setCameraPositionOffset (double x, double y, double z)
	Set the camera position offset.
virtual void	getCameraPositionOffset (double &x, double &y, double &z) const
	Get the camera position offset.
virtual void	setCameraOrientationOffset (double psi, double theta, double phi)
	Set the camera orientation offset.
virtual void	getCameraOrientationOffset (double &psi, double &theta, double &phi) const
	Get the camera orientation offset.
virtual void	getViewport (double &left, double &right, double &bottom, double &top) const
	Get the viewport. Values are percentages of the window's dimensions.
virtual void	setViewport (double left, double right, double bottom, double top)
	Set the viewport. Values are percentages of the window's dimensions.
virtual const std::string &	observerName () const
	Get the observer name.
virtual void	setObserverName (const std::string &observerName)
	Set the observer name.
virtual ProjectionResizePolicy	projectionResizePolicy () const
	ProjectionResizePolicy accessor.
virtual void	setProjectionResizePolicy (ProjectionResizePolicy policy)
	ProjectionResizePolicy setter.
virtual double	cameraMagnification () const
	Get the 3D camera's magnification for this channel.
virtual void	setCameraMagnification (double mag)
	Set the 3D camera's magnification for this channel (default is 1.0)
Static Public Attributes
static const char *	DefaultChannelString
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.
Protected Attributes
std::string	myParentDisplayEngineName
std::string	myParentWindowName
std::string	myParentChannelName
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.
double	myFrustumRight
double	myFrustumTop
double	myFrustumBottom
double	myNearZ
double	myFarZ
bool	myDynamicNearFar
double	myNearFarRatio
double	myCameraMagnification
ProjectionUnits	myProjectionUnits
std::string	myObserverName
ProjectionResizePolicy	myProjectionResizePolicy

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.

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.

bool makVrv::DtChannelConfiguration::dynamicNearFar ( ) const

Get if the channel uses dynamic near and far clipping planes.

void makVrv::DtChannelConfiguration::setDynamicNearFar ( bool enabled )

Enable/Disable if the channel uses dynamic near and far clipping planes.

double makVrv::DtChannelConfiguration::nearFarRatio ( ) const

Get the channel the near and far clipping plane ratio.

void makVrv::DtChannelConfiguration::setNearFarRatio ( double ratio )

Set the channel the near and far clipping plane ratio.

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 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)

template<class Archive >

void makVrv::DtChannelConfiguration::_serialize	(	Archive &	ar,
		const unsigned int	version
	)		`[inline, protected]`

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.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.