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

Public Member Functions

 DtVrfPropManipulationHandler (makVrv::DtDe &)
virtual ~DtVrfPropManipulationHandler ()
virtual void slot_onPlace (makVrv::DtUniqueID, const DtVector &location, double altAboveGround)
virtual HandlerType type () const
 The type of handler. Used to see if two handler are equivalent.
virtual void restore ()
virtual void setHeading (DtVrfObjectFacadeInterface *objectImage, double heading)
virtual bool canEmbark () const
 Returns true as to whether or not this item can even be allowed to embark in general.
- Public Member Functions inherited from makVrf::DtVrfEntityManipulationHandler
 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
virtual void setExtendedLabels (const std::map< int, DtString > &)
virtual bool clampAtClosestPolygonOnPlacement () const
 Return true to keep the placement at closest polygon level regardless of height above terrain. Default is false.
virtual bool canSetActivationTime () const
 Returns true if activation time can be set.
virtual bool needsEmbarkOnCheck () const
 Return true if this needs to check whether or not this object can embark on another object. Default is false.
- 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.
int force () const
virtual void setEventProcessingEnabled (bool value)
 Sets whether or not event processing is enabled. If not enable mouse events will not be handled.
virtual bool embarkationAllowed () const
 Returns whether or not embarkation by this object is allowed.
virtual void setEmbarkationAllowed (bool)
virtual void setCanEmbark (bool)
 Override setting of whether or not can embark by data.
virtual void setIgnoreNextLeftButtonRelease (bool b)
 Set to ignore the next left button release.
virtual void setEditStartedByDoubleClick (bool)
virtual
makVrv::DtIntersector::IntersectProperties 
intersectorPickMask () const
virtual DtUUID uuid () const
 Returns UUID of principal object image.
virtual void setInterfaceContentMessage (const std::string &name, const DtSimInterfaceContent &)
 Sets an interface content message to be sent during create.
virtual void removeInterfaceContentMessage (const std::string &)
const ContentMessagescontentMessages () const
virtual std::list
< DtSimInterfaceContent * > 
contentMessagesToList () const
virtual void sendContentMessages ()
virtual VrfObjectEditFacadeList objectFacades () const
 Returns all facades in this handler.
virtual void setAllowCreationOnMouseClick (bool flag)
virtual bool allowCreationOnMouseClick () const
virtual void setEventProcessor (DtVrfObjectManipulationEventProcessor *)
 Call before editing or creating to set the event processor.
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 int objectCount () const
 Returns the number of objects being edited.
virtual
DtVrfObjectFacadeInterface
createAndAddLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView=0)
 Calls createLocalRepresentation and adds the resultant facade into the myObjectFacades member.
virtual
DtVrfObjectFacadeInterface
createAndAddLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView *principalStateView)
virtual void setOverlay (const std::string &name)
virtual const std::string & overlay () const
virtual std::string defaultOverlayForCreatingObject () const
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 const std::map< int,
DtString > & 
extendedLabels () const
virtual void setExtendedDataMap (const std::map< std::string, std::string > &extendedData)
virtual void setExtendedDataMap (const std::map< DtString, DtString > &extendedData)
virtual const std::map
< std::string, std::string > & 
extendedDataMap () const
virtual void setExtendedData (const std::string &key, const std::string &value)
virtual void removeExtendedData (const std::string &key)
virtual std::string extendedData (const std::string &key) const
virtual void slot_onComplete ()
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 std::vector< makVrv::DtUniqueID > &ignore=std::vector< makVrv::DtUniqueID >()) 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 bool anchorMouseToOrigin () const
 If true (default is false) will anchor the position of the mouse to the origin of the object when editing.
virtual bool anchorPositionIsMouse () const
 If false (default is true) will have the anchor position be the principal object. By default it is the mouse position.
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 std::string value (const std::string &) const
virtual void addKeyword (const std::string &)
virtual void removeKeyword (const std::string &)
virtual bool waitingToStop () const
virtual void setEditingType (DtEditingType)
DtEditingType editingType () const
virtual void setEmbarkationInformation (makVrv::DtUniqueID, bool)
 Sets the embarkation information to use on creation/modification for attaching/detaching environmentals or embarking/disembarking entities.
virtual makVrv::DtUniqueID embarkedOn () const
virtual std::vector
< makVrv::DtElementID
ignoreList () const
 Returns the list of IDs current being used to prevent usage in intersections.
virtual std::vector
< makVrv::DtElementID
unifiedIgnoreList () const
 Unifies the ignoreList() with all tactical graphics.
virtual void slot_onAltitudeChanged (const DtVector &, double)
virtual void cancel ()
 Cancels any current work. Default calls slot_onCancel.
virtual void setFacadesVisible (bool)
 Sets whether or not facades are visible.
virtual bool noStyle () const
 Return true if the item should not show the style button.
