VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Member Functions
makVrf::DtVrfEntityManipulationHandler Class Reference

Creation/edit of entity objects. More...

Inheritance diagram for makVrf::DtVrfEntityManipulationHandler:
Inheritance graph
[legend]

Public Member Functions

 DtVrfEntityManipulationHandler (makVrv::DtDe &)
virtual ~DtVrfEntityManipulationHandler ()
virtual void setForce (int f)
 Sets the force of the object.
virtual void setLabel (const std::string &)
 Sets label of item. Default is no-op.
virtual std::string label () const
- Public Member Functions inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
 DtVrfObjectManipulationHandlerBaseClass (makVrv::DtDe &)
virtual ~DtVrfObjectManipulationHandlerBaseClass ()
virtual bool createObject (const DtEntityType &entType, int force, DtCreationSignalType creationSignal=DtNoCreationSignal, const std::string &keywords="")
 Starts the process of object creation.
virtual bool createObject (const DtString &key, const DtString &associatedData, DtCreationSignalType creationSignal=DtNoCreationSignal, const std::string &keywords="")
 Starts the process of terrain prop creation.
virtual void editSelectedObjects (const makVrv::DtUniqueID &editId, makVrv::DtChannel &initiatingChannel, double waitTimeAfterComplete=0.)
 Starts the process of object editing.
int force () const
virtual void setAllowCreationOnMouseClick (bool flag)
virtual bool allowCreationOnMouseClick () const
virtual DtVector clampToGround (const DtVector &) const
virtual DtGeodeticCoord clampToGround (const DtGeodeticCoord &) const
virtual void setAttachObjectToMouse (bool)
virtual bool attachObjectToMouse () const
virtual void setHeading (double value)
virtual double heading () const
virtual void setLocation (const DtVector &loc)
virtual void setLocation (const DtVector &loc, double altAboveGround)
virtual void stop ()
 Stop an ongoing creation process.
virtual void deferredStop ()
 Stops on a post tick callback.
virtual void setOverlay (const std::string &name)
virtual std::string getNextCreatingName (bool includeCurrent=false)
virtual void setAltitudeAboveGL (double alt, bool setInProcessor=true)
virtual void setAltitudeAboveSL (double alt, bool setInProcessor=true)
virtual void setAltitudeClampType (DtAltitudeClampType type)
void setCreating (bool b)
bool creating () const
virtual
DtVrfObjectFacadeInterface
principalObjectImage () const
virtual makVrv::DtUniqueID principalObjectID () const
virtual void setUserData (const std::string &userData)
virtual const std::string & userData () const
virtual void slot_onComplete ()
virtual void slot_onPlace (makVrv::DtUniqueID, const DtVector &, double altAboveGround)
virtual void slot_onEditComplete (makVrv::DtUniqueID, const DtVector &, double altAboveGround)
virtual void slot_onLocationChanged (const DtVector &location, double altAboveGround)
virtual void slot_onAltitudeIsDragging (bool)
virtual void hideObject (const makVrv::DtUniqueID &id, bool hide)
virtual void setPublishObject (bool)
 Set whether or not to publish object. Default is true.
virtual bool publishObject () const
virtual void setObjectName (const std::string &name)
virtual bool isUniqueName () const
 Returns true if the specified name is unique as set.
virtual double groundHeight (const DtVector &localPosition, DtVector *localGround=0) const
 find the height of the ground (ENU coordinate system) at localPosition (DB coordinates).
virtual void setAltitudeAllowed (bool)
bool altitudeAllowed () const
virtual const std::string & objectName () const
virtual void setAnchorMouseToOrigin (bool)
 If true (default is false) will anchor the position of the mouse to the origin of the object when editing.
virtual bool anchorMouseToOrigin () const
virtual void setAnchorPositionIsMouse (bool)
 If false (default is true) will have the anchor position be the principal object. By default it is the mouse position.
virtual bool anchorPositionIsMouse () const
virtual DtVector localLocation ()
 location + altitude
virtual DtVector convertGeocentricToGround (const DtVector &geoc, double &altitude) const
virtual void setShowPropertiesDialogBeforeCreate (bool)
virtual bool showPropertiesDialogBeforeCreate () const
virtual bool keywordsContain (const std::string &) const
 Return true if the list of keywords contains the specified one.
virtual std::string keyword (const std::string &) const
virtual bool waitingToStop () const
virtual void cancel ()
 Cancels any current work. Default calls slot_onCancel.
