VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtEntityVisualizerSet Class Reference

This class is a set of entity visualizers, all of the visualizers in this set must support the entity visualizer type and are connected to a Entity state listener. More...

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

Public Member Functions

 DtEntityVisualizerSet (DtBaseConnection &conn, DtEntityStateListener &listener, int modelSet, bool distribute=true)
 Creates a set using the supplied connection, listener, and factory.
virtual ~DtEntityVisualizerSet ()
virtual void visualize (const DtUnicode &definition, const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap &creationMap)
 Creates all visualizers for this instance.
virtual DtStateVisualizer::Type supportsVisualizerType () const
 Returns the types of visualizers this will support.
- Public Member Functions inherited from makVrv::DtVisualizerSet
 DtVisualizerSet (DtBaseConnection &conn, DtStateListener &listener, int modelSet, bool distribute)
 CTOR.
virtual ~DtVisualizerSet ()
 Destructor.
virtual void visualizeElementDefinition (const DtUnicode &elementName, const DtElementDefinitionNew &def, const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap &creationMap)
 Visualize an element definition.
virtual void visualizeElementDefinition (const DtUnicode &elementName, const DtElementDefinitionNew &def)
 Visualize an element definition.
virtual void createVisualizersByType (int visualType)
 Go through the visualizer definitions in the member variable myDefinitions, and create/add any visualizers that have the specified visual type.
virtual void destroyVisualizersByType (int visualType)
 Go through all realized visualizers and remove any that match the specified visual type.
const DtElementDefinitionNewdefinition () const
 Returns the visualized definition.
int modelSet () const
 Returns the visualized model set.
template<typename VisualizerClass >
void findVisualizers (std::vector< VisualizerClass * > &visualizers)
 Find all instances of a Visualizer by schema name.
template<typename VisualizerClass >
void findVisualizersByDynamicCast (std::vector< VisualizerClass * > &visualizers)
 Find all instance of a visualizer by dynamically casting to the class type rather than doing the faster type info check.
virtual void findVisualizers (const DtVisualizerSchema &, VisualizerList &visualizers)
 Find all visualizers which use a particular schema.
virtual bool setVisible (bool visible, DtShowHideContext::ShowHideContext context=DtShowHideContext::InstanceHidden)
 Since there are many things that might want to show/hide an item, keep track of them in a list for each visualizer.
virtual bool isVisible () const
 Is the instance visible.
virtual bool show (DtShowHideContext::ShowHideContext)
 Show (or hide) the item with the given context.
virtual bool hide (DtShowHideContext::ShowHideContext)
bool isHiddenByContext (DtShowHideContext::ShowHideContext) const
 Returns true if hidden by the specified context.
virtual DtUniqueID uniqueID () const
 Returns unique id of mySceneObjectAgent, else 0.
DtSceneObjectVisualizersceneObjectVisualizer () const
virtual void setPickable (bool pickable)
 Set whether this visualizer is pickable.
bool pickable () const
 Is this visualizer pickable.
virtual void setSelected (bool)
 Set if the instance selected.
bool selected () const
 Is the instance selected.
bool addVisualizer (const DtVisualizerDefinition &def)
 Add a visualizer after the visualizerSet has been visualized.
virtual void destroyAllModelVisualizers ()
 Destroys all model agent visualizers associated with visualizer.

Protected Attributes

DtEntityStateListenermyEntityListener
 Same as myListener, but casted for convenience.
- Protected Attributes inherited from makVrv::DtVisualizerSet
DtBaseConnectionmyBaseConnection
DtStateVisualizerFactorymyCachedFactory
DtStateListenermyStateListener
StateVisualizerMap myVisualizers
DtSignalConnectionManager myConnections
const DtElementDefinitionNewmyDefinition
bool mySelected
bool myPickable
bool myVisible
bool myDistribute
DtSceneObjectVisualizermySceneObjectVisualizer
ShowHideContexts myShowHideContexts
int myModelSet

Additional Inherited Members

