Creation/edit of entity objects. More...

Inheritance diagram for makVrf::DtVrfDynamicTerrainSwitchHandler:

Public Member Functions
	DtVrfDynamicTerrainSwitchHandler (makVrv::DtDe &)
virtual	~DtVrfDynamicTerrainSwitchHandler ()
virtual HandlerType	type () const
	The type of handler. Used to see if two handler are equivalent.
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.
virtual bool	canEmbark () const
	Returns true as to whether or not this item can even be allowed to embark in general.
virtual bool	createVrfObject (DtVrfObjectFacadeInterface *)
	Called to create an object at the current location, heading, and altitude stored in the internal variables.
virtual bool	modifyVrfObject (DtVrfObjectFacadeInterface *)
virtual DtVrfObjectFacadeInterface *	createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView=0)
	returns true if successful, false otherwise
virtual void	initializeEventProcessor ()
virtual bool	canChangePositionOnly () const
virtual DtVrfObjectFacadeInterface *	createLocalRepresentation (DtVrlinkSimulatedBaseStateView editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView principalStateView)
virtual void	setLocationToSwitch (const DtVector &)
const DtVector &	locationToSwitch () const
Public Member Functions inherited from makVrf::DtVrfPointManipulationHandler
	DtVrfPointManipulationHandler (makVrv::DtDe &)
virtual	~DtVrfPointManipulationHandler ()
virtual bool	isTextBox () const
virtual void	setLabel (const std::string &)
	Sets label of item. Default is no-op.
virtual void	setExtendedLabels (const std::map< int, DtString > &)
virtual std::string	label () const
virtual void	setFormattingData (const std::string &)
virtual std::string	formattingData () const
virtual void	setForce (int)
	Sets the force of the object.
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., const makVrv::DtSelectionManager::IdSet &editing=makVrv::DtSelectionManager::IdSet())
	Starts the process of object editing.
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	setDoNotClamp (bool)
	Whether or not to clamp to any kind of polygon or just take the mouse position.
bool	doNotClamp () const
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 ContentMessages &	contentMessages () 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 bool	createVrfObject ()
virtual bool	modifyVrfObjects ()
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_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 void	setUUIDForCreation (const DtUUID &)
	In creation use this UUID to create.
virtual const DtUUID &	uuidForCreation () const
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 void	setAnchorPosition (const DtGeodeticCoord &)
	Sets the anchor 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 void	setOverrideIdsToIgnore (const std::vector< makVrv::DtUniqueID > &overrideIgnore)
	Set this list explicity to use to ignore rather than those calculated by this object facade.
virtual const std::vector < makVrv::DtElementID > &	unifiedIgnoreList () const
	Unifies the ignoreList() with all tactical graphics.
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	notifyOnFinalFacade (DtVrfObjectManipulationHandlerBaseClass *)
	When the final facade is removed because it is deleted notify this handler. If the handler says it is ok to cancel editing then continue on.
virtual void	removeNotifyOnFinalFacade (DtVrfObjectManipulationHandlerBaseClass *)
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 Attributes
DtVector	myLocationToSwitch

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_eventProcessorRemoved
	Sent when the event processor has been destroyed.
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.
boost::signal< void(int)>	signal_forceChanged
	Sent when force changed.
Protected Types inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
typedef std::map < DtVrlinkSimulatedBaseStateView , makVrv::DtSignalConnectionManager >	StateViewConnections
Protected Member Functions inherited from makVrf::DtVrfPointManipulationHandler
virtual DtEnvironmentalFacadeCollection *	createFacadeInterface ()
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	postCreateInitialize (DtVrfObjectFacadeInterface *)
virtual void	slot_onAltitudeChanged (const DtVector &v, double altitude)
	Set clamp to ground on placement as false if this changes. Means the user does want to place the object at some height above or below the terrain.
virtual void	initializeInterfaceForEdit (DtVrfObjectFacadeInterface *iFace, makVrv::DtUniqueID sceneObjectId, const makVrv::DtVrlinkSimulatedBaseState &editState, const DtVector &principalLocation, const DtTaitBryan &principalOrientation)

Detailed Description

Creation/edit of entity objects.

Constructor & Destructor Documentation

makVrf::DtVrfDynamicTerrainSwitchHandler::DtVrfDynamicTerrainSwitchHandler ( makVrv::DtDe & )

virtual makVrf::DtVrfDynamicTerrainSwitchHandler::~DtVrfDynamicTerrainSwitchHandler ( )

virtual

Member Function Documentation

virtual HandlerType makVrf::DtVrfDynamicTerrainSwitchHandler::type ( ) const

inlinevirtual

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

Reimplemented from makVrf::DtVrfPointManipulationHandler.

References makVrf::Detonation.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::clampAtClosestPolygonOnPlacement ( ) const

virtual

Return true to keep the placement at closest polygon level regardless of height above terrain. Default is false.

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::canSetActivationTime ( ) const

virtual

Returns true if activation time can be set.

Currently true for all environmentals that do not have the noactivationtime keyword

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::needsEmbarkOnCheck ( ) const

virtual

Return true if this needs to check whether or not this object can embark on another object. Default is false.

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::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::DtVrfPointManipulationHandler.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::createVrfObject ( DtVrfObjectFacadeInterface * )

virtual

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

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::modifyVrfObject ( DtVrfObjectFacadeInterface * )

virtual

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual DtVrfObjectFacadeInterface* makVrf::DtVrfDynamicTerrainSwitchHandler::createLocalRepresentation ( DtVrlinkSimulatedBaseStateView * editStateView = 0 )

virtual

returns true if successful, false otherwise

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual void makVrf::DtVrfDynamicTerrainSwitchHandler::initializeEventProcessor ( )

virtual

Reimplemented from makVrf::DtVrfObjectManipulationHandlerBaseClass.

virtual bool makVrf::DtVrfDynamicTerrainSwitchHandler::canChangePositionOnly ( ) const

virtual

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual DtVrfObjectFacadeInterface* makVrf::DtVrfDynamicTerrainSwitchHandler::createLocalRepresentation	(	DtVrlinkSimulatedBaseStateView *	editStateView,
		makVrv::DtUniqueID	sceneObjectId,
		DtVrlinkSimulatedBaseStateView *	principalStateView
	)

virtual

Reimplemented from makVrf::DtVrfPointManipulationHandler.

virtual void makVrf::DtVrfDynamicTerrainSwitchHandler::setLocationToSwitch ( const DtVector & )

virtual

const DtVector& makVrf::DtVrfDynamicTerrainSwitchHandler::locationToSwitch ( ) const

inline

Member Data Documentation

DtVector makVrf::DtVrfDynamicTerrainSwitchHandler::myLocationToSwitch

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation