VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrf::DtEntityCopyObject Class Reference
Inheritance diagram for makVrf::DtEntityCopyObject:
Inheritance graph
[legend]

Public Member Functions

 DtEntityCopyObject (makVrv::DtDe &)
 
virtual ~DtEntityCopyObject ()
 
virtual DtGeodeticCoord calculateCenter () const
 Returns the center of the object in geocentric coordinates. More...
 
virtual void createFacade (const DtGeodeticCoord &origin)
 Creates the facade that will be used to display a temp item during paste operation. More...
 
virtual void setOrigin (const DtGeodeticCoord &)
 Should shift (rather than absolute location set) points by amount specified. More...
 
virtual DtVector pasteOrigin () const
 Origin at which to paste the object. Will take into account offsets (if they exist) More...
 
virtual DtVector origin () const
 If facade is available, returns the origin of the facade, else returns center(). Returns in local coordinates. More...
 
virtual double groundHeight (const DtVector &currentLocal) const
 Returns the height at the given local position. More...
 
- Public Member Functions inherited from makVrf::DtCopyObject
 DtCopyObject (makVrv::DtDe &)
 
virtual ~DtCopyObject ()
 
virtual void copy (makVrv::DtSimEntry *)
 Starts copy process. Subclasses need to implement specific copy procedures. More...
 
virtual void read (const std::string &buf)
 Reads data from the buffer. More...
 
const std::string & name () const
 
const DtUUIDuuid () const
 
virtual void setAltitudeClampType (DtAltitudeClampType)
 Sets the clamp type to used when calculating localLocation. Default is above terrain. More...
 
DtAltitudeClampType altitudeClampType () const
 
void setType (int t)
 
int type () const
 
void setBuffer (const std::string &b)
 
const std::string & buffer () const
 
virtual bool preserveOffsets () const
 Returns true if offsets from origin should be preserved on paste. Default is false. More...
 
virtual void paste (const DtVector &, int flags=DtAllPasteFlags)
 Pastes object given the current information. More...
 
virtual DtGeodeticCoord center () const
 Returns the center of the object in geocentric coordinates. More...
 
virtual DtVector localCenter () const
 
virtual void setGeometricCenter (const DtGeodeticCoord &)
 Sets the center of all objects being painted (in geocentric as per center() call). More...
 
const DtGeodeticCoord & geometricCenter () const
 
const
makVrv::DtVrlinkSimulatedBaseState
readableStateData () const
 
virtual bool updateDataBeforeCopy () const
 Returns true as to whether or not to force a data update before copy. Default is false. More...
 
virtual void setUpdateDataBeforeCopy (bool)
 

Protected Member Functions

virtual bool canAdjustAltitude (const DtEntityType &) const
 Returns whether or not this item can have it's altitude adjusted. More...
 
virtual void write (std::ostringstream &str, const makVrv::DtVrlinkSimulatedBaseState *data, makVrv::DtUniqueID id)
 Writes data to stream. More...
 
virtual void write (std::ostringstream &str, const makVrv::DtVrlinkSimulatedEntityState *data, makVrv::DtUniqueID id)
 
virtual void write (std::ostringstream &str, const DtVrfObjectDataState *data)
 Writes vrf object data state. More...
 
virtual void read (std::istringstream &str, makVrv::DtVrlinkSimulatedBaseState *data)
 Reads data from stream. More...
 
virtual void read (std::istringstream &str, makVrv::DtVrlinkSimulatedEntityState *data)
 
virtual void read (std::istringstream &str, DtVrfObjectDataState *data)
 Reads vrf object data state. More...
 
virtual bool copyOperationsPending () const
 Return true if copy operations are complete, else false will signal that there are other operations yet to be done. More...
 
virtual void requestPlan ()
 Requests plan from back-end. More...
 
virtual void processReceivedPlan (DtSimMessage *)
 Call back in response to receiving plan. More...
 
