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

Contains Dt3DEllipseVisualizer class. More...

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

Public Member Functions

 Dt3DEllipseVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~Dt3DEllipseVisualizer ()
 DTOR.
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the ellipse.
virtual void useDefaultColor ()
 Sets color to default color.
virtual void getColor (float &r, float &g, float &b, float &a) const
 Returns the color.
virtual void setFillStyle (vrvTacticalGraphicUtilities::FillStyle)
 Sets the fill style of the area.
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 unsigned short lineStipple () const
 Returns the stipple pattern.
virtual void setStipplePattern (unsigned short)
 Sets the stipple pattern of the line.
virtual void setPoints (const DtEnvironmentalStateListener::ControlPointsList &)
 Sets the origin, and, possible radii of the ellipse.
virtual void addPoint (int inex, const DtVector &)
 Adds a point to the ellipse. If second or third point will set X or Y radius appropirates.
virtual void setOrigin (const DtVector &)
 Sets the origin of the ellipse.
virtual void setSelected (bool)
 Sets whether or not the ellipse is selected.
virtual void setLineWidth (int)
 Sets the width of the outside line. Default is 2.
virtual void setFill (bool)
 Sets whether or not to fill ellipse. If fill style of line is specified, will override this flag.
virtual const
DtStateVisualizer::TypeInfo & 		typeInfo () const
 Get the instance's type info.
virtual void fillEllipseIfRequested ()
 Called to see if ellipse should be set to fill based on fill pattern or fill boolean.
virtual void setProjected (bool)
 Switched between 2D/3D representation. If projected uses 2D else 3D.
- 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 setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using.
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.
DtStateListener & listener ()
DtBaseConnection & simulation ()
 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 ()
 The class's type info.

Protected Member Functions

virtual void createModelAgents ()
 Creates the model agents associated with the cirlce.
virtual void destroyModelAgents ()
 Destroyed model agents associated with ellipse.
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Sets default values.
virtual void setSolid (bool)
virtual void setPosition (int iIndex, const DtVector &)
 Sets position in ellipse (origin, X or Y)
virtual void createEllipse ()
 Creates the ellipse if not of the correct projection or does not exist.
- 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

DtTacticalGraphicStateListener & myEllipseListener
float myDefaultColor [4]
float myColor [4]
double myDefaultLineWidth
bool myFill
DtEllipseFacadeInterface * myEllipse
bool myProjected
int myLineWidth
unsigned short myLineStipple
vrvTacticalGraphicUtilities::FillStyle myFillStyle
bool myFillColorSet
float myFillColor
- Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID myElementID
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection & mySimulation
DtStateListener & myListener
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
DtStateVisualizer * myParent
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

Contains Dt3DEllipseVisualizer class.

Visualizer for a 3D (overlay) circle. The setPoints method will inherently assume that if there are 2 points defined the distance between the first (origin) and second is the X Radius. If there are three points defined the distance between the third and the first is the Y radius. If there is no Y radius a circle is assumed

Constructor & Destructor Documentation

makVrv::Dt3DEllipseVisualizer::Dt3DEllipseVisualizer ( DtBaseConnection &  simulation,
DtStateListener &  listener,
int  modelSet 
)

CTOR.

virtual makVrv::Dt3DEllipseVisualizer::~Dt3DEllipseVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::Dt3DEllipseVisualizer::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color for the ellipse.

