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 | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::Dt3DEnvironmentalAreaVisualizer Class Reference

Dt3DEnvironmentalAreaVisualizer display a Area drawn as an overlay Area in the scene without occlusion. More...

Inheritance diagram for makVrv::Dt3DEnvironmentalAreaVisualizer:
Inheritance graph
[legend]

Public Member Functions

 Dt3DEnvironmentalAreaVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~Dt3DEnvironmentalAreaVisualizer ()
 Destructor.
virtual void setLineWidth (int)
 Sets the height of the line separating the back and front face of the area if filled.
virtual void setSolid (bool)
 Sets the area to be solid, not just scribed.
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Set any other additional visualizer information from the visual record.
virtual void setScribeAllPolygons (bool)
 Sets whether or not to only scribe the outline (and not the line edges).
virtual void setPhysicalLineHeight (float)
 Sets the height (up extent) of the lines of the area.
virtual void setScribeColor (float r, float g, float b, float a)
 Sets the color of the scribe line.
virtual void setFillStyle (vrvTacticalGraphicUtilities::FillStyle f)
 Override to set fill color on fill style change.
- Public Member Functions inherited from makVrv::DtEnvironmentalAreaVisualizer
 DtEnvironmentalAreaVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~DtEnvironmentalAreaVisualizer ()
 Destructor.
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the area.
virtual void useDefaultColor ()
 Sets color to default color as defined in the visualizer definition.
virtual void getColor (float &r, float &g, float &b, float &a) const
 Returns the color.
virtual void addPoint (int index, const DtVector &)
 Adds a point to the Area. If index is -1, appends else places at given point.
virtual void removePoint (int index)
 Removes point at the given index.
virtual void modifyPoint (int index, const DtVector &)
 Modifies the point at the given index.
virtual void setPoints (const DtEnvironmentalStateListener::ControlPointsList &)
 Sets the control points to the specified list, adding, removing and changing as needed.
virtual void setSelected (bool b)
 Selects the entire Area.
virtual void resetSpatial ()
 Resets geometry of Area.
virtual void createModelAgents ()
 Creates the model agents associated with the Area.
virtual void setStipplePattern (unsigned short)
 Sets the line style of the outline of the area.
virtual unsigned short lineStipple () const
virtual void setScribed (bool)
 Sets whether or not to scribe the line (and edges)
virtual
vrvTacticalGraphicUtilities::FillStyle 
fillStyle () const
 Returns the currently set fill style.
virtual void setPenStyle (vrvTacticalGraphicUtilities::PenStyle)
 Takes the pen style and translates it to a stipple pattern.
virtual void setPixelLineWidth (int)
 Sets the width of the outside line.
virtual void setOrigin (const DtVector &)
 Sets the origin of the area.
virtual void setUseDynamicOrigin (bool)
 Set whether or not to use dynamic origin.
DtAreaFacadeBaseareaFacade () const
 Area facade used by this visualizer.
virtual void setAttached (DtUniqueID)
 Sets this object to be attached to the specified object.
- Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
 DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual ~DtSceneObjectVisualizer ()
virtual DtUniqueID uniqueID () const
 Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent * sceneObjectAgent ()
virtual void setParent (DtStateVisualizer *p)
 Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void setSceneObjectAgent (DtSceneObjectAgent *)
virtual void setElementID (const DtElementID &elementID)
DtElementID elementID () const
virtual bool show (int)
 Override to show/hide scene object agent (if it exists)
virtual bool hide (int)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition.
const std::string & modelDefinition () const
 Gets the current model definition.
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item.
virtual void initialize ()
 Initialize the visualizer.
virtual bool isVisible () const
 Returns true if visible.
virtual bool selected () const
void setName (const std::string &)
 Internal name of state visualizer.
const std::string & name () const
virtual void setPickable (bool)
 Sets pickable state.
virtual bool pickable () const
virtual void setUniqueID (DtUniqueID id)
int visualizerType () const
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item.
DtStateListenerlistener ()
DtBaseConnectionsimulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const

Static Public Member Functions

static const
DtStateVisualizer::TypeInfo
theTypeInfo ()
 This class's type info.

Protected Member Functions

virtual void setupArea (DtAreaFacadeBase *f)
 Sets up the area, creating the extruded polygon model agent to display this area.
virtual DtAreaFacadeBasecreateAreaFacade ()
 Create the facade to represent the area.
- Protected Member Functions inherited from makVrv::DtEnvironmentalAreaVisualizer
virtual void destroyModelAgents ()
 Destroys any model agents currently created.
virtual void setModelDefinitionForAgents ()
 Sets model definitions for agents.
virtual DtVector offsetAtPosition (const DtVector &position) const
 Given the origin and the point offset, return an offset that is valid at the given position.
virtual void startAttached ()
 Starts the process of attachment by creating updater for attachment.
virtual void endAttached ()
 Ends the attachment process.
virtual void setRelativeLocation (const DtVector &)
virtual void setOffsetPoints (const std::vector< DtVector > &)
 These are the relative offsets from the origin of this object that the point of this object represent.
- Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent * createObjectAgent ()
- Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
 Called when the mouse is clicked in this visualizer.
virtual void slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool supportsShowHideContext (int) const
 Default returns true.
template<typename T , typename C >
void connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity.

Protected Attributes

int myDefaultHeight
float myScribeColor [4]
float myScribedWidth
bool myScribeColorSet
bool myScribeAllPolygons
- Protected Attributes inherited from makVrv::DtEnvironmentalAreaVisualizer
DtTacticalGraphicStateListenermyAreaListener
DtAreaFacadeBasemyAreaFacade
DtEnvironmentalStateListener::ControlPointsList myControlPoints
double myLineWidth
int myDefaultLineWidth
float myColor [4]
float myDefaultColor [4]
DtVector myPointOffset
bool myUseDynamicOrigin
unsigned short myLineStipple
vrvTacticalGraphicUtilities::FillStyle myFillStyle
bool myFillColorSet
float myFillColor
bool myScribed
bool myAttachedFlag
DtUniqueID myAttachedToId
DtMultiPointEmbarkationUpdaterAgent * myAttachedUpdaterAgent
DtVector myRelativeLocation
- Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID myElementID
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnectionmySimulation
DtStateListenermyListener
bool myDistributeFlag
DtUniqueID myUniqueID
std::string myName
std::string myModelDefinition
DtSignalConnectionManager myConnections
int myModelSet
int myVisualizerType
std::vector< int > myShowHideContexts
bool mySelected
bool myPickable
bool myVisible
DtStateVisualizermyParent
DtSceneObjectAgent * mySceneObjectAgent

Additional Inherited Members

- Public Types inherited from makVrv::DtStateVisualizer
enum  Type {
  AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,
  AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000
}
 Visualizer class types that are supportable via visualizers. More...
- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDown
 Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDblClick

Detailed Description

Dt3DEnvironmentalAreaVisualizer display a Area drawn as an overlay Area in the scene without occlusion.

Constructor & Destructor Documentation

makVrv::Dt3DEnvironmentalAreaVisualizer::Dt3DEnvironmentalAreaVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
int  modelSet 
)

Constructor.

virtual makVrv::Dt3DEnvironmentalAreaVisualizer::~Dt3DEnvironmentalAreaVisualizer ( )
virtual

Destructor.

Member Function Documentation

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setLineWidth ( int  )
virtual

Sets the height of the line separating the back and front face of the area if filled.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setSolid ( bool  )
virtual

Sets the area to be solid, not just scribed.

If scribing is turned off, this could effectively hide the object

Reimplemented from makVrv::DtEnvironmentalAreaVisualizer.

virtual const DtStateVisualizer::TypeInfo& makVrv::Dt3DEnvironmentalAreaVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt3DBoxVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::Dt3DEnvironmentalAreaVisualizer::theTypeInfo ( )
static

This class's type info.

Reimplemented in makVrv::Dt3DBoxVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition )
virtual

Set any other additional visualizer information from the visual record.

Reimplemented from makVrv::DtEnvironmentalAreaVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setScribeAllPolygons ( bool  )
virtual

Sets whether or not to only scribe the outline (and not the line edges).

Only valid if scribed is true. If set to true will scribe all point connections along the polygon. If false will only scribe the top and bottom of the polygon

Reimplemented in makVrv::Dt3DBoxVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setPhysicalLineHeight ( float  )
virtual

Sets the height (up extent) of the lines of the area.

Reimplemented in makVrv::Dt3DBoxVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setScribeColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the scribe line.

Reimplemented in makVrv::Dt3DBoxVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setFillStyle ( vrvTacticalGraphicUtilities::FillStyle  f)
virtual

Override to set fill color on fill style change.

Reimplemented from makVrv::DtEnvironmentalAreaVisualizer.

virtual void makVrv::Dt3DEnvironmentalAreaVisualizer::setupArea ( DtAreaFacadeBase f)
protectedvirtual

Sets up the area, creating the extruded polygon model agent to display this area.

Reimplemented from makVrv::DtEnvironmentalAreaVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer, and makVrv::Dt3DBoxVisualizer.

virtual DtAreaFacadeBase* makVrv::Dt3DEnvironmentalAreaVisualizer::createAreaFacade ( )
protectedvirtual

Create the facade to represent the area.

Implements makVrv::DtEnvironmentalAreaVisualizer.

Reimplemented in makVrv::Dt3DBoxVisualizer.

Member Data Documentation

int makVrv::Dt3DEnvironmentalAreaVisualizer::myDefaultHeight
protected
float makVrv::Dt3DEnvironmentalAreaVisualizer::myScribeColor[4]
protected
float makVrv::Dt3DEnvironmentalAreaVisualizer::myScribedWidth
protected
bool makVrv::Dt3DEnvironmentalAreaVisualizer::myScribeColorSet
protected
bool makVrv::Dt3DEnvironmentalAreaVisualizer::myScribeAllPolygons
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)