virtual void cancel ()
 Cancels pending operations. If awaiting plan, unregisters callback. More...
 
virtual
makVrv::DtVrlinkSimulatedBaseState
createReadableStateData () const
 Creates state data that will be used to read into a readable buffer. More...
 
virtual std::string copyPendingMessage () const
 Message that is describing what this object is waiting for as far as copying goes. More...
 
virtual
DtVrfObjectFacadeInterface
facade () const
 Returns the facade. More...
 
virtual void uuidChanged (const DtUUID &)
 Called when the UUID has changed for an object. If the new UUID is this object then it is also discovered. More...
 
virtual bool pasteComplete () const
 Returns true if paste operation is complete. Default is true. More...
 
virtual void createObject (const DtVector &)
 Creates the object locally or on the network. The vector supplied is in geocentric. More...
 
virtual std::string pastePendingMessage () const
 Message that is describing what this object is waiting for as far as copying goes. More...
 
virtual void processObjectCreated (DtString, const DtUUID &, const DtEntityIdentifier &)
 Called in response to object being created. More...
 
virtual void processPasteStep ()
 Called during tick, will process next step in the paste operation. More...
 
virtual void sendRulesOfEngagement ()
 Called to send rules of engagement. More...
 
virtual void sendPlan ()
 Sends plan for entity to back-end. More...
 
virtual DtEntityCreationData entityCreationData (const DtVector &)
 Return entity creation data for this entity. More...
 
virtual void processObjectDiscovered ()
 Called when the object that has just been created is fully discovered by the state view collection manager. More...
 
- Protected Member Functions inherited from makVrf::DtCopyObject
virtual DtVrfObjectDataStatecreateReadableObjectStateData () const
 Creates state data that will be used to read into a readable buffer. More...
 
virtual void checkCopyComplete ()
 Checks whether or not the copy is complete, and, if it is, calls copyComplet() More...
 
virtual void copyComplete ()
 Sends copied message with resultant copied string. More...
 
virtual bool cancelComplete () const
 Returns true if cancel is complete. More...
 
virtual void readComplete (std::istringstream &str)
 Called when reading of buffer for object is complete. More...
 
virtual void checkPasteComplete ()
 Checks to see if paste operation is complete. More...
 
virtual int generateRequestId ()
 Generates a request id to match our request. More...
 
virtual void setupOffsets (const DtGeodeticCoord &)
 Sets up offsets from geometric center. More...
 
virtual void slot_onStateViewUpdated (DtVrlinkSimulatedBaseStateView *state, makVrv::DtSimEntry *simEntry)
 
virtual DtVector offsetLocation (int, const DtVector &loc) const
 Returns the geocentric location of the point at offset location index offset by geocentric loc. More...
 
virtual DtGeodeticCoord calculateOffsetPoint (const DtGeodeticCoord &start, const DtGeodeticCoord &end, double &altAboveTerrain, double &altAboveSeaLevel) const
 Calculates an offset point based on the start and end positions. More...
 
virtual DtVector localLocation (const DtGeodeticCoord &, int) const
 Given an origin and an index, return local location as an offset from that origin. More...
 
virtual void forceUpdate (DtVrlinkSimulatedBaseStateView *stateView, makVrv::DtSimEntry *simEntry)
 

Protected Attributes

bool myAwaitingPlan
 
DtIfPlanmyPlan
 
int myAwaiting
 
int myRequestId
 
DtEntityFacadeCollectionmyFacade
 
bool myClampToGround
 
DtVector myPosition
 
unsigned int myCreateCallbackId
 
makVrv::DtSignalConnectionManager myAddedSignalManager
 
- Protected Attributes inherited from makVrf::DtCopyObject
makVrv::DtDemyDe
 
std::ostringstream myOutput
 
std::string myName
 
int myPasteFlags
 
DtVrfObjectDataStatemyReadableObjectStateData
 
makVrv::DtVrlinkSimulatedBaseStatemyReadableStateData
 
DtGeodeticCoord myCenter
 