This will apply to all segments of the area. If the default (all 0's), uses the default as defined in the visual definition

virtual void makVrv::Dt3DEllipseVisualizer::useDefaultColor ( )
virtual

Sets color to default color.

virtual void makVrv::Dt3DEllipseVisualizer::getColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual

Returns the color.

virtual void makVrv::Dt3DEllipseVisualizer::setFillStyle ( vrvTacticalGraphicUtilities::FillStyle  )
virtual

Sets the fill style of the area.

If fill is 0, will be considered an outlined area. Translates the fill style bit to a patterened fill style using the mapping routines found in vrvTacticalGraphicUtilities.h

virtual vrvTacticalGraphicUtilities::FillStyle makVrv::Dt3DEllipseVisualizer::fillStyle ( ) const
virtual

Returns the currently set fill style.

virtual void makVrv::Dt3DEllipseVisualizer::setPenStyle ( vrvTacticalGraphicUtilities::PenStyle  )
virtual

Takes the pen style and translates it to a stipple pattern.

See vrvTacticalGraphicUtilities for styles

virtual unsigned short makVrv::Dt3DEllipseVisualizer::lineStipple ( ) const
virtual

Returns the stipple pattern.

virtual void makVrv::Dt3DEllipseVisualizer::setStipplePattern ( unsigned  short)
virtual

Sets the stipple pattern of the line.

virtual void makVrv::Dt3DEllipseVisualizer::setPoints ( const DtEnvironmentalStateListener::ControlPointsList &  )
virtual

Sets the origin, and, possible radii of the ellipse.

Akin to calling setOrigin, setXRadius and setYRadius

virtual void makVrv::Dt3DEllipseVisualizer::addPoint ( int  inex,
const DtVector &   
)
virtual

Adds a point to the ellipse. If second or third point will set X or Y radius appropirates.

virtual void makVrv::Dt3DEllipseVisualizer::setOrigin ( const DtVector &  )
virtual

Sets the origin of the ellipse.

virtual void makVrv::Dt3DEllipseVisualizer::setSelected ( bool  )
virtual

Sets whether or not the ellipse is selected.

Reimplemented from makVrv::DtStateVisualizer.

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

Sets the width of the outside line. Default is 2.

virtual void makVrv::Dt3DEllipseVisualizer::setFill ( bool  )
virtual

Sets whether or not to fill ellipse. If fill style of line is specified, will override this flag.

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

Get the instance's type info.

Implements makVrv::DtStateVisualizer.

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

The class's type info.

virtual void makVrv::Dt3DEllipseVisualizer::fillEllipseIfRequested ( )
virtual

Called to see if ellipse should be set to fill based on fill pattern or fill boolean.

virtual void makVrv::Dt3DEllipseVisualizer::setProjected ( bool  )
virtual

Switched between 2D/3D representation. If projected uses 2D else 3D.

virtual void makVrv::Dt3DEllipseVisualizer::createModelAgents ( )
protectedvirtual

Creates the model agents associated with the cirlce.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DEllipseVisualizer::destroyModelAgents ( )
protectedvirtual

Destroyed model agents associated with ellipse.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DEllipseVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef)
protectedvirtual

Sets default values.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::Dt3DEllipseVisualizer::setSolid ( bool  )
protectedvirtual
virtual void makVrv::Dt3DEllipseVisualizer::setPosition ( int  iIndex,
const DtVector &   
)
protectedvirtual

Sets position in ellipse (origin, X or Y)

virtual void makVrv::Dt3DEllipseVisualizer::createEllipse ( )
protectedvirtual

Creates the ellipse if not of the correct projection or does not exist.

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::Dt3DEllipseVisualizer::myEllipseListener
protected
float makVrv::Dt3DEllipseVisualizer::myDefaultColor[4]
protected
float makVrv::Dt3DEllipseVisualizer::myColor[4]
protected
double makVrv::Dt3DEllipseVisualizer::myDefaultLineWidth
protected
bool makVrv::Dt3DEllipseVisualizer::myFill
protected
DtEllipseFacadeInterface* makVrv::Dt3DEllipseVisualizer::myEllipse
protected
bool makVrv::Dt3DEllipseVisualizer::myProjected
protected
int makVrv::Dt3DEllipseVisualizer::myLineWidth
protected
unsigned short makVrv::Dt3DEllipseVisualizer::myLineStipple
protected
vrvTacticalGraphicUtilities::FillStyle makVrv::Dt3DEllipseVisualizer::myFillStyle
protected
bool makVrv::Dt3DEllipseVisualizer::myFillColorSet
protected
float makVrv::Dt3DEllipseVisualizer::myFillColor
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)