- Public Types inherited from makVrv::DtVisualizerSet
typedef std::vector
< DtStateVisualizer * > 
VisualizerList
- Public Attributes inherited from makVrv::DtVisualizerSet
boost::signal< void(DtMouseState
&mouseState, const DtUniqueID
&id, const std::string
&displayEngineName, const
std::string &windowName, const
std::string &channelName,
DtStateVisualizer *v,
DtVisualizerSet *i)> 
signal_mouseDown
 Emitted when the mouse is clicked on any visualizer in this collection.
boost::signal< void(DtMouseState
&mouseState, const DtUniqueID
&id, const std::string
&displayEngineName, const
std::string &windowName, const
std::string &channelName,
DtStateVisualizer *v,
DtVisualizerSet *i)> 
signal_mouseUp
boost::signal< void(DtMouseState
&mouseState, const DtUniqueID
&id, const std::string
&displayEngineName, const
std::string &windowName, const
std::string &channelName,
DtStateVisualizer *v,
DtVisualizerSet *i)> 
signal_mouseDblClick
boost::signal< void(bool,
DtVisualizerSet *vis) > 
signal_selectionStateChanged
- Protected Types inherited from makVrv::DtVisualizerSet
typedef
boost::unordered_multimap
< std::string,
DtStateVisualizer * > 
StateVisualizerMap
typedef std::vector
< DtShowHideContext::ShowHideContext
ShowHideContexts
- Protected Member Functions inherited from makVrv::DtVisualizerSet
void destroyAllModelVisualizersInternal ()
 Non-virtual work function for destroying all model visualizers in this set.
virtual void visualizeVisualizerDefinitionSet (const DtVisualizerDefinitionSet &set, const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap *creationMap)
 Given the DtVisualDefinitionSet, create all visualizers associated.
virtual DtStateVisualizercreateVisualizerFromDefinition (const DtVisualizerDefinition &def)
 Create a state visualizer from a visual definition.
virtual void addVisualizer (const std::string &schemaName, DtStateVisualizer *visualizer)
 Adds a new model visualizer into the list of visualizers.
bool suppressVisualizerCreation (const DtVisualizerDefinition *visDef, const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap *creationMap) const
 Check to see if the visualizer type and creation map warrant creation.
int findVisualType (const DtVisualizerDefinition &visDef) const
 lookup the visualtype attribute from a visual definition; returns 0 if none found
virtual void setModelVisualizerVisible (const std::string &schemaName, bool onOff, int context)
 Call setVisible for all visualizers with the indicated schemaName.
virtual void slot_mouseDown (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName, DtStateVisualizer *v)
 Called when the entity's indicator is clicked in some channel.
virtual void slot_mouseUp (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName, DtStateVisualizer *v)
virtual void slot_mouseDblClick (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName, DtStateVisualizer *v)
template<typename T , typename C >
void connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Utility function for connect a signal to an update function as well as calling the update function.
const DtUnicodechooseRandomString (const std::vector< DtUnicode > &stringList)
 Return the model definition that might be randomly chosen, if the definitions has more than 1 item.

Detailed Description

This class is a set of entity visualizers, all of the visualizers in this set must support the entity visualizer type and are connected to a Entity state listener.

Constructor & Destructor Documentation

makVrv::DtEntityVisualizerSet::DtEntityVisualizerSet ( DtBaseConnection conn,
DtEntityStateListener listener,
int  modelSet,
bool  distribute = true 
)

Creates a set using the supplied connection, listener, and factory.

virtual makVrv::DtEntityVisualizerSet::~DtEntityVisualizerSet ( )
virtual

Member Function Documentation

virtual void makVrv::DtEntityVisualizerSet::visualize ( const DtUnicode definition,
const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap creationMap 
)
virtual

Creates all visualizers for this instance.

Must be called to view object

virtual DtStateVisualizer::Type makVrv::DtEntityVisualizerSet::supportsVisualizerType ( ) const
virtual

Returns the types of visualizers this will support.

Default is to support Entity type visualizers. If the visualizer that is going to be created in createVisualizer is not supported by this instance visualizer, then, the visualizer will not be created

Reimplemented from makVrv::DtVisualizerSet.

Member Data Documentation

DtEntityStateListener& makVrv::DtEntityVisualizerSet::myEntityListener
protected

Same as myListener, but casted for convenience.


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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)