virtual bool noStyle () const
 Return true if the item should not show the style button.

Protected Member Functions

virtual bool createVrfObject ()
 Called to create an object at the current location, heading, and altitude stored in the internal variables.
virtual bool createVrfObject (DtVrfObjectFacadeInterface *)
virtual bool modifyVrfObjects ()
virtual bool modifyVrfObjects (DtVrfObjectFacadeInterface *)
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView=0)
 returns true if successful, false otherwise
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView *principalStateView)
virtual void initializeEventProcessor ()
virtual void postCreateInitialize ()
- Protected Member Functions inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
virtual void slot_simObjectEntryToBeRemoved (const makVrv::DtSimObjectEntry &)
 Called when a sim object entry is removed. If we are editing this entry then cancel this process.
virtual bool typeIsValidForEditingByHandler (const makVrv::DtElementEntry::ElementType &, const DtEntityType &) const
 Override to not allow a particular element type to be editable. By default all are.
virtual void slot_onAltitudeChanged (const DtVector &, double)
virtual void slot_onHeadingChanged (double heading)
virtual void slot_onCancel ()
virtual std::string stripNumbers (const std::string &base) const
virtual void warpMouseToLocation (makVrv::DtChannel *channel, const DtVector &location) const
virtual void initializeEdit ()
 Initializes editing of objects.
virtual void slot_onPrincipalStateViewUpdated (DtVrlinkSimulatedBaseStateView *principalStateView, const makVrv::DtUniqueID &principalSceneObjectId)
virtual void slot_onStateViewUpdated (DtVrlinkSimulatedBaseStateView *editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView *principalStateView)
virtual bool centerOn (const makVrv::DtUniqueID &id, DtVector *centerPos=0, const DtVector *centerHere=0, bool centerOnOnlyIfMousePositionIsOffWindow=true) const
 If centerHere is non-null use that geocentric value as the center point.
virtual void setObjectImageAsAnchor (DtVrfObjectFacadeInterface *objectImage, const DtVector &geocLocation, bool resetOrigin=false)
virtual void setObjectImageRelativeToPrincipal (DtVrfObjectFacadeInterface *objectImage, const DtVector &thisGeocLocation, const DtTaitBryan &thisGeocOrientation, const DtVector &prGeocLocation, const DtTaitBryan &prGeocOrientation)
virtual void initializeInterfaceForEdit (DtVrfObjectFacadeInterface *, makVrv::DtUniqueID, const makVrv::DtVrlinkSimulatedBaseState &, const DtVector &principalLocation, const DtTaitBryan &principalOrientation)
virtual void calculateAnchor (const DtVector &localAnchor)
virtual void calculateAnchorBasedOnMousePosition (makVrv::DtChannel &channel)
virtual void parseKeywords (const std::string &)

Additional Inherited Members

- Public Types inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
typedef std::vector
< DtVrfObjectFacadeInterface * > 
VrfObjectEditFacadeList
- Public Attributes inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
boost::signal< void(bool)> signal_showPropertiesDialog
 There are some instances where a handler does not want to finish up when creating.
boost::signal< void(bool)> signal_attachObjectToMouse
 Signal sent when attached object to mouse changes.
boost::signal< void(DtVrfObjectFacadeInterface
*, DtVrlinkSimulatedBaseStateView
*editStateView)> 
signal_preVisualization
 Signal sent before any visualizers are created on the interface.
boost::signal< void(DtVrfObjectFacadeInterface
*, bool)> 
signal_objectFacadeCreated
 signal sent after the facade is created.
boost::signal< void(const
DtEntityType &, int)> 
signal_started
 Signaled when entity creation has started.
boost::signal< void(const
DtEntityType &, std::string,
int, const std::vector
< DtVector > &, double, bool,
bool, std::string, bool)> 
signal_createObject
 signal sent when object wants to be created
boost::signal< void(const
DtString &, const DtString &)> 
signal_createTerrainProp
 signal sent when prop wants to be created
boost::signal< void(DtVrfObjectManipulationHandlerBaseClass *)> signal_stopped
 Sent when entity creation has stopped.
boost::signal< void(DtVrfObjectManipulationHandlerBaseClass *)> signal_complete
 Sent when entity creation has completed (right-click)
boost::signal< void(const
DtVector &)> 
signal_locationChanged
 signal sent when the mouse changes location during creation/editing
