makVrv::DtScribeBoxVisualizer Class Reference

DtScribeBoxVisualizer class is used to visualize scribe boxes. More...

Inheritance diagram for makVrv::DtScribeBoxVisualizer:

Public Member Functions
	DtScribeBoxVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtScribeBoxVisualizer ()
	DTOR.
void	setParent (DtStateVisualizer *p)
	Override to set the parent of this visualizer.
virtual void	setModelDefinitionForAgents ()
	Currently no model definition, so this does nothing (but required to exist)
virtual void	setSelected (bool b)
	Sets selected state.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	process the visual definition record
virtual void	setDisableModelScaling (bool b)
	Set whether model scaling is disabled (false by default)
virtual void	setLocalModelScalingEnabled (bool enabled)
	Set whether local model scaling is enabled ( false by default )
virtual void	setLocalModelScalingAmount (float localScl)
	Set the amount of local scaling to apply ( when enabled ).
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
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)
DtUniqueID	uniqueID () const
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 ()
	This class's type info.

Protected Member Functions
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.
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
DtScribeBoxModelAgent *	myScribeBoxModelAgent
bool	myDisableModelScaling
bool	myEnableLocalModelScaling
float	myLocalModelScalingAmount
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

DtScribeBoxVisualizer class is used to visualize scribe boxes.

(as used for selection on 3D models, for example)

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtScribeBoxVisualizer::~DtScribeBoxVisualizer ( )

virtual

DTOR.

Member Function Documentation

void makVrv::DtScribeBoxVisualizer::setParent ( DtStateVisualizer *  )

virtual

Override to set the parent of this visualizer.

The parent is usually the scene object that will allow this visualizer to be displayed

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtScribeBoxVisualizer::setModelDefinitionForAgents ( )

virtual

Currently no model definition, so this does nothing (but required to exist)

Implements makVrv::DtStateVisualizer.

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

virtual

Sets selected state.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtScribeBoxVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef )

virtual

process the visual definition record

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtScribeBoxVisualizer::setDisableModelScaling ( bool  b )

virtual

Set whether model scaling is disabled (false by default)

virtual void makVrv::DtScribeBoxVisualizer::setLocalModelScalingEnabled ( bool  enabled )

virtual

Set whether local model scaling is enabled ( false by default )

virtual void makVrv::DtScribeBoxVisualizer::setLocalModelScalingAmount ( float  localScl )

virtual

Set the amount of local scaling to apply ( when enabled ).

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual void makVrv::DtScribeBoxVisualizer::createModelAgents ( )

protectedvirtual

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtScribeBoxVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

Member Data Documentation

DtScribeBoxModelAgent* makVrv::DtScribeBoxVisualizer::myScribeBoxModelAgent

protected

bool makVrv::DtScribeBoxVisualizer::myDisableModelScaling

protected

bool makVrv::DtScribeBoxVisualizer::myEnableLocalModelScaling

protected

float makVrv::DtScribeBoxVisualizer::myLocalModelScalingAmount

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtScribeBoxVisualizer.h