VR-Forces 4.3 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 | Protected Attributes
makVrf::DtVrfWeatherManipulationHandler Class Reference

The handler for creating weather objects. More...

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

Public Member Functions

 DtVrfWeatherManipulationHandler (makVrv::DtDe &)
virtual ~DtVrfWeatherManipulationHandler ()
virtual void setWeatherCreationCommand (const DtChangeWeatherCommand &)
 Sets the weather creation command to be used during object create.
const DtChangeWeatherCommandweatherCommand () const
virtual HandlerType type () const
 The type of handler. Used to see if two handler are equivalent.
- Public Member Functions inherited from makVrf::DtVrfBoxManipulationHandler
 DtVrfBoxManipulationHandler (makVrv::DtDe &)
virtual ~DtVrfBoxManipulationHandler ()
virtual double length () const
 Returns length of box (in meters)
virtual void setLength (double)
 Sets length of box (in meters)
virtual double width () const
 Returns width of box (in meters)
virtual void setWidth (double)
 Sets width of box (in meters)
virtual void setDimensions (double length, double width, DtVrfObjectFacadeInterface *=0)
 Sets dimensions of box (in meters)
virtual void setAttachObjectToMouse (bool flag)
 Override to set to free rotate if editing and not attached to mouse.
virtual std::vector< DtVectorcreateBox (const DtVector &origin, double length, double width, double orientation)
virtual void setLocation (const DtVector &location, double altAboveGround)
- Public Member Functions inherited from makVrf::DtVrfShapeManipulationHandler
 DtVrfShapeManipulationHandler (makVrv::DtDe &)
virtual ~DtVrfShapeManipulationHandler ()
virtual void setPoints (const std::vector< DtVector > &pts)
virtual void setPoints (const std::vector< DtGeodeticCoord > &pts)
const std::vector< DtVector > & points () const
virtual void addControlPoint (const DtVector &location, int index=-1)
virtual void removeControlPoint (int index)
virtual void setAltitudeAboveSeaLevel (int, double)
 Set altitude above sea level for the particular point.
virtual double altitudeAboveSeaLevel (int) const
virtual void setAltitudeAboveTerrain (int, double)
 Set altitude above terrain for the particular point.
virtual double altitudeAboveTerrain (int) const
virtual bool canChangeDimensions () const
 Returns true if there is no fixed width and no fixed height.
virtual double maximumLength () const
 Returns the maximum length a linear object can have. -1 if no max.
virtual bool shapeAtMinimum () const
 Returns true if the shape has the minimum number of points to create.
virtual bool canRemovePoint () const
virtual bool shapeAtMinimum (DtEnvironmentStateView *)
virtual bool canDeleteAPoint (DtEnvironmentStateView *)
 Returns true if a point can be deleted from this object.
virtual bool shapeAtMaximum () const
 Returns true if the shape has the minimum number of points to create.
virtual bool shapeAtMaximum (DtEnvironmentStateView *)
virtual int numVertices () const
 Returns the number of vertices in the principal object.
virtual void setEditingPoint (int)
virtual int editingPoint () const
virtual DtGeodeticCoord geodeticPosition (int) const
virtual DtVector geocentricPosition (int) const
virtual DtVector localLocation (int index) const
 location + altitude
virtual std::vector
< DtGeodeticCoord > 
geodeticPositions () const
virtual std::vector< DtVectorgeocentricPositions () const
virtual void removePoint (int)
virtual double altitudeForAltitudeType (int) const
 Return the altitude given the current altitude type set. Goes to facade for information.
virtual bool freehand () const
 Returns true if in freehand mode.
virtual bool canChangeArrowStyle () const
 Returns true if the arrow style can be changed.
virtual bool canChangeArrowSize () const
virtual bool canFill () const
virtual bool canChangePenStyle () const
virtual bool canChangeShapeOnly () const
 Returns true if only the shape can be changed and none of the other object parameters.
virtual void setPointSamplingRate (int)
 Sets the sampling rate for points.
virtual int pointSamplingRate () const
virtual void setLineWidth (int)
 Sets the line width of the line or outside of area.
virtual int lineWidth () const
virtual void setPenStyle (int)
 Sets the pen style of the line or the style of the area border.
virtual int penStyle () const
virtual void setFillStyle (int)
 Sets the fill style of the area.
virtual int fillStyle () const
virtual bool fixedWidthSizing () const
 Returns whether or not line is in fixed width sizing mode.
virtual void setForce (int)
 Sets the force of the object.
virtual void setColor (int)
virtual int color () const
virtual void setExtendedLabels (const std::map< int, DtString > &)
virtual void setLabel (const std::string &)
 Sets label of item. Default is no-op.
virtual std::string label () const
virtual void setFormattingData (const std::string &)
virtual std::string formattingData () const
virtual int arrowStyle () const
 Returns information about the current arrow settings from the visualizer.
virtual int arrowHeadPlacement () const
virtual int arrowSize () const
virtual double orientation () const
 Returns orientation of object.
virtual void setOrientation (double)
 Orients all the points of the object around the geometric center of the object by the given orientation.
virtual double initialArrowSize (bool fixedWidthSizing, double initialSize) const
 For a newly created object returns initial arrow size.
virtual void setAllowHeadingChanges (bool)
 Sets whether or not heading changes are allowed via the mouse/keyboard. Default is false.
virtual void cancel ()
 Cancels any current work.
virtual DtVector centerOfMass () const
 Returns center of mass of all objects created (in geocentric)
virtual void updateOffsetsBasedOnMousePosition (const DtVector &centerOfMass, const DtGeodeticCoord &)
 Reset objects based on new center.
- 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 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 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 bool attachObjectToMouse () const
virtual void setHeading (double value)
virtual double heading () const
virtual void setLocation (const DtVector &loc)
virtual void stop ()
 Stop an ongoing creation process.
virtual void deferredStop ()
 Stops on a post tick callback.
virtual bool createVrfObject ()
virtual bool modifyVrfObjects ()
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_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 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 bool waitingToStop () const
virtual void setEditingType (DtEditingType)
DtEditingType editingType () const
virtual std::vector
< makVrv::DtElementID
ignoreList () const
 Returns the list of IDs current being used to prevent usage in intersections.
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 setSignalOnMultiSelectionComplete (bool)
 Set signal on multi selection complete.
virtual void setSelectionCount (int)
 Sets the count of items "selected".

Protected Member Functions

virtual bool createVrfObject (DtVrfObjectFacadeInterface *)
 Override to create a name based on the short name of the weather object if a name was not specified by the user.
virtual void postCreateInitialize ()
- Protected Member Functions inherited from makVrf::DtVrfBoxManipulationHandler
virtual void initializeEventProcessor ()
virtual void setLocation (int index, const DtVector &location, bool resetOrigin=true)
 Overridden to rework point for given point given length/width change.
virtual void objectCreated (DtVrfObjectFacadeInterface *)
 Called when an object is created, if state view is present will set to be projected if projected.
virtual void preVisualization (DtVrfObjectFacadeInterface *, DtVrlinkSimulatedBaseStateView *)
 Called before an object is fully created.
virtual void slot_onPlace (makVrv::DtUniqueID id, const DtVector &location, double altAboveGround)
 Override to allow completion finish on left click as well as right click (left click seems more natural with circles)
virtual void setXTheSame (const DtVector &source, int index, DtEnvironmentalFacadeCollection *efc=0)
 Sets the X position to be the same, leaving Y alone and clamping Z. Will call parent set location to set the location of the point.
virtual void setYTheSame (const DtVector &source, int index, DtEnvironmentalFacadeCollection *efc=0)
 Sets the Y position to be the same, leaving X alone and clamping Z. Will call parent set location to set the location of the point.
virtual void getMinMaxVertices (const DtEntityType &creatingType, int &minVert, int &maxVert) const
 Returns the minimum/maximum vertices of the given type.
virtual void slot_onEditComplete (makVrv::DtUniqueID id, const DtVector &location, double altAboveGround)
 Override to make sure box maintains box shape.
virtual void slot_onLocationChanged (const DtVector &location, double altAboveGround)
virtual void slot_onHeadingChanged (double heading)
virtual void initializeInterfaceForEdit (DtVrfObjectFacadeInterface *iFace, makVrv::DtUniqueID sceneObjectId, const makVrv::DtVrlinkSimulatedBaseState &editState, const DtVector &principalLocation, const DtTaitBryan &principalOrientation)
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView, makVrv::DtUniqueID sceneObjectId, DtVrlinkSimulatedBaseStateView *principalStateView)
- Protected Member Functions inherited from makVrf::DtVrfShapeManipulationHandler
virtual void calculateAnchorBasedOnMousePosition (makVrv::DtChannel &channel)
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 DtVector geometricCenter (const std::vector< DtVector > &v) const
virtual void slot_onComplete (bool stopCreating)
virtual void slot_onCancel (bool escPressed)
virtual void slot_onCancelOrComplete (bool escPressed)
virtual void slot_onAltitudeChanged (const DtVector &location, double altitude)
virtual
DtVrfObjectFacadeInterface
createLocalRepresentation (DtVrlinkSimulatedBaseStateView *editStateView=0)
 returns true if successful, false otherwise