virtual void slot_onHeadingChanged (double heading)
virtual void setHeadingOffset (double d)
 Sets the heading offset from principal – changing the heading without changing the originakl heading.
virtual void disconnectPlacement ()
 Disconnects signal for placing when editing.
virtual void setGroundClampOnPlacement (bool)
 If altitude setting is not allowed, whether or not it should be clamp on placement.
virtual bool groundClampOnPlacement () const
virtual void connectPlacement ()
 Connects signal for placing when editing.
virtual DtVector centerOfMass () const
 Returns center of mass of all objects created (in geocentric)
virtual DtVector sumOfAllLocations () const
 Returns the sum of all the locations of all the object items present in this handler.
virtual void updateOffsetsBasedOnMousePosition (const DtVector &centerOfMass, const DtGeodeticCoord &, bool usImagePoints=false)
 Reset objects based on new center.
virtual void setSignalOnMultiSelectionComplete (bool)
 Set signal on multi selection complete.
virtual void setKeywords (const std::string &)
 Sets the keywords for this handler.
virtual void setSelectionCount (int)
 Sets the count of items "selected".
virtual void parseKeywords (const std::string &)
 Setup keywords for this handler.
virtual bool warpMouseToOrigin () const
virtual void setWarpMouseToOrigin (bool)

Protected Member Functions

virtual void propDestroyed (const makVrv::DtProp &)
virtual bool createVrfObject ()
virtual void createTerrainProp (DtVector &geocPosition)
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView=0)
 returns true if successful, false otherwise
virtual void postCreateInitialize (DtVrfObjectFacadeInterface *)
virtual void editSelectedObjects (const makVrv::DtUniqueID &principalID, makVrv::DtChannel &initiatingChannel, double waitTimeAfterComplete=0., const makVrv::DtSelectionManager::IdSet &editing=makVrv::DtSelectionManager::IdSet())
 Starts the process of object editing.
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (const makVrv::DtUniqueID &)
virtual void slot_onCancel (bool escPressed)
virtual bool modifyVrfObjects ()
virtual void initializeEventProcessor ()
virtual void initializeEdit ()
 Initializes editing of objects.
virtual void setObjectImageAsAnchor (DtVrfObjectFacadeInterface *objectImage, const DtVector &geocLocation, bool resetOrigin)
- Protected Member Functions inherited from makVrf::DtVrfEntityManipulationHandler
virtual void initializeAltitudeAboveTerrainForEdit (double curAlt, const DtVector &curPos, DtVrfObjectFacadeInterface *iFace)
virtual void updateOffsetsBasedOnMousePosition ()
 Update interface to show altitude in multi-selection mode if the entity is of a type that can change it's altitude and allow altitude change for all items if all items have altitude displayed.
virtual void collectionVisualized (DtVrfObjectFacadeInterface *)
virtual bool createVrfObject (DtVrfObjectFacadeInterface *)
 Called to create an object at the current location, heading, and altitude stored in the internal variables.
virtual void initializeInterfaceForEdit (DtVrfObjectFacadeInterface *iFace, makVrv::DtUniqueID sceneObjectId, const makVrv::DtVrlinkSimulatedBaseState &editState, const DtVector &principalLocation, const DtTaitBryan &principalOrientation)
virtual bool modifyVrfObject (DtVrfObjectFacadeInterface *)
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView *principalStateView)
virtual void randomlyChooseDIGuyAppearance (const DtRwNLengthStringVector &, DtEntityFacadeCollection *)
virtual void randomlyChooseDIGuyHandItem (const DtRwNLengthStringVector &, DtEntityFacadeCollection *)
virtual DtIfEmbarkObjectcreateEmbarkObjectMessage (const DtVector &geocentricEmbarkeePosition) const
virtual double defaultAltitudeOffsetFor (DtVrfObjectFacadeInterface *) const
 Given an object image, return the default bounding volume offset for that image.
- 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 std::string stripNumbers (const std::string &base) const
virtual void warpMouseToLocation (makVrv::DtChannel *channel, const DtVector &location) const
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 std::string defaultOverlayFor (const DtRwNLengthStringVector &) const
virtual void setObjectImageRelativeToPrincipal (DtVrfObjectFacadeInterface *objectImage, const DtVector &thisGeocLocation, const DtTaitBryan &thisGeocOrientation, const DtVector &prGeocLocation, const DtTaitBryan &prGeocOrientation)
virtual void setObjectImageRelativeTo (DtVrfObjectFacadeInterface *objectImage, const DtVector &thisGeocLocation, const DtVector &prGeocLocation, bool relativeOnly=false)
 If relativeOnly is true, do not set new origin – only set the fact that the image is relate to the prGeocLocation given.
virtual void setObjectImageRelativeToAltitudeOnly (DtVrfObjectFacadeInterface *objectImage, const DtVector &thisGeocLocation, const DtVector &prGeocLocation)
 Sets relative by altitude on – x/y location is the same.
virtual void calculateAnchor (const DtVector &localAnchor)
virtual void calculateAnchorBasedOnMousePosition (makVrv::DtChannel &channel)
virtual bool clampOnPlacement () const
 Return true to clamp object to closest polygon when placed on terrain regardless of altitude set.

Additional Inherited Members

- Public Types inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
typedef std::vector
< DtVrfObjectFacadeInterface * > 
VrfObjectEditFacadeList
typedef std::map< std::string,
DtSimInterfaceContent * > 
ContentMessages
- Public Attributes inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
boost::signal< void(bool)> signal_embarkationAllowedChanged
 Signal emitted when the embarkation allowed state changes.
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(DtVrfObjectManipulationHandlerBaseClass *)> signal_multiSelectonCreationComplete
 If flag is set to signal this, signals when the creation of all objects for a multi-select is complete.
boost::signal< void(bool)> signal_altitudeAllowedChanged
 signal sent when altitude allowed changes
boost::signal< void(const
ObjectManipulationData &)> 
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 Types inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
typedef std::map
< DtVrlinkSimulatedBaseStateView
*, makVrv::DtSignalConnectionManager * > 
StateViewConnections
- Protected Attributes inherited from makVrf::DtVrfEntityManipulationHandler
DtRwDIGuyCharacterInfo myDIGuyCharacterInformation

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void makVrf::DtVrfPropManipulationHandler::slot_onPlace ( makVrv::DtUniqueID  ,
const DtVector location,
double  altAboveGround 
)
virtual
virtual HandlerType makVrf::DtVrfPropManipulationHandler::type ( ) const
inlinevirtual

The type of handler. Used to see if two handler are equivalent.

Reimplemented from makVrf::DtVrfEntityManipulationHandler.

References makVrf::Prop.

virtual void makVrf::DtVrfPropManipulationHandler::restore ( )
virtual
virtual void makVrf::DtVrfPropManipulationHandler::setHeading ( DtVrfObjectFacadeInterface objectImage,
double  heading 
)
virtual
virtual bool makVrf::DtVrfPropManipulationHandler::canEmbark ( ) const
virtual

Returns true as to whether or not this item can even be allowed to embark in general.

This is different than the embarkationAllowed() flag in that this will control whether or not the entity is even given the chance to embark vs. whether or not the entity can embark on the entity that it is currently over

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual void makVrf::DtVrfPropManipulationHandler::propDestroyed ( const makVrv::DtProp )
protectedvirtual
virtual bool makVrf::DtVrfPropManipulationHandler::createVrfObject ( )
protectedvirtual
virtual void makVrf::DtVrfPropManipulationHandler::createTerrainProp ( DtVector geocPosition)
protectedvirtual
virtual DtVrfObjectFacadeInterface* makVrf::DtVrfPropManipulationHandler::createLocalRepresentation ( DtVrlinkSimulatedBaseStateView editStateView = 0)
protectedvirtual

returns true if successful, false otherwise

Reimplemented from makVrf::DtVrfEntityManipulationHandler.

virtual void makVrf::DtVrfPropManipulationHandler::postCreateInitialize ( DtVrfObjectFacadeInterface )
protectedvirtual
virtual void makVrf::DtVrfPropManipulationHandler::editSelectedObjects ( const makVrv::DtUniqueID editId,
makVrv::DtChannel initiatingChannel,
double  waitTimeAfterComplete = 0.,
const makVrv::DtSelectionManager::IdSet editing = makVrv::DtSelectionManager::IdSet() 
)
protectedvirtual

Starts the process of object editing.

Wait time after complete is how long to "wait" until showing hidden objects. This is to account for a bit of time taken to process result from back-end and prevent possible "jump" of object on move.

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual DtVrfObjectFacadeInterface* makVrf::DtVrfPropManipulationHandler::createLocalRepresentation ( const makVrv::DtUniqueID )
protectedvirtual
virtual void makVrf::DtVrfPropManipulationHandler::slot_onCancel ( bool  escPressed)
protectedvirtual
virtual bool makVrf::DtVrfPropManipulationHandler::modifyVrfObjects ( )
protectedvirtual
virtual void makVrf::DtVrfPropManipulationHandler::initializeEventProcessor ( )
protectedvirtual
virtual void makVrf::DtVrfPropManipulationHandler::initializeEdit ( )
protectedvirtual

Initializes editing of objects.

Override to change default assumptions on allowing altitude and heading changes

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual void makVrf::DtVrfPropManipulationHandler::setObjectImageAsAnchor ( DtVrfObjectFacadeInterface objectImage,
const DtVector geocLocation,
bool  resetOrigin 
)
protectedvirtual

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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)