![]() |
VR-Vantage 2.2 API Documentation
|
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 |
| DtCustomRemoteControlSender * | mySender |
| bool | myCreatedExConn |
| 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.
|
virtual |
References myCreatedExConn, and myExConn.
|
virtual |
Set/Get current target stealth (Can be DtEntityIdentifier::nullId)
References myTargetId.
|
virtual |
References myTargetId.
Referenced by send().
|
virtual |
Set/Get the controller id.
References myId.
|
virtual |
|
virtual |
Reset the current view mode
References send(), DtStealthControlPdu::setIgnoreFlags(), and DtMoveVCPdu::setReset().
|
virtual |
References DtIGNORE_STEP_CMD, send(), DtStealthControlPdu::setIgnoreFlags(), and DtMoveVCPdu::setMove().
|
virtual |
References DtIGNORE_TURN_CMD, send(), DtStealthControlPdu::setIgnoreFlags(), and DtMoveVCPdu::setTurn().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
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().
|
virtual |
Use this function to send a stealth control PDU directly.
References controllerId(), myExConn, mySender, DtCustomRemoteControlSender::send(), DtStealthControlPdu::senderId(), DtStealthControlInteraction::setVcPdu(), targetStealthId(), and DtStealthControlPdu::viewerId().
Referenced by moveEyepoint(), reset(), set(), setAbsoluteMode(), setCompassMode(), setMimicMode(), setMimicTrackMode(), setOrbitMode(), setTetherMode(), setTetherTrackMode(), setTrackMode(), and turnEyepoint().
|
static |
Returns a wild-card designator Id.
|
protected |
Referenced by controllerId(), and setControllerId().
|
protected |
Referenced by setTargetStealthId(), and targetStealthId().
|
protected |
Referenced by DtStealthRemoteController(), send(), and ~DtStealthRemoteController().
|
protected |
Referenced by send().
|
protected |
Referenced by ~DtStealthRemoteController().