makVrf::DtEntityCopyObject Class Reference

Inheritance diagram for makVrf::DtEntityCopyObject:

Public Member Functions
	DtEntityCopyObject (makVrv::DtDe &)
virtual	~DtEntityCopyObject ()
virtual DtGeodeticCoord	calculateCenter () const
	Returns the center of the object in geocentric coordinates.
virtual void	createFacade ()
	Creates the facade that will be used to display a temp item during paste operation.
virtual void	setOrigin (const DtGeodeticCoord &)
	Should shift (rather than absolute location set) points by amount specified.
virtual DtVector	pasteOrigin () const
	Origin at which to paste the object. Will take into account offsets (if they exist)
virtual DtVector	origin () const
	If facade is available, returns the origin of the facade, else returns center(). Returns in local coordinates.
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.
virtual void	read (const std::string &buf)
	Reads data from the buffer.
const std::string &	name () const
virtual void	setAltitudeClampType (DtAltitudeClampType)
	Sets the clamp type to used when calculating localLocation. Default is above terrain.
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.
virtual void	paste (const DtVector &, int flags=DtAllPasteFlags)
	Pastes object given the current information.
virtual DtGeodeticCoord	center () const
	Returns the center of the object in geocentric coordinates.
virtual DtVector	localCenter () const
virtual void	setGeometricCenter (const DtGeodeticCoord &)
	Sets the center of all objects being painted (in geocentric as per center() call).
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.
virtual void	setUpdateDataBeforeCopy (bool)

Protected Member Functions
virtual void	write (std::ostringstream &str, const makVrv::DtVrlinkSimulatedBaseState *data, makVrv::DtUniqueID id)
	Writes data to stream.
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.
virtual void	read (std::istringstream &str, makVrv::DtVrlinkSimulatedBaseState *data)
	Reads data from stream.
virtual void	read (std::istringstream &str, makVrv::DtVrlinkSimulatedEntityState *data)
virtual void	read (std::istringstream &str, DtVrfObjectDataState *data)
	Reads vrf object data state.
virtual bool	copyOperationsPending () const
	Return true if copy operations are complete, else false will signal that there are other operations yet to be done.
virtual void	requestPlan ()
	Requests plan from back-end.
virtual void	processReceivedPlan (DtSimMessage *)
	Call back in response to receiving plan.
virtual void	cancel ()
	Cancels pending operations. If awaiting plan, unregisters callback.
virtual makVrv::DtVrlinkSimulatedBaseState *	createReadableStateData () const
	Creates state data that will be used to read into a readable buffer.
virtual std::string	copyPendingMessage () const
	Message that is describing what this object is waiting for as far as copying goes.
virtual DtVrfObjectFacadeInterface *	facade () const
	Returns the facade.
virtual bool	pasteComplete () const
	Returns true if paste operation is complete. Default is true.
virtual void	createObject (const DtVector &)
	Creates the object locally or on the network. The vector supplied is in geocentric.
virtual std::string	pastePendingMessage () const
	Message that is describing what this object is waiting for as far as copying goes.
virtual void	processObjectCreated (DtString, const DtEntityIdentifier &)
	Called in response to object being created.
virtual void	processPasteStep ()
	Called during tick, will process next step in the paste operation.
virtual void	sendRulesOfEngagement ()
	Called to send rules of engagement.
virtual void	sendPlan ()
	Sends plan for entity to back-end.
virtual DtEntityCreationData	entityCreationData (const DtVector &)
	Return entity creation data for this entity.
Protected Member Functions inherited from makVrf::DtCopyObject
virtual DtVrfObjectDataState *	createReadableObjectStateData () const
	Creates state data that will be used to read into a readable buffer.
virtual void	checkCopyComplete ()
	Checks whether or not the copy is complete, and, if it is, calls copyComplet()
virtual void	copyComplete ()
	Sends copied message with resultant copied string.
virtual bool	cancelComplete () const
	Returns true if cancel is complete.
virtual void	readComplete (std::istringstream &str)
	Called when reading of buffer for object is complete.
virtual void	checkPasteComplete ()
	Checks to see if paste operation is complete.
virtual int	generateRequestId ()
	Generates a request id to match our request.
virtual double	groundHeight (const DtVector &currentLocal) const
	Returns the height at the given local position.
virtual void	setupOffsets (const DtGeodeticCoord &)
	Sets up offsets from geometric center.
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.
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.
virtual DtVector	localLocation (const DtGeodeticCoord &, int) const
	Given an origin and an index, return local location as an offset from that origin.

Protected Attributes
bool	myAwaitingPlan
DtIfPlan *	myPlan
int	myAwaiting
int	myRequestId
DtEntityFacadeCollection *	myFacade
bool	myClampToGround
DtVector	myPosition
Protected Attributes inherited from makVrf::DtCopyObject
makVrv::DtDe &	myDe
std::ostringstream	myOutput
std::string	myName
int	myPasteFlags
DtVrfObjectDataState *	myReadableObjectStateData
makVrv::DtVrlinkSimulatedBaseState *	myReadableStateData
DtGeodeticCoord	myCenter
CopyOffsets	myOffsets
HeightOffsets	myAltitudeAboveTerrain
HeightOffsets	myAltitudeAboveSeaLevel
DtAltitudeClampType	myAltitudeClampType
DtReferenceEllipsoid	myReferenceEllipsoid
int	myType
std::string	myBuffer
DtGeodeticCoord	myGeometricCenter
bool	myIsLocal
bool	myUpdateDataBeforeCopy

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,   DtAllPasteFlags = DtPasteNewName | DtPasteAppearance | DtPasteHeading | DtPasteEngagement | DtPastePlan | DtPasteAboveTerrain }
Public Attributes inherited from makVrf::DtCopyObject
boost::signal< void(DtCopyObject *)>	signal_copyCancelled
boost::signal< void(DtCopyObject *, const std::string &)>	signal_copied
boost::signal< void(DtCopyObject *, const std::string &)>	signal_copyOperationPending
boost::signal< void(DtCopyObject *)>	signal_pasted
boost::signal< void(DtCopyObject *, const std::string &)>	signal_pasteOperationPending
boost::signal< void(DtCopyObject *)>	signal_pasteCancelled
Protected Types inherited from makVrf::DtCopyObject
typedef std::vector< double >	HeightOffsets

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 ( )

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 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 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 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.

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/DtEntityCopyObject.h