CopyOffsets myOffsets
 
HeightOffsets myAltitudeAboveTerrain
 
HeightOffsets myAltitudeAboveSeaLevel
 
DtAltitudeClampType myAltitudeClampType
 
DtReferenceEllipsoid myReferenceEllipsoid
 
int myType
 
std::string myBuffer
 
DtGeodeticCoord myGeometricCenter
 
bool myIsLocal
 
bool myUpdateDataBeforeCopy
 
DtUUID myUUID
 
bool myUpdated
 
makVrv::DtSignalConnectionManager myStateViewConnections
 

Additional Inherited Members

- Public Types inherited from makVrf::DtCopyObject
enum  DtPasteFlags {
  DtPasteNewName = 0x00000001, DtPasteAppearance = 0x00000002, DtPasteHeading = 0x00000004, DtPasteEngagement = 0x00000008,
  DtPastePlan = 0x00000010, DtPasteAboveSeaLevel = 0x00000020, DtPasteAboveTerrain = 0x00000040, DtPasteFormation = 0x00000080,
  DtPasteStateProperties = 0x00000100, DtAllPasteFlags
}
 
- Public Attributes inherited from makVrf::DtCopyObject
boost::signals2::signal< void(DtCopyObject *)> signal_copyCancelled
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_copied
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_copyOperationPending
 
boost::signals2::signal< void(DtCopyObject *)> signal_pasted
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_pasteOperationPending
 
boost::signals2::signal< void(DtCopyObject *)> signal_pasteCancelled
 
- Protected Types inherited from makVrf::DtCopyObject
typedef std::vector< doubleHeightOffsets
 

Constructor & Destructor Documentation

makVrf::DtEntityCopyObject::DtEntityCopyObject ( makVrv::DtDe )
virtual makVrf::DtEntityCopyObject::~DtEntityCopyObject ( )
virtual

Member Function Documentation

virtual DtGeodeticCoord makVrf::DtEntityCopyObject::calculateCenter ( ) const
virtual

Returns the center of the object in geocentric coordinates.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::createFacade ( const DtGeodeticCoord &  origin)
virtual

Creates the facade that will be used to display a temp item during paste operation.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::setOrigin ( const DtGeodeticCoord &  )
virtual

Should shift (rather than absolute location set) points by amount specified.

Reimplemented from makVrf::DtCopyObject.

virtual DtVector makVrf::DtEntityCopyObject::pasteOrigin ( ) const
virtual

Origin at which to paste the object. Will take into account offsets (if they exist)

Reimplemented from makVrf::DtCopyObject.

virtual DtVector makVrf::DtEntityCopyObject::origin ( ) const
virtual

If facade is available, returns the origin of the facade, else returns center(). Returns in local coordinates.

Reimplemented from makVrf::DtCopyObject.

virtual double makVrf::DtEntityCopyObject::groundHeight ( const DtVector currentLocal) const
virtual

Returns the height at the given local position.

Reimplemented from makVrf::DtCopyObject.

virtual bool makVrf::DtEntityCopyObject::canAdjustAltitude ( const DtEntityType &  ) const
protectedvirtual

Returns whether or not this item can have it's altitude adjusted.

virtual void makVrf::DtEntityCopyObject::write ( std::ostringstream &  str,
const makVrv::DtVrlinkSimulatedBaseState data,
makVrv::DtUniqueID  id 
)
protectedvirtual

Writes data to stream.

Override to write own data, but, make sure to call parent method

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::write ( std::ostringstream &  str,
const makVrv::DtVrlinkSimulatedEntityState data,
makVrv::DtUniqueID  id 
)
protectedvirtual

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::write ( std::ostringstream &  str,
const DtVrfObjectDataState data 
)
protectedvirtual

Writes vrf object data state.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::read ( std::istringstream &  str,
makVrv::DtVrlinkSimulatedBaseState data 
)
protectedvirtual

Reads data from stream.