virtual DtVector addControlPoint (int index=-1)
virtual void moveSelectedPoint (const DtVector &location, double altAboveGround)
virtual bool isArea (const DtEntityType &type) const
virtual bool isRoute (const DtEntityType &type) const
virtual bool isObstacle (const DtEntityType &type) const
virtual bool isPhaseline (const DtEntityType &type) const
virtual DtEnvironmentalCreationData environmentalCreationData (const std::string &name, const DtEntityType &, int force) const
virtual void updateLocationOffset (const DtVector &local, DtEnvironmentalFacadeCollection *env, int pos)
virtual bool modifyVrfObject (DtVrfObjectFacadeInterface *objectImage)
 Called for each object to be modified.
virtual DtVector setAltitudeToOrigin (const DtVector &) const
 Sets the altitude of the supplied point (local) to the same altitude as the origin and returns that new point.
virtual DtVector rotatedPoint (const DtVector &origin, double x, double heading) const
 Attempts to rotate point until exact distance is retrieved.
virtual DtVector rotatePoint (const DtVector &origin, double x, double heading) const
 Rotate a point and just take the result regardless of the distance achieved after rotation (meaning actual straight line distance could be different in geocentric due to earch curvature)
virtual bool alwaysRecalculateGeometry () const
virtual DtVector rotatePointInternal (const DtVector &origin, double x, double heading) const
virtual void updateOffsetsBasedOnMousePosition ()
 Will go through all objects and update their current origins based on the mouse position.
virtual void setupImagePointsUsingImageOffset (DtEnvironmentalFacadeCollection *, const std::vector< DtVector > &)
- 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 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 setHeading (DtVrfObjectFacadeInterface *objectImage, double heading)
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 bool clampOnPlacement () const
 Return true to clamp object to closest polygon when placed on terrain regardless of altitude set.
virtual bool clampAtClosestPolygonOnPlacement () const
 Return true to keep the placement at closest polygon level regardless of height above terrain. Default is false.
virtual void parseKeywords (const std::string &)

Protected Attributes

DtChangeWeatherCommand myWeatherCommand

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::DtVrfShapeManipulationHandler
boost::signal< void(const
DtVector &, int)> 
signal_pointLocationChanged
boost::signal< void()> signal_pointSamplingRateChanged
- Protected Types inherited from makVrf::DtVrfObjectManipulationHandlerBaseClass
typedef std::map
< DtVrlinkSimulatedBaseStateView
*, makVrv::DtSignalConnectionManager * > 
StateViewConnections

Detailed Description

The handler for creating weather objects.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void makVrf::DtVrfWeatherManipulationHandler::setWeatherCreationCommand ( const DtChangeWeatherCommand )
virtual

Sets the weather creation command to be used during object create.

If this is edit mode passes the command to the base class to be used for handling during edit

const DtChangeWeatherCommand& makVrf::DtVrfWeatherManipulationHandler::weatherCommand ( ) const
inline
virtual HandlerType makVrf::DtVrfWeatherManipulationHandler::type ( ) const
inlinevirtual

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

Reimplemented from makVrf::DtVrfBoxManipulationHandler.

Reimplemented in makVrf::DtVrfVertexManipulationHandler< DtVrfWeatherManipulationHandler >.

References makVrf::Weather.

virtual bool makVrf::DtVrfWeatherManipulationHandler::createVrfObject ( DtVrfObjectFacadeInterface )
protectedvirtual

Override to create a name based on the short name of the weather object if a name was not specified by the user.

Reimplemented from makVrf::DtVrfShapeManipulationHandler.

virtual void makVrf::DtVrfWeatherManipulationHandler::postCreateInitialize ( )
protectedvirtual

Member Data Documentation

DtChangeWeatherCommand makVrf::DtVrfWeatherManipulationHandler::myWeatherCommand
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)