VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtCameraObject Class Reference

The DtCameraObject is what controls the eyepoint in a channel. More...

List of all members.

Public Member Functions

 DtCameraObject (DtDe &de, DtUniqueID id)
 Constructor.
virtual ~DtCameraObject ()
 Destructor.
virtual void setChannelBindings (const std::string &displayName, const std::string &windowName, const std::string &channelName)
 Driver bound methods: These methods are bound to the driver.
virtual void setPosition (const DtVector &position)
 Set the position of the object.
virtual void setOrientation (const DtQuaternion &orientation)
 Set the position of the object.
virtual void setObserverName (const std::string &observerName)
 Parent Channel Methods These methods are for locking one channel to another "parent" channel.
virtual void setParentChannel (DtUniqueID id)
 Lock one channel to another "parent" channel.
virtual void setPositionOffset (const DtVector &offset)
 Set the relative position of the camera to the parent channel camera.
virtual void setOrientationOffset (const DtTaitBryan &offset)
 Set the orientation offset of the camera to the parent channel camera.
virtual const DtVectorposition () const
 Unbound methods: These methods are NOT bound to the driver.
virtual const DtQuaternion & orientation () const
 Get the position of the object.
virtual const DtVectorpositionOffset () const
 Get the position offset of this camera to the parent channel camera.
virtual const DtTaitBryan & orientationOffset () const
 Get the orientation offset of the camera to the parent channel camera.
const std::string & displayName () const
 Accessors for members.
const std::string & windowName () const
 Accessors for members.
const std::string & channelName () const
 Accessors for members.

Protected Member Functions

DtChannelfindChannel (const std::string &displayName, const std::string &windowName, const std::string &channelName)
 Helper method that gets a DtChannel from the display, window, channel triplet.

Protected Attributes

DtDemyDe
std::string myDisplayName
std::string myViewName
std::string myChannelName
DtVector myPosition
DtQuaternion myOrientation
DtVector myPositionOffset
DtTaitBryan myOrientationOffset

Detailed Description

The DtCameraObject is what controls the eyepoint in a channel.

This is the camera object that lives in the display's scene manager. It represents the position and orientation of a camera in a channel and is used as the eyepoint to render the scene. It is filled with data that comes from the DtCameraObjectDriver (which lives in the master scene on the master).


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

virtual void makVrv::DtCameraObject::setChannelBindings ( const std::string &  displayName,
const std::string &  windowName,
const std::string &  channelName 
) [virtual]

Driver bound methods: These methods are bound to the driver.

This method bind's the camera to a channel. Call after creation. If it's not bound to a camera will have no visual effect.

virtual void makVrv::DtCameraObject::setPosition ( const DtVector position) [virtual]

Set the position of the object.

The position should be in scene coordinates.

virtual void makVrv::DtCameraObject::setOrientation ( const DtQuaternion &  orientation) [virtual]

Set the position of the object.

The position should be in scene coordinates.

virtual void makVrv::DtCameraObject::setObserverName ( const std::string &  observerName) [virtual]

Parent Channel Methods These methods are for locking one channel to another "parent" channel.

The child channel will display from the eyepoint of the parent channel modified by the offset position and rotation. Specify an obserer for the channel to use

virtual void makVrv::DtCameraObject::setParentChannel ( DtUniqueID  id) [virtual]

Lock one channel to another "parent" channel.

Pass NullID to unlock this channel from it's parent.

virtual void makVrv::DtCameraObject::setPositionOffset ( const DtVector offset) [virtual]

Set the relative position of the camera to the parent channel camera.

virtual void makVrv::DtCameraObject::setOrientationOffset ( const DtTaitBryan &  offset) [virtual]

Set the orientation offset of the camera to the parent channel camera.

This is a DtTaitBryan because it is set by humans via the configuration dialog.

virtual const DtVector& makVrv::DtCameraObject::position ( ) const [virtual]

Unbound methods: These methods are NOT bound to the driver.

Get the position of the object. The position should be in scene coordinates.

virtual const DtQuaternion& makVrv::DtCameraObject::orientation ( ) const [virtual]

Get the position of the object.

The position should be in scene coordinates.

virtual const DtVector& makVrv::DtCameraObject::positionOffset ( ) const [virtual]

Get the position offset of this camera to the parent channel camera.

virtual const DtTaitBryan& makVrv::DtCameraObject::orientationOffset ( ) const [virtual]

Get the orientation offset of the camera to the parent channel camera.

const std::string& makVrv::DtCameraObject::displayName ( ) const

Accessors for members.

const std::string& makVrv::DtCameraObject::windowName ( ) const

Accessors for members.

const std::string& makVrv::DtCameraObject::channelName ( ) const

Accessors for members.

DtChannel* makVrv::DtCameraObject::findChannel ( const std::string &  displayName,
const std::string &  windowName,
const std::string &  channelName 
) [protected]

Helper method that gets a DtChannel from the display, window, channel triplet.


Member Data Documentation

std::string makVrv::DtCameraObject::myDisplayName [protected]
std::string makVrv::DtCameraObject::myViewName [protected]
std::string makVrv::DtCameraObject::myChannelName [protected]
DtQuaternion makVrv::DtCameraObject::myOrientation [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)