VR-Vantage 1.4.1 API Class Documentation
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtStealthRemoteController Class Reference

List of all members.

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 (int port, int exercise_id, int site_id, int application_num, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
 Constructors.
 DtStealthRemoteController (int port, const DtInetAddr &destAddr, int exercise_id, int site_id, int application_num, const DtGlobalObjectDesignator &targetStealthId=SEND_TO_ALL)
 DtStealthRemoteController (DtInetSocket *skt, int exercise_id, int site_id, int application_num, 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 addViewModeChangeCallback (RemoteViewChangedCb fn, void *usr, const DtGlobalObjectDesignator &stealthid=SEND_TO_ALL)
 Set callback to be invoked when view mode changes (For the target stealth, mirroring must be enabled).
virtual void removeViewModeChangeCallback (RemoteViewChangedCb fn, void *usr, const DtGlobalObjectDesignator &stealthid=SEND_TO_ALL)
virtual void requestCurrentViewMode (const DtGlobalObjectDesignator &id=SEND_TO_ALL) const
 Request the current view mode (includes info about attached ents)
virtual void setPrimary (const DtGlobalObjectDesignator &id) const
 Modify the currently attached entities.
virtual void setSecondary (const DtGlobalObjectDesignator &id) const
virtual void setPrimarySecondary (const DtGlobalObjectDesignator &primary, const DtGlobalObjectDesignator &secondary) const
virtual void setGroup (const DtGlobalObjectDesignatorList &list) const
virtual void addToGroup (const DtGlobalObjectDesignatorList &list) const
virtual void removeFromGroup (const DtGlobalObjectDesignatorList &list) const
virtual void reset () const
 Reset the current view mode.
virtual void moveEyepoint (Direction d) const
virtual void turnEyepoint (Direction d) const
virtual void setStepsize (float stepsize) const
 Set the stepsize and turnrate stepsize = meters/sec turnrate = radians/sec.
virtual void setTurnrate (float turnrate) const
virtual void increaseStepsize () const
 Increase/Decrease the stepsize and turnrate using the Stealth's default increment.
virtual void increaseTurnrate () const
virtual void decreaseStepsize () const
virtual void decreaseTurnrate () 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 setTurretMode (const DtGlobalObjectDesignator *primary, const DtVector *offset) const
 Change the current view mode to Turret mode (aka OffsetMimic).
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 setPivotMode (const DtVector *pivotPt=NULL, const float *radius=NULL, const float *azimuth=NULL, const float *elevation=NULL) const
 Change the current view mode to Pivot.
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 setGroupMode (const DtGlobalObjectDesignatorList *grp=NULL, const float *radius=NULL, const float *azimuth=NULL, const float *elevation=NULL) const
 Change the current view mode to Group.
virtual void setWideGroupMode (const DtGlobalObjectDesignatorList *grp=NULL, const float *radius=NULL, const float *azimuth=NULL, const float *elevation=NULL) const
 Change the current view mode to WideGroup.
virtual void setOverlayEnabled (bool b) const
 Turn the stealth overlay on/off.
virtual void setSmoothing (DtSmoothingOption option) const
 Set how stealth smooths entities.
virtual void setSmoothingPeriod (double period) const
 Set the smoothing period.
virtual void setSoundEnabled (bool onOff) const
 Turn sound on/off.
virtual void setEntityLabelsEnabled (bool onOff) const
 Turn entity labels on/off.
virtual void setTrailingEffectsEnabled (bool onOff) const
 Turn trailing effects on/off.
virtual void setTrajectoryHistoriesEnabled (bool onOff) const
 Turn trajectory histories on/off.
virtual void setAggregateLevel (int level) const
 Set the aggregate level.
virtual void setAggregateHighestOnly (bool onOff) const
 Enable/disable whether nested aggregate members are shown.
virtual void setGroundClampingEnabled (bool onOff) const
 Turn ground clamping on/off.
virtual void setGroundClampRange (double range) const
 Set the ground clamp range.
virtual void setTimeOfDay (double time) const
 Set the time of day.
virtual void setNearClippingPlane (double clip) const
 Set the value for the near clipping plane.
virtual void setFarClippingPlane (double clip) const
 Set the value for the far clipping plane.
virtual void setVerticalFieldOfView (double fov) const
 Set the vertical fov.
virtual void setFogEnabled (bool onOff) const
 Turn fog on/off.
virtual void setDatabaseToLoad (const DtString &db) const
 Load the given database.
virtual void setDate (const DtString &str) const
 Set the date str = formatted date (MM/DD/YYYY)
virtual void exit ()
 Tell the stealth to exit.
virtual void setClouds (bool b)
 Toggle the clouds.
virtual void setSkyDome (bool b)
 Toggle the sky dome.
virtual void setMirrorMessageEveryFrame (bool b)
 Toggle mirroring the Stealth location every frame.
virtual void setMirroring (bool b)
 Toggle mirroring the Stealth location.
virtual void setBroadcasting (bool b)
 Toggle broadcasting the Stealth location.
virtual void setClusteringLabels (bool b)
 Toggle displaying the clustering labels.
virtual void setTacticalGraphicsLabels (bool b)
 Toggle displaying the tactical graphics labels.
virtual void setShowAggregates (bool b)
 Toggle displaying aggregates.
virtual void setShowEmitters (bool b)
 Toggle displaying emitters.
virtual void setXr (bool b)
 Toggle XR mode.
virtual void setHatLabels (bool b)
 Toggle height above terrain labels and lines (XR only)
virtual void setCurrentModelSet (const DtString &str)
 Set the current model set (XR only)
virtual void setNextModelSet ()
 Go to the next model set (XR only)
virtual void setPrevModelSet ()
 Go to the prev model set (XR only)
virtual void setCurrentTextureSet (const DtString &str)
 Set the current texture (XR only; valid for loaded MAP files only)
virtual void setNextTextureSet ()
 Show the next texture (XR only; valid for loaded MAP files only)
virtual void setPrevTextureSet ()
 Show the previous texture (XR only; valid for loaded MAP files only)
virtual void setTerrainScale (double s)
 Set the terrain scale (XR only)
virtual void setObjectScale (double s)
 Set the object scale (XR only)
virtual void startVideoRecording ()
 Start video capture using a generated file name based on capture directory, filenameBase, a timestamp, and .avi extension.
virtual void startVideoRecording (const DtString &filename)
 Start video capture to the file specified.
virtual void stopVideoRecording ()
 Stop video capture (no-op if not currently recording)
virtual void pauseVideoRecording ()
 Pause video capture (no-op if not recording or already paused)
virtual void unpauseVideoRecording ()
 Unpause video capture (no-op if video capture not currently paused)
virtual void setVideoCaptureRecordInsets (bool videoCaptureRecordInsets)
 Tell the stealth if it should record inset windows in addition to the main window.
virtual void setVideoCaptureFramesPerSecond (int videoCaptureFramesPerSecond)
 Specify the frame rate to use for video capture.
virtual void setVideoCaptureFilenameBase (const DtString &videoCaptureFilenameBase)
 Specify the filename base used for generated filenames ("MAK-Stealth" by default)
virtual void setVideoCaptureDirectory (const DtString &videoCaptureDirectory)
 specify the directory to use when generating a filename
virtual void setConstrainWithFloor (bool b)
 Toggle constraining view to view floor.
virtual void setFloor (double h)
 Set the height above the view floor to keep the eyepoint.
virtual void setConstrainViewToAll (bool b)
 Toggle constraining view to all database geometry.
virtual void setBlockedDistance (double d)
 Set the distance to stop before going through constraining geometry.
virtual void setUseNearClipForBlockedDistance (bool b)
 Use the near clipping plane as the blocked distance.
virtual void loadFeatures (const DtString &filename)
 Load a feature file.
virtual void clearFeatures ()
 clear all features loaded from feature files
virtual void setIgnoreCommandsSentFromUs (bool)
 Set to false to send callbacks out for commands sent by the originating stealth.
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 = DtEntityIdentifier::nullId()
 Returns a wild-card designator Id.

Protected Member Functions

virtual void processStealthControl (DtStealthControlInteraction *inter) const
virtual void sendGroupPdu (const DtGlobalObjectDesignatorList *grp, const float *radius, const float *azimuth, const float *elevation, int grpCmd) const

Static Protected Member Functions

static void processStealthControlCb (DtStealthControlInteraction *inter, void *usr)

Protected Attributes

DtGlobalObjectDesignator myId
DtGlobalObjectDesignator myTargetId
DtList * myViewChangedCbList
DtExerciseConn * myExConn
DtCustomRemoteControlSendermySender
bool myCreatedExConn
bool myIgnoreCommandsSentFromUs

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.

References myExConn, and processStealthControlCb().

DtStealthRemoteController::DtStealthRemoteController ( int  port,
int  exercise_id,
int  site_id,
int  application_num,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)

Constructors.

References myExConn, and processStealthControlCb().

DtStealthRemoteController::DtStealthRemoteController ( int  port,
const DtInetAddr &  destAddr,
int  exercise_id,
int  site_id,
int  application_num,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)
DtStealthRemoteController::DtStealthRemoteController ( DtInetSocket *  skt,
int  exercise_id,
int  site_id,
int  application_num,
const DtGlobalObjectDesignator &  targetStealthId = SEND_TO_ALL 
)
DtStealthRemoteController::~DtStealthRemoteController ( ) [virtual]

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 processStealthControl(), and send().

void DtStealthRemoteController::addViewModeChangeCallback ( RemoteViewChangedCb  fn,
void *  usr,
const DtGlobalObjectDesignator &  stealthid = SEND_TO_ALL 
) [virtual]

Set callback to be invoked when view mode changes (For the target stealth, mirroring must be enabled).

----------------------------------------------------- View Mode Control -----------------------------------------------------

References myViewChangedCbList.

void DtStealthRemoteController::removeViewModeChangeCallback ( RemoteViewChangedCb  fn,
void *  usr,
const DtGlobalObjectDesignator &  stealthid = SEND_TO_ALL 
) [virtual]
void DtStealthRemoteController::requestCurrentViewMode ( const DtGlobalObjectDesignator &  id = SEND_TO_ALL) const [virtual]

Request the current view mode (includes info about attached ents)

References send().

void DtStealthRemoteController::setPrimary ( const DtGlobalObjectDesignator &  id) const [virtual]
void DtStealthRemoteController::setSecondary ( const DtGlobalObjectDesignator &  id) const [virtual]
void DtStealthRemoteController::setPrimarySecondary ( const DtGlobalObjectDesignator &  primary,
const DtGlobalObjectDesignator &  secondary 
) const [virtual]
void DtStealthRemoteController::setGroup ( const DtGlobalObjectDesignatorList &  list) const [virtual]
void DtStealthRemoteController::addToGroup ( const DtGlobalObjectDesignatorList &  list) const [virtual]
void DtStealthRemoteController::removeFromGroup ( const DtGlobalObjectDesignatorList &  list) const [virtual]
void DtStealthRemoteController::reset ( ) const [virtual]

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::setStepsize ( float  stepsize) const [virtual]

Set the stepsize and turnrate stepsize = meters/sec turnrate = radians/sec.

References send(), and DtOptionsPdu::setStepsize().

void DtStealthRemoteController::setTurnrate ( float  turnrate) const [virtual]
void DtStealthRemoteController::increaseStepsize ( ) const [virtual]

Increase/Decrease the stepsize and turnrate using the Stealth's default increment.

References send(), and DtOptionsPdu::setIncrementStepsize().

void DtStealthRemoteController::increaseTurnrate ( ) const [virtual]
void DtStealthRemoteController::decreaseStepsize ( ) const [virtual]
void DtStealthRemoteController::decreaseTurnrate ( ) 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.

References DtViewerPivot, setAbsoluteMode(), setCompassMode(), setGroupMode(), setMimicMode(), setMimicTrackMode(), setOrbitMode(), setPivotMode(), 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::setTurretMode ( const DtGlobalObjectDesignator *  primary,
const DtVector *  offset 
) const [virtual]

Change the current view mode to Turret mode (aka OffsetMimic).

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 articulated part local 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().

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::setPivotMode ( const DtVector *  pivotPt = NULL,
const float *  radius = NULL,
const float *  azimuth = NULL,
const float *  elevation = NULL 
) const [virtual]

Change the current view mode to Pivot.

If any of the optional parameters are set, these values will be used to initialize the view: pivotPt = geocentric pivot position 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_EAST, DtIGNORE_HEIGHT, DtIGNORE_NORTH, DtIGNORE_PITCH, DtIGNORE_RADIUS, send(), DtPivotVCPdu::setBodyHeading(), DtStealthControlPdu::setIgnoreFlags(), DtPivotVCPdu::setPitch(), DtPivotVCPdu::setPivotPoint(), and DtPivotVCPdu::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::setGroupMode ( const DtGlobalObjectDesignatorList *  grp = NULL,
const float *  radius = NULL,
const float *  azimuth = NULL,
const float *  elevation = NULL 
) const [virtual]

Change the current view mode to Group.

If any of the optional parameters are set, these values will be used to initialize the view: grp = list of ids that compose the group radius = distance from center of the mass azimuth = angle to move left/right around entities (radians) elevation = angle to move up/down around entities (radians) ; otherwise, the view with adopt the state from the last view.

References DtCMD_GROUP, and sendGroupPdu().

Referenced by setMode().

void DtStealthRemoteController::setWideGroupMode ( const DtGlobalObjectDesignatorList *  grp = NULL,
const float *  radius = NULL,
const float *  azimuth = NULL,
const float *  elevation = NULL 
) const [virtual]

Change the current view mode to WideGroup.

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

References DtCMD_WIDE_GROUP, and sendGroupPdu().

void DtStealthRemoteController::setOverlayEnabled ( bool  b) const [virtual]

Turn the stealth overlay on/off.

----------------------------------------------------- Misc Options -----------------------------------------------------

References send(), and DtOptionsPdu::setOverlayOption().

void DtStealthRemoteController::setSmoothing ( DtSmoothingOption  option) const [virtual]

Set how stealth smooths entities.

References send(), and DtOptionsPdu::setSmoothing().

void DtStealthRemoteController::setSmoothingPeriod ( double  period) const [virtual]

Set the smoothing period.

References send(), and DtOptionsPdu::setSmoothingPeriod().

void DtStealthRemoteController::setSoundEnabled ( bool  onOff) const [virtual]

Turn sound on/off.

References send(), and DtOptionsPdu::setSound().

void DtStealthRemoteController::setEntityLabelsEnabled ( bool  onOff) const [virtual]

Turn entity labels on/off.

References send(), and DtOptionsPdu::setEntityLabels().

void DtStealthRemoteController::setTrailingEffectsEnabled ( bool  onOff) const [virtual]

Turn trailing effects on/off.

References send(), and DtOptionsPdu::setTrailingEffects().

void DtStealthRemoteController::setTrajectoryHistoriesEnabled ( bool  onOff) const [virtual]

Turn trajectory histories on/off.

References send(), and DtOptionsPdu::setTrajectoryHistory().

void DtStealthRemoteController::setAggregateLevel ( int  level) const [virtual]

Set the aggregate level.

References send(), and DtOptionsPdu::setAggregateLevel().

void DtStealthRemoteController::setAggregateHighestOnly ( bool  onOff) const [virtual]

Enable/disable whether nested aggregate members are shown.

References send(), and DtOptionsPdu::setAggregateHighestOnly().

void DtStealthRemoteController::setGroundClampingEnabled ( bool  onOff) const [virtual]

Turn ground clamping on/off.

References send(), and DtOptionsPdu::setGroundClamping().

void DtStealthRemoteController::setGroundClampRange ( double  range) const [virtual]

Set the ground clamp range.

References send(), and DtOptionsPdu::setClampRange().

void DtStealthRemoteController::setTimeOfDay ( double  time) const [virtual]

Set the time of day.

References send(), and DtOptionsPdu::setTimeOfDay().

void DtStealthRemoteController::setNearClippingPlane ( double  clip) const [virtual]

Set the value for the near clipping plane.

References send(), and DtOptionsPdu::setNearClip().

void DtStealthRemoteController::setFarClippingPlane ( double  clip) const [virtual]

Set the value for the far clipping plane.

References send(), and DtOptionsPdu::setFarClip().

void DtStealthRemoteController::setVerticalFieldOfView ( double  fov) const [virtual]

Set the vertical fov.

References send(), and DtOptionsPdu::setFov().

void DtStealthRemoteController::setFogEnabled ( bool  onOff) const [virtual]

Turn fog on/off.

References send(), and DtOptionsPdu::setFog().

void DtStealthRemoteController::setDatabaseToLoad ( const DtString &  db) const [virtual]

Load the given database.

References send(), and DtOptionsPdu::setDatabaseToLoad().

void DtStealthRemoteController::setDate ( const DtString &  str) const [virtual]

Set the date str = formatted date (MM/DD/YYYY)

References send(), and DtOptionsPdu::setDate().

void DtStealthRemoteController::exit ( ) [virtual]

Tell the stealth to exit.

References send(), and DtOptionsPdu::setExit().

void DtStealthRemoteController::setClouds ( bool  b) [virtual]

Toggle the clouds.

References send(), and DtOptionsPdu::setClouds().

void DtStealthRemoteController::setSkyDome ( bool  b) [virtual]

Toggle the sky dome.

References send(), and DtOptionsPdu::setSkyDome().

void DtStealthRemoteController::setMirrorMessageEveryFrame ( bool  b) [virtual]

Toggle mirroring the Stealth location every frame.

References send(), and DtOptionsPdu::setMirrorMessageEveryFrame().

void DtStealthRemoteController::setMirroring ( bool  b) [virtual]

Toggle mirroring the Stealth location.

References send(), and DtOptionsPdu::setMirroring().

void DtStealthRemoteController::setBroadcasting ( bool  b) [virtual]

Toggle broadcasting the Stealth location.

References send(), and DtOptionsPdu::setBroadcasting().

void DtStealthRemoteController::setClusteringLabels ( bool  b) [virtual]

Toggle displaying the clustering labels.

References send(), and DtOptionsPdu::setClusteringLabels().

void DtStealthRemoteController::setTacticalGraphicsLabels ( bool  b) [virtual]

Toggle displaying the tactical graphics labels.

References send(), and DtOptionsPdu::setTacticalGraphicsLabels().

void DtStealthRemoteController::setShowAggregates ( bool  b) [virtual]

Toggle displaying aggregates.

References send(), and DtOptionsPdu::setShowAggregates().

void DtStealthRemoteController::setShowEmitters ( bool  b) [virtual]

Toggle displaying emitters.

References send(), and DtOptionsPdu::setShowEmitters().

void DtStealthRemoteController::setXr ( bool  b) [virtual]

Toggle XR mode.

References send(), and DtOptionsPdu::setXr().

void DtStealthRemoteController::setHatLabels ( bool  b) [virtual]

Toggle height above terrain labels and lines (XR only)

References send(), and DtOptionsPdu::setHatLabels().

void DtStealthRemoteController::setCurrentModelSet ( const DtString &  str) [virtual]

Set the current model set (XR only)

References send(), and DtOptionsPdu::setCurrentModelSet().

void DtStealthRemoteController::setNextModelSet ( ) [virtual]

Go to the next model set (XR only)

References send(), and DtOptionsPdu::setShowNextModelSet().

void DtStealthRemoteController::setPrevModelSet ( ) [virtual]

Go to the prev model set (XR only)

References send(), and DtOptionsPdu::setShowPrevModelSet().

void DtStealthRemoteController::setCurrentTextureSet ( const DtString &  str) [virtual]

Set the current texture (XR only; valid for loaded MAP files only)

References send(), and DtOptionsPdu::setCurrentTextureSet().

void DtStealthRemoteController::setNextTextureSet ( ) [virtual]

Show the next texture (XR only; valid for loaded MAP files only)

References send(), and DtOptionsPdu::setShowNextTextureSet().

void DtStealthRemoteController::setPrevTextureSet ( ) [virtual]

Show the previous texture (XR only; valid for loaded MAP files only)

References send(), and DtOptionsPdu::setShowPrevTextureSet().

void DtStealthRemoteController::setTerrainScale ( double  s) [virtual]

Set the terrain scale (XR only)

References send(), and DtOptionsPdu::setTerrainScale().

void DtStealthRemoteController::setObjectScale ( double  s) [virtual]

Set the object scale (XR only)

References send(), and DtOptionsPdu::setObjectScale().

void DtStealthRemoteController::startVideoRecording ( ) [virtual]

Start video capture using a generated file name based on capture directory, filenameBase, a timestamp, and .avi extension.

References DtOptionsPdu::Record, send(), and DtOptionsPdu::setVideoCaptureCommand().

void DtStealthRemoteController::startVideoRecording ( const DtString &  filename) [virtual]
void DtStealthRemoteController::stopVideoRecording ( ) [virtual]

Stop video capture (no-op if not currently recording)

References send(), DtOptionsPdu::setVideoCaptureCommand(), and DtOptionsPdu::Stop.

void DtStealthRemoteController::pauseVideoRecording ( ) [virtual]

Pause video capture (no-op if not recording or already paused)

References DtOptionsPdu::Pause, send(), and DtOptionsPdu::setVideoCaptureCommand().

void DtStealthRemoteController::unpauseVideoRecording ( ) [virtual]

Unpause video capture (no-op if video capture not currently paused)

References send(), DtOptionsPdu::setVideoCaptureCommand(), and DtOptionsPdu::Unpause.

void DtStealthRemoteController::setVideoCaptureRecordInsets ( bool  videoCaptureRecordInsets) [virtual]

Tell the stealth if it should record inset windows in addition to the main window.

References send(), and DtOptionsPdu::setVideoCaptureRecordInsets().

void DtStealthRemoteController::setVideoCaptureFramesPerSecond ( int  videoCaptureFramesPerSecond) [virtual]

Specify the frame rate to use for video capture.

References send(), and DtOptionsPdu::setVideoCaptureFramesPerSecond().

void DtStealthRemoteController::setVideoCaptureFilenameBase ( const DtString &  videoCaptureFilenameBase) [virtual]

Specify the filename base used for generated filenames ("MAK-Stealth" by default)

References send(), and DtOptionsPdu::setVideoCaptureFilenameBase().

void DtStealthRemoteController::setVideoCaptureDirectory ( const DtString &  videoCaptureDirectory) [virtual]

specify the directory to use when generating a filename

References send(), and DtOptionsPdu::setVideoCaptureDirectory().

void DtStealthRemoteController::setConstrainWithFloor ( bool  b) [virtual]

Toggle constraining view to view floor.

References send(), and DtOptionsPdu::setConstrainWithFloor().

void DtStealthRemoteController::setFloor ( double  h) [virtual]

Set the height above the view floor to keep the eyepoint.

References send(), and DtOptionsPdu::setFloor().

void DtStealthRemoteController::setConstrainViewToAll ( bool  b) [virtual]

Toggle constraining view to all database geometry.

References send(), and DtOptionsPdu::setConstrainToAll().

void DtStealthRemoteController::setBlockedDistance ( double  d) [virtual]

Set the distance to stop before going through constraining geometry.

References send(), and DtOptionsPdu::setBlockedDistance().

void DtStealthRemoteController::setUseNearClipForBlockedDistance ( bool  b) [virtual]

Use the near clipping plane as the blocked distance.

References send(), and DtOptionsPdu::setUseNearClipForBlockedDistance().

void DtStealthRemoteController::loadFeatures ( const DtString &  filename) [virtual]
void DtStealthRemoteController::clearFeatures ( ) [virtual]

clear all features loaded from feature files

References DtOptionsPdu::FeatureClear, send(), and DtOptionsPdu::setFeatureCommand().

void DtStealthRemoteController::setIgnoreCommandsSentFromUs ( bool  b) [virtual]

Set to false to send callbacks out for commands sent by the originating stealth.

By default originating stealth ignores it's own reflected commands

References myIgnoreCommandsSentFromUs.

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

Use this function to send a stealth control PDU directly.

References controllerId(), myExConn, mySender, DtCustomRemoteControlSender::send(), DtStealthControlPdu::senderId(), targetStealthId(), and DtStealthControlPdu::viewerId().

Referenced by addToGroup(), clearFeatures(), decreaseStepsize(), decreaseTurnrate(), exit(), increaseStepsize(), increaseTurnrate(), loadFeatures(), moveEyepoint(), pauseVideoRecording(), removeFromGroup(), requestCurrentViewMode(), reset(), sendGroupPdu(), set(), setAbsoluteMode(), setAggregateHighestOnly(), setAggregateLevel(), setBlockedDistance(), setBroadcasting(), setClouds(), setClusteringLabels(), setCompassMode(), setConstrainViewToAll(), setConstrainWithFloor(), setCurrentModelSet(), setCurrentTextureSet(), setDatabaseToLoad(), setDate(), setEntityLabelsEnabled(), setFarClippingPlane(), setFloor(), setFogEnabled(), setGroundClampingEnabled(), setGroundClampRange(), setGroup(), setHatLabels(), setMimicMode(), setMimicTrackMode(), setMirroring(), setMirrorMessageEveryFrame(), setNearClippingPlane(), setNextModelSet(), setNextTextureSet(), setObjectScale(), setOrbitMode(), setOverlayEnabled(), setPivotMode(), setPrevModelSet(), setPrevTextureSet(), setPrimary(), setPrimarySecondary(), setSecondary(), setShowAggregates(), setShowEmitters(), setSkyDome(), setSmoothing(), setSmoothingPeriod(), setSoundEnabled(), setStepsize(), setTacticalGraphicsLabels(), setTerrainScale(), setTetherMode(), setTetherTrackMode(), setTimeOfDay(), setTrackMode(), setTrailingEffectsEnabled(), setTrajectoryHistoriesEnabled(), setTurnrate(), setTurretMode(), setUseNearClipForBlockedDistance(), setVerticalFieldOfView(), setVideoCaptureDirectory(), setVideoCaptureFilenameBase(), setVideoCaptureFramesPerSecond(), setVideoCaptureRecordInsets(), setXr(), startVideoRecording(), stopVideoRecording(), turnEyepoint(), and unpauseVideoRecording().

void DtStealthRemoteController::processStealthControlCb ( DtStealthControlInteraction *  inter,
void *  usr 
) [static, protected]
void DtStealthRemoteController::processStealthControl ( DtStealthControlInteraction *  inter) const [protected, virtual]
void DtStealthRemoteController::sendGroupPdu ( const DtGlobalObjectDesignatorList *  grp,
const float *  radius,
const float *  azimuth,
const float *  elevation,
int  grpCmd 
) const [protected, virtual]

Member Data Documentation

const DtGlobalObjectDesignator DtStealthRemoteController::SEND_TO_ALL = DtEntityIdentifier::nullId() [static]

Returns a wild-card designator Id.

Referenced by processStealthControl().

DtGlobalObjectDesignator DtStealthRemoteController::myId [protected]

Referenced by controllerId(), and setControllerId().

DtGlobalObjectDesignator DtStealthRemoteController::myTargetId [protected]
DtExerciseConn* DtStealthRemoteController::myExConn [protected]

Referenced by send().


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


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