VR-Vantage API Documentation
List of all members | Public Types | Public Member Functions | Static Public Attributes | Protected Attributes
DtStealthRemoteController Class Reference

Public Types

enum  Direction {
  Left, Right, Up, Down,
  Forward, Backward
}
 Move the eyepoint. More...

Public Member Functions

 DtStealthRemoteController (DtCustomRemoteControlSender *sender, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
 Create a DtStealthRemoteController that can send view control msgs using a custom message sender.
 DtStealthRemoteController (DtExerciseConn *c, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
 Create a DtStealthRemoteController for sending and receiving view control using the given exercise connection.
 DtStealthRemoteController (const char *execName, const char *federateType, DtFomMapper *mapper=DtRprFomMapper::create(NULL), const char *fedFileName=NULL, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
 Constructors.
 DtStealthRemoteController (const char *execName, const char *federateType, const char *dsoName, const char *fedFileName=NULL, void *fomMapInitData=NULL, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
virtual ~DtStealthRemoteController ()
virtual void setTargetStealthId (const DtGlobalObjectDesignator &id)
 Set/Get current target stealth (Can be DtEntityIdentifier::nullId)
virtual const
DtGlobalObjectDesignator & 
targetStealthId () const
virtual void setControllerId (const DtGlobalObjectDesignator &id)
 Set/Get the controller id.
virtual const
DtGlobalObjectDesignator & 
controllerId () const
virtual void reset () const
 

View Mode Control


virtual void moveEyepoint (Direction d) const
virtual void turnEyepoint (Direction d) const
virtual void set (const DtVector *geoc=NULL, const DtTaitBryan *ori=NULL) const
 Set a new viewer position or orientation (in geocentric) without changing changing the current view mode.
virtual void setMode (DtViewerCommand m, const DtVector *geocPos=NULL, const DtTaitBryan *geocOri=NULL) const
 Change the current view mode to the mode specified by m; If a geocentric position or database orientation is set, initilize the viewer position to this position.
virtual void setAbsoluteMode (const DtVector *geoc=NULL, const DtTaitBryan *ori=NULL) const
 Change the current view mode to absolute.
virtual void setCompassMode (const DtGlobalObjectDesignator *primary=NULL, const float *radius=NULL, const float *azimuth=NULL, const float *elevation=NULL) const
 Change the current view mode to Compass.
virtual void setMimicMode (const DtGlobalObjectDesignator *primary=NULL, const DtVector *offset=NULL) const
 Change the current view mode to Mimic.
virtual void setOrbitMode (const DtGlobalObjectDesignator *primary=NULL, const float *radius=NULL, const float *azimuth=NULL, const float *elevation=NULL, const float *azimuthRate=NULL) const
 Change the current view mode to Orbit.
virtual void setTetherMode (const DtGlobalObjectDesignator *primary=NULL, const DtVector *offset=NULL, const DtTaitBryan *ori=NULL) const
 Change the current view mode to Tether.
virtual void setTrackMode (const DtGlobalObjectDesignator *primary=NULL, const DtVector *geoc=NULL) const
 Change the current view mode to Track.
virtual void setMimicTrackMode (const DtGlobalObjectDesignator *attach=NULL, const DtGlobalObjectDesignator *track=NULL, const DtVector *offset=NULL) const
 Change the current view mode to MimicTrack.
virtual void setTetherTrackMode (const DtGlobalObjectDesignator *attach=NULL, const DtGlobalObjectDesignator *track=NULL, const DtVector *offset=NULL) const
 Change the current view mode to TetherTrack.
virtual void send (const DtStealthControlPdu &pdu) const
 Use this function to send a stealth control PDU directly.

Static Public Attributes

static const
DtGlobalObjectDesignator 
SEND_TO_ALL = "0:0:0"
 Returns a wild-card designator Id.

Protected Attributes

DtGlobalObjectDesignator myId
DtGlobalObjectDesignator myTargetId
DtExerciseConn * myExConn
DtCustomRemoteControlSendermySender
bool myCreatedExConn

Member Enumeration Documentation

Move the eyepoint.

Enumerator:
Left 
Right 
Up 
Down 
Forward 
Backward 

Constructor & Destructor Documentation

DtStealthRemoteController::DtStealthRemoteController ( DtCustomRemoteControlSender sender,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)

Create a DtStealthRemoteController that can send view control msgs using a custom message sender.

Use this creator if you would like to send view control msgs without a VR-Link license.

DtStealthRemoteController::DtStealthRemoteController ( DtExerciseConn *  c,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)

Create a DtStealthRemoteController for sending and receiving view control using the given exercise connection.

DtStealthRemoteController::DtStealthRemoteController ( const char *  execName,
const char *  federateType,
DtFomMapper *  mapper = DtRprFomMapper::create(NULL),
const char *  fedFileName = NULL,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)

Constructors.

References myExConn.

DtStealthRemoteController::DtStealthRemoteController ( const char *  execName,
const char *  federateType,
const char *  dsoName,
const char *  fedFileName = NULL,
void fomMapInitData = NULL,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)

References myExConn.

DtStealthRemoteController::~DtStealthRemoteController ( )
virtual

References myCreatedExConn, and myExConn.

Member Function Documentation

void DtStealthRemoteController::setTargetStealthId ( const DtGlobalObjectDesignator &  id)
virtual

Set/Get current target stealth (Can be DtEntityIdentifier::nullId)

References myTargetId.

const DtGlobalObjectDesignator & DtStealthRemoteController::targetStealthId ( ) const
virtual

References myTargetId.

Referenced by send().

void DtStealthRemoteController::setControllerId ( const DtGlobalObjectDesignator &  id)
virtual

Set/Get the controller id.

References myId.

const DtGlobalObjectDesignator & DtStealthRemoteController::controllerId ( ) const
virtual

References myId.

Referenced by send().

void DtStealthRemoteController::reset ( ) const
virtual


View Mode Control

Reset the current view mode

References send(), DtStealthControlPdu::setIgnoreFlags(), and DtMoveVCPdu::setReset().

void DtStealthRemoteController::moveEyepoint ( DtStealthRemoteController::Direction  d) const
virtual
void DtStealthRemoteController::turnEyepoint ( DtStealthRemoteController::Direction  d) const
virtual
void DtStealthRemoteController::set ( const DtVector *  geoc = NULL,
const DtTaitBryan *  ori = NULL 
) const
virtual

Set a new viewer position or orientation (in geocentric) without changing changing the current view mode.

Does nothing if both arguments are NULL.

References DtIGNORE_EAST, DtIGNORE_HEADING, DtIGNORE_HEIGHT, DtIGNORE_NORTH, DtIGNORE_PITCH, DtIGNORE_ROLL, send(), DtStealthControlPdu::setIgnoreFlags(), DtMoveVCPdu::setOrientation(), and DtMoveVCPdu::setPosition().

void DtStealthRemoteController::setMode ( DtViewerCommand  m,
const DtVector *  geocPos = NULL,
const DtTaitBryan *  geocOri = NULL 
) const
virtual

Change the current view mode to the mode specified by m; If a geocentric position or database orientation is set, initilize the viewer position to this position.

The following are invalid: DtViewerTurret = 4, DtViewerGroup = 9, DtViewerModeless = 10, DtViewerOptions = 11

References setAbsoluteMode(), setCompassMode(), setMimicMode(), setMimicTrackMode(), setOrbitMode(), setTetherMode(), setTetherTrackMode(), and setTrackMode().

void DtStealthRemoteController::setAbsoluteMode ( const DtVector *  geoc = NULL,
const DtTaitBryan *  ori = NULL 
) const
virtual

Change the current view mode to absolute.

If any of the optional parameters are set, these values will be used to initialize the view: geoc = start position (geocentric coords) ori = start orientation (database heading/pitch/roll) ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_EAST, DtIGNORE_HEADING, DtIGNORE_HEIGHT, DtIGNORE_NORTH, DtIGNORE_PITCH, DtIGNORE_ROLL, send(), DtStealthControlPdu::setIgnoreFlags(), DtAbsoluteVCPdu::setOrientation(), and DtAbsoluteVCPdu::setWorldLocation().

Referenced by setMode().

void DtStealthRemoteController::setCompassMode ( const DtGlobalObjectDesignator *  primary = NULL,
const float *  radius = NULL,
const float *  azimuth = NULL,
const float *  elevation = NULL 
) const
virtual

Change the current view mode to Compass.

If any of the optional parameters are set, these values will be used to initialize the view: primary = id of primary entity radius = distance from center of the primary object azimuth = angle to move left/right around entity (radians) elevation = angle to move up/down around entity (radians) ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_BODY_HEADING, DtIGNORE_PITCH, DtIGNORE_PRIMARY_ID, DtIGNORE_RADIUS, send(), DtCompassVCPdu::setAttachId(), DtCompassVCPdu::setBodyHeading(), DtStealthControlPdu::setIgnoreFlags(), DtCompassVCPdu::setPitch(), and DtCompassVCPdu::setRadius().

Referenced by setMode().

void DtStealthRemoteController::setMimicMode ( const DtGlobalObjectDesignator *  primary = NULL,
const DtVector *  offset = NULL 
) const
virtual

Change the current view mode to Mimic.

If any of the optional parameters are set, these values will be used to initialize the view: primary = id of primary entity offset = offset (in entity body coords) from the primary entity ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_FORWARD, DtIGNORE_PRIMARY_ID, DtIGNORE_RIGHT, DtIGNORE_UP, send(), DtMimicVCPdu::setAttachId(), DtStealthControlPdu::setIgnoreFlags(), and DtMimicVCPdu::setOffset().

Referenced by setMode().

void DtStealthRemoteController::setOrbitMode ( const DtGlobalObjectDesignator *  primary = NULL,
const float *  radius = NULL,
const float *  azimuth = NULL,
const float *  elevation = NULL,
const float *  azimuthRate = NULL 
) const
virtual

Change the current view mode to Orbit.

If any of the optional parameters are set, these values will be used to initialize the view: primary = id of primary entity radius = distance from center of the primary object azimuth = angle to move left/right around entity (radians) elevation = angle to move up/down around entity (radians) velocity = speed to travel left/right around the entity ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_AZIMUTH_RATE, DtIGNORE_HEADING, DtIGNORE_PITCH, DtIGNORE_PRIMARY_ID, DtIGNORE_RADIUS, send(), DtOrbitVCPdu::setAttachId(), DtOrbitVCPdu::setAzimuthRate(), DtOrbitVCPdu::setHeading(), DtStealthControlPdu::setIgnoreFlags(), DtOrbitVCPdu::setPitch(), and DtOrbitVCPdu::setRadius().

Referenced by setMode().

void DtStealthRemoteController::setTetherMode ( const DtGlobalObjectDesignator *  primary = NULL,
const DtVector *  offset = NULL,
const DtTaitBryan *  ori = NULL 
) const
virtual

Change the current view mode to Tether.

If any of the optional parameters are set, these values will be used to initialize the view: primary = id of primary entity offset = offset (in body coords) from center of the primary object ori = orientation (in body coords) relative to the orientation of the object ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_EAST_OFFSET, DtIGNORE_HEADING, DtIGNORE_HEIGHT_OFFSET, DtIGNORE_NORTH_OFFSET, DtIGNORE_PITCH, DtIGNORE_PRIMARY_ID, DtIGNORE_ROLL, send(), DtTetherVCPdu::setAttachId(), DtStealthControlPdu::setIgnoreFlags(), DtTetherVCPdu::setOrientation(), and DtTetherVCPdu::setTopoUpOffset().

Referenced by setMode().

void DtStealthRemoteController::setTrackMode ( const DtGlobalObjectDesignator *  primary = NULL,
const DtVector *  geoc = NULL 
) const
virtual

Change the current view mode to Track.

If any of the optional parameters are set, these values will be used to initialize the view: primary = id of primary entity geoc = start position (in geocentric coords) ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_EAST, DtIGNORE_HEIGHT, DtIGNORE_NORTH, DtIGNORE_PRIMARY_ID, send(), DtStealthControlPdu::setIgnoreFlags(), DtTrackVCPdu::setTrackId(), and DtTrackVCPdu::setWorldLocation().

Referenced by setMode().

void DtStealthRemoteController::setMimicTrackMode ( const DtGlobalObjectDesignator *  attach = NULL,
const DtGlobalObjectDesignator *  track = NULL,
const DtVector *  offset = NULL 
) const
virtual

Change the current view mode to MimicTrack.

If any of the optional parameters are set, these values will be used to initialize the view: attach = id of primary entity (view looks from this entity) track = id of secondary entity (view looks at this entity) offset = offset (in body coords) from the center of the primary entity ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_EAST, DtIGNORE_HEIGHT, DtIGNORE_NORTH, DtIGNORE_PRIMARY_ID, DtIGNORE_SECONDARY_ID, send(), DtMimicTrackVCPdu::setAttachId(), DtStealthControlPdu::setIgnoreFlags(), DtMimicTrackVCPdu::setOffset(), and DtMimicTrackVCPdu::setTrackId().

Referenced by setMode().

void DtStealthRemoteController::setTetherTrackMode ( const DtGlobalObjectDesignator *  attach = NULL,
const DtGlobalObjectDesignator *  track = NULL,
const DtVector *  offset = NULL 
) const
virtual

Change the current view mode to TetherTrack.

If any of the optional parameters are set, these values will be used to initialize the view: attach = id of primary entity (view looks from this entity) track = id of secondary entity (view looks at this entity) offset = offset (in body coords) from the center of the primary entity ; otherwise, the view with adopt the state from the last view.

References DtIGNORE_FORWARD, DtIGNORE_PRIMARY_ID, DtIGNORE_RIGHT, DtIGNORE_SECONDARY_ID, DtIGNORE_UP, send(), DtTetherTrackVCPdu::setAttachId(), DtStealthControlPdu::setIgnoreFlags(), DtTetherTrackVCPdu::setOffset(), and DtTetherTrackVCPdu::setTrackId().

Referenced by setMode().

void DtStealthRemoteController::send ( const DtStealthControlPdu pdu) const
virtual

Member Data Documentation

const DtGlobalObjectDesignator DtStealthRemoteController::SEND_TO_ALL = "0:0:0"
static

Returns a wild-card designator Id.

DtGlobalObjectDesignator DtStealthRemoteController::myId
protected

Referenced by controllerId(), and setControllerId().

DtGlobalObjectDesignator DtStealthRemoteController::myTargetId
protected
DtExerciseConn* DtStealthRemoteController::myExConn
protected
DtCustomRemoteControlSender* DtStealthRemoteController::mySender
protected

Referenced by send().

bool DtStealthRemoteController::myCreatedExConn
protected

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


Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)