DtRangeLineTextVisualizer Class Reference

DtRangeLineTextVisualizer will display the text of a range between two points on a line. More...

Inheritance diagram for DtRangeLineTextVisualizer:

Public Member Functions
	DtRangeLineTextVisualizer (makVrv::DtBaseConnection &simulation, makVrv::DtStateListener &listener, int modelSet)
	Constructor.
virtual	~DtRangeLineTextVisualizer ()
	Destructor.
virtual const makVrv::DtStateVisualizer::TypeInfo &	typeInfo () const
	Get this instances type info.
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 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 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
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 makVrv::DtStateVisualizer::TypeInfo &	theTypeInfo ()
	Get this class's type info.
static const makVrv::DtVisualizerSchema &	theRangeLineTextSchema ()
	Schema for this visualizer.

Protected Member Functions
virtual void	createModelAgents ()
	Creates all the agents needed to display the range line text.
virtual void	destroyModelAgents ()
	Destroyes all the agents.
virtual void	setVisualizerDefinition (const makVrv::DtVisualizerDefinition &visDef)
	Stores variables from visual definition to use when creating visualizer.
virtual void	setUniqueID (makVrv::DtUniqueID)
	Set the scene object id of the line object visualizing this range.
virtual void	setModelDefinitionForAgents ()
	No-op.
virtual void	setTextColor (float r, float g, float b, float a)
virtual void	getTextColor (float &r, float &g, float &b, float &a) const
virtual void	setTextBoxSize (unsigned int textWidth, unsigned int textHeight)
virtual void	getTextBoxSize (unsigned int &textWidth, unsigned int &textHeight) const
virtual void	setOriginOffset (int offsetX, int offsetY)
virtual void	getOriginOffset (int &offsetX, int &offsetY) const
virtual void	setHorizontalAlignment (unsigned int horizontalAlignment)
virtual unsigned int	horizontalAlignment () const
virtual void	setTextFont (std::string textFont)
virtual std::string	textFont () const
virtual void	setTextFontSize (unsigned int textFontSize)
virtual unsigned int	textFontSize () const
virtual void	setComputeToNextPoint (bool)
virtual bool	computeToNextPoint () const
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
makVrv::DtProjectedWidgetModelAgent *	myRangeLineTextModelAgent
makVrv::DtWidgetLabelAgent *	myRangeLineTextWidgetAgent
DtAttachableRangeLineTextUpdaterAgent *	myRangeLineTextUpdaterAgent
makVrv::DtSceneObjectAgent *	myRangeLineTextObjectAgent
unsigned int	myTextBoxSize [2]
unsigned int	myTextHorizontalAlignment
std::string	myTextFont
unsigned int	myTextFontSize
float	myTextColor [4]
int	myOriginOffset [2]
bool	myComputeToNextPoint
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

DtRangeLineTextVisualizer will display the text of a range between two points on a line.

by default the visualizer will show the range from the current to the previous point unless the "computetonextpoint" flag is set (off by default)

Constructor & Destructor Documentation

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

Constructor.

virtual DtRangeLineTextVisualizer::~DtRangeLineTextVisualizer ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Get this instances type info.

Implements makVrv::DtStateVisualizer.

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

static

Get this class's type info.

static const makVrv::DtVisualizerSchema& DtRangeLineTextVisualizer::theRangeLineTextSchema ( )

static

Schema for this visualizer.

virtual void DtRangeLineTextVisualizer::createModelAgents ( )

protectedvirtual

Creates all the agents needed to display the range line text.

Implements makVrv::DtStateVisualizer.

virtual void DtRangeLineTextVisualizer::destroyModelAgents ( )

protectedvirtual

Destroyes all the agents.

Implements makVrv::DtStateVisualizer.

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

protectedvirtual

Stores variables from visual definition to use when creating visualizer.

Reimplemented from makVrv::DtStateVisualizer.

virtual void DtRangeLineTextVisualizer::setUniqueID ( makVrv::DtUniqueID  )

protectedvirtual

Set the scene object id of the line object visualizing this range.

Reimplemented from makVrv::DtStateVisualizer.

virtual void DtRangeLineTextVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

No-op.

Implements makVrv::DtStateVisualizer.

virtual void DtRangeLineTextVisualizer::setTextColor ( float  r, float  g, float  b, float  a  )

protectedvirtual

virtual void DtRangeLineTextVisualizer::getTextColor ( float &  r, float &  g, float &  b, float &  a  ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setTextBoxSize ( unsigned int  textWidth, unsigned int  textHeight  )

protectedvirtual

virtual void DtRangeLineTextVisualizer::getTextBoxSize ( unsigned int &  textWidth, unsigned int &  textHeight  ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setOriginOffset ( int  offsetX, int  offsetY  )

protectedvirtual

virtual void DtRangeLineTextVisualizer::getOriginOffset ( int &  offsetX, int &  offsetY  ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setHorizontalAlignment ( unsigned int  horizontalAlignment )

protectedvirtual

virtual unsigned int DtRangeLineTextVisualizer::horizontalAlignment ( ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setTextFont ( std::string  textFont )

protectedvirtual

virtual std::string DtRangeLineTextVisualizer::textFont ( ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setTextFontSize ( unsigned int  textFontSize )

protectedvirtual

virtual unsigned int DtRangeLineTextVisualizer::textFontSize ( ) const

protectedvirtual

virtual void DtRangeLineTextVisualizer::setComputeToNextPoint ( bool  )

protectedvirtual

virtual bool DtRangeLineTextVisualizer::computeToNextPoint ( ) const

protectedvirtual

Member Data Documentation

makVrv::DtProjectedWidgetModelAgent* DtRangeLineTextVisualizer::myRangeLineTextModelAgent

protected

makVrv::DtWidgetLabelAgent* DtRangeLineTextVisualizer::myRangeLineTextWidgetAgent

protected

DtAttachableRangeLineTextUpdaterAgent* DtRangeLineTextVisualizer::myRangeLineTextUpdaterAgent

protected

makVrv::DtSceneObjectAgent* DtRangeLineTextVisualizer::myRangeLineTextObjectAgent

protected

unsigned int DtRangeLineTextVisualizer::myTextBoxSize[2]

protected

unsigned int DtRangeLineTextVisualizer::myTextHorizontalAlignment

protected

std::string DtRangeLineTextVisualizer::myTextFont

protected

unsigned int DtRangeLineTextVisualizer::myTextFontSize

protected

float DtRangeLineTextVisualizer::myTextColor[4]

protected

int DtRangeLineTextVisualizer::myOriginOffset[2]

protected

bool DtRangeLineTextVisualizer::myComputeToNextPoint

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/rangeLine/rangeLineVisualizer.h