Override to read own data, but, make sure to call parent method

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::read ( std::istringstream &  str,
makVrv::DtVrlinkSimulatedEntityState data 
)
protectedvirtual

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::read ( std::istringstream &  str,
DtVrfObjectDataState data 
)
protectedvirtual

Reads vrf object data state.

Reimplemented from makVrf::DtCopyObject.

virtual bool makVrf::DtEntityCopyObject::copyOperationsPending ( ) const
protectedvirtual

Return true if copy operations are complete, else false will signal that there are other operations yet to be done.

Will return true if waiting for plan.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::requestPlan ( )
protectedvirtual

Requests plan from back-end.

When received, copies into stream and signals copy is complete

virtual void makVrf::DtEntityCopyObject::processReceivedPlan ( DtSimMessage )
protectedvirtual

Call back in response to receiving plan.

Calls processReceivedPlan if this plan is for us

virtual void makVrf::DtEntityCopyObject::cancel ( )
protectedvirtual

Cancels pending operations. If awaiting plan, unregisters callback.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual makVrv::DtVrlinkSimulatedBaseState* makVrf::DtEntityCopyObject::createReadableStateData ( ) const
protectedvirtual

Creates state data that will be used to read into a readable buffer.

Will persist until object is deleted

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual std::string makVrf::DtEntityCopyObject::copyPendingMessage ( ) const
protectedvirtual

Message that is describing what this object is waiting for as far as copying goes.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual DtVrfObjectFacadeInterface* makVrf::DtEntityCopyObject::facade ( ) const
inlineprotectedvirtual

Returns the facade.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtEntityCopyObject::uuidChanged ( const DtUUID )
protectedvirtual

Called when the UUID has changed for an object. If the new UUID is this object then it is also discovered.

virtual bool makVrf::DtEntityCopyObject::pasteComplete ( ) const
protectedvirtual

Returns true if paste operation is complete. Default is true.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::createObject ( const DtVector )
protectedvirtual

Creates the object locally or on the network. The vector supplied is in geocentric.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual std::string makVrf::DtEntityCopyObject::pastePendingMessage ( ) const
protectedvirtual

Message that is describing what this object is waiting for as far as copying goes.

Reimplemented from makVrf::DtCopyObject.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::processObjectCreated ( DtString  ,
const DtUUID ,
const DtEntityIdentifier &   
)
protectedvirtual

Called in response to object being created.

Will see if it is the one we pasted, then, continue on with pasting operation

virtual void makVrf::DtEntityCopyObject::processPasteStep ( )
protectedvirtual

Called during tick, will process next step in the paste operation.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::sendRulesOfEngagement ( )
protectedvirtual

Called to send rules of engagement.

virtual void makVrf::DtEntityCopyObject::sendPlan ( )
protectedvirtual

Sends plan for entity to back-end.

virtual DtEntityCreationData makVrf::DtEntityCopyObject::entityCreationData ( const DtVector )
protectedvirtual

Return entity creation data for this entity.

Reimplemented in makVrf::DtAggregateCopyObject.

virtual void makVrf::DtEntityCopyObject::processObjectDiscovered ( )
protectedvirtual

Called when the object that has just been created is fully discovered by the state view collection manager.

Member Data Documentation

bool makVrf::DtEntityCopyObject::myAwaitingPlan
protected
DtIfPlan* makVrf::DtEntityCopyObject::myPlan
protected
int makVrf::DtEntityCopyObject::myAwaiting
protected
int makVrf::DtEntityCopyObject::myRequestId
protected
DtEntityFacadeCollection* makVrf::DtEntityCopyObject::myFacade
protected
bool makVrf::DtEntityCopyObject::myClampToGround
protected
DtVector makVrf::DtEntityCopyObject::myPosition
protected
unsigned int makVrf::DtEntityCopyObject::myCreateCallbackId
protected
makVrv::DtSignalConnectionManager makVrf::DtEntityCopyObject::myAddedSignalManager
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)