VR-Forces 4.1.1 Class Documentation
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrf::DtRangeSphereVisualizer Class Reference

A visualizer for displaying range rings. More...

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

Classes

struct  SphereStruct

Public Member Functions

 DtRangeSphereVisualizer (makVrv::DtBaseConnection &connection, makVrv::DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtRangeSphereVisualizer ()
 DTOR.
virtual void connect ()
virtual void disconnect ()
virtual void initialize_settings ()
virtual void setVisualizerDefinition (const makVrv::DtVisualizerDefinition &visDef)
 Sets the visual definition of the visualizer.
virtual void setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using.
virtual const
makVrv::DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
virtual bool setVisible (bool onOff, int contextInt)
 Returns true if this context wants to show or hide the item.
virtual void setShowRangeSphere (bool)
virtual void setScale (float)
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
virtual void setParent (DtStateVisualizer *)
 Override to set the parent of this visualizer.
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 void initialize ()
 Initialize the visualizer.
virtual bool isVisible () const
 Returns true if visible.
virtual void setSelected (bool)
 Sets selected state.
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)
DtUniqueID uniqueID () const
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
makVrv::DtStateVisualizer::TypeInfo
theTypeInfo ()
 This class's type info.
static const
makVrv::DtVisualizerSchema
theDtRangeSphereSchema ()
 Get reference to DtEntityMilitaryImageSymbolVisualizer schema.

Protected Member Functions

virtual void tryToDraw ()
virtual void createModelAgents ()
 Override to create model agents that will be used to display data from the listener.
virtual void destroyModelAgents ()
 Destroys all currently created definitions.
virtual SphereStruct addNewRangeSphere ()
virtual void destroyLastRangeSphere ()
virtual void setRangeSphereColors ()
virtual void slot_entityRangeRingsEnabled (const std::string &markingText, int setting)
virtual void setRangeSphereGeometry ()
virtual void setRangeSphereCount (int)
- 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 hide (int context)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
virtual bool show (int context)
 Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero.
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

std::vector< SphereStructmyRangeSpheres
DtEntityStateListenerExtensionsmyExtensions
bool myShowRangeSphere
bool myEntityRangeRingsEnabled
float myScale
- 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

A visualizer for displaying range rings.

Constructor & Destructor Documentation

makVrf::DtRangeSphereVisualizer::DtRangeSphereVisualizer ( makVrv::DtBaseConnection connection,
makVrv::DtStateListener listener,
int  modelSet 
)

CTOR.

virtual makVrf::DtRangeSphereVisualizer::~DtRangeSphereVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtRangeSphereVisualizer::connect ( )
virtual
virtual void makVrf::DtRangeSphereVisualizer::disconnect ( )
virtual
virtual void makVrf::DtRangeSphereVisualizer::initialize_settings ( )
virtual
virtual void makVrf::DtRangeSphereVisualizer::setVisualizerDefinition ( const makVrv::DtVisualizerDefinition visDef)
virtual

Sets the visual definition of the visualizer.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrf::DtRangeSphereVisualizer::setModelDefinitionForAgents ( )
virtual

Sets model definition for all the agents that this visualizer might be using.

If model agents are not created, should create them. Should not call this directly, but rather call setModelDefinition

Implements makVrv::DtStateVisualizer.

virtual const makVrv::DtStateVisualizer::TypeInfo& makVrf::DtRangeSphereVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const makVrv::DtStateVisualizer::TypeInfo& makVrf::DtRangeSphereVisualizer::theTypeInfo ( )
static

This class's type info.

static const makVrv::DtVisualizerSchema& makVrf::DtRangeSphereVisualizer::theDtRangeSphereSchema ( )
static

Get reference to DtEntityMilitaryImageSymbolVisualizer schema.

virtual bool makVrf::DtRangeSphereVisualizer::setVisible ( bool  visible,
int  context 
)
virtual

Returns true if this context wants to show or hide the item.

If it does, put onto (or removes) list of contexts that are responsible for keeping this item hidden. If there are no items left and the item wants to be show, createModelAgents() is called, else if being hidden, destroyModelAgents() is called. Returns true if visibility has changed

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrf::DtRangeSphereVisualizer::setShowRangeSphere ( bool  )
virtual
virtual void makVrf::DtRangeSphereVisualizer::setScale ( float  )
virtual
virtual void makVrf::DtRangeSphereVisualizer::tryToDraw ( )
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::createModelAgents ( )
protectedvirtual

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

virtual void makVrf::DtRangeSphereVisualizer::destroyModelAgents ( )
protectedvirtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

virtual SphereStruct makVrf::DtRangeSphereVisualizer::addNewRangeSphere ( )
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::destroyLastRangeSphere ( )
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::setRangeSphereColors ( )
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::slot_entityRangeRingsEnabled ( const std::string &  markingText,
int  setting 
)
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::setRangeSphereGeometry ( )
protectedvirtual
virtual void makVrf::DtRangeSphereVisualizer::setRangeSphereCount ( int  )
protectedvirtual

Member Data Documentation

std::vector<SphereStruct> makVrf::DtRangeSphereVisualizer::myRangeSpheres
protected
DtEntityStateListenerExtensions* makVrf::DtRangeSphereVisualizer::myExtensions
protected
bool makVrf::DtRangeSphereVisualizer::myShowRangeSphere
protected
bool makVrf::DtRangeSphereVisualizer::myEntityRangeRingsEnabled
protected
float makVrf::DtRangeSphereVisualizer::myScale
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)