boost::signal< void(double)> signal_headingChanged
 signal sent when the mouse changes the orientation of an object during creation/editing
boost::signal< void(double)> signal_altitudeChanged
 signal sent when the mouse changes the altitude of an object during creation/editing
boost::signal< void(const
DtVector &)> 
signal_placement
 signal sent when the left mouse is pressed during creation/editing
boost::signal< void(DtVrfObjectManipulationHandlerBaseClass *)> signal_restoreSelectionState
 Sent when the handler has been notified that its attribute changes (show) requests have been made, so selection state can be restored.
boost::signal< void(const
makVrv::DtUniqueID &)> 
signal_principalStateViewUpdated
 Sent when principal state view is updated for editing.
boost::signal< void(DtVrfObjectFacadeInterface *)> signal_objectFacadeAboutToBeRemoved
 Sent when object facade interface is about to be removed.
- Protected Attributes inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
bool myCreating
bool myAttachObjectToMouse
int myForce
makVrv::DtDe & myDe
bool mySignalManipulation
bool myAllowCreationOnClick
std::string myObjectName
std::string myOverlay
DtVrfObjectManipulationEventProcessormyEventProcessor
bool myAltitudeIsDragging
bool myAltitudeAllowed
makVrv::DtChannel * myHiddenChannel
std::string myUserData
std::string myKey
std::string myKeyData
DtCreationSignalType mySignalCreation
VrfObjectEditFacadeList myObjectImages
DtReferenceEllipsoid * myReferenceForConversion
DtAltitudeClampType myAltitudeClampType
bool myOverlayChanged
bool myShowPropertiesDialogBeforeCreate
DtGeodeticCoord myAnchorPosition
bool myAnchorMouseToOrigin
bool myAnchorPositionIsMouse
DtTimedSection * myDeferredStopTimer
double myTotalTimeElapsed
double myDeferStopFor
bool myPublishObject
std::vector< std::string > myKeywords
int myCursorCount

Detailed Description

Creation/edit of entity objects.

Constructor & Destructor Documentation

makVrf::DtVrfEntityManipulationHandler::DtVrfEntityManipulationHandler ( makVrv::DtDe &  )
virtual makVrf::DtVrfEntityManipulationHandler::~DtVrfEntityManipulationHandler ( )
virtual

Member Function Documentation

virtual void makVrf::DtVrfEntityManipulationHandler::setForce ( int  )
virtual

Sets the force of the object.

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual void makVrf::DtVrfEntityManipulationHandler::setLabel ( const std::string &  )
virtual

Sets label of item. Default is no-op.

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual std::string makVrf::DtVrfEntityManipulationHandler::label ( ) const
virtual
virtual bool makVrf::DtVrfEntityManipulationHandler::createVrfObject ( )
protectedvirtual

Called to create an object at the current location, heading, and altitude stored in the internal variables.

Implements makVrf::DtVrfObjectManipulationHandlerBaseClass.

Reimplemented in makVrf::DtVrfPropManipulationHandler.

virtual bool makVrf::DtVrfEntityManipulationHandler::createVrfObject ( DtVrfObjectFacadeInterface )
protectedvirtual
virtual bool makVrf::DtVrfEntityManipulationHandler::modifyVrfObjects ( )
protectedvirtual
virtual bool makVrf::DtVrfEntityManipulationHandler::modifyVrfObjects ( DtVrfObjectFacadeInterface )
protectedvirtual
virtual DtVrfObjectFacadeInterface* makVrf::DtVrfEntityManipulationHandler::createLocalRepresentation ( DtVrlinkSimulatedBaseStateView editStateView = 0)
protectedvirtual

returns true if successful, false otherwise

Implements makVrf::DtVrfObjectManipulationHandlerBaseClass.

Reimplemented in makVrf::DtVrfPropManipulationHandler.

virtual DtVrfObjectFacadeInterface* makVrf::DtVrfEntityManipulationHandler::createLocalRepresentation ( DtVrlinkSimulatedBaseStateView editStateView,
makVrv::DtUniqueID  sceneObjectId,
DtVrlinkSimulatedBaseStateView principalStateView 
)
protectedvirtual
virtual void makVrf::DtVrfEntityManipulationHandler::initializeEventProcessor ( )
protectedvirtual
virtual void makVrf::DtVrfEntityManipulationHandler::postCreateInitialize ( )
protectedvirtual

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)