makVrf::Dt3DEntityExtentVisualizer Class Reference

Dt3DEntityExtentVisualizer objects are responsible for displaying 3D representations of Entity extents. More...

Inheritance diagram for makVrf::Dt3DEntityExtentVisualizer:

Public Member Functions
	Dt3DEntityExtentVisualizer (makVrv::DtBaseConnection &simulation, makVrv::DtStateListener &listener, int modelSet)
	Constructor.
virtual	~Dt3DEntityExtentVisualizer ()
	Destructor.
virtual void	setDimensions (const DtVector &dim)
	Sets the dimensions of the cuboid (length is X, width is Y, height is Z)
virtual void	setColor (float r, float g, float b, float a)
	Sets the color of the cuboid.
virtual const makVrv::DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
virtual void	setVisible (bool)
	Hide the scribe box if not visible.
Public Member Functions inherited from makVrf::DtEntityExtentVisualizer
	DtEntityExtentVisualizer (makVrv::DtBaseConnection &simulation, makVrv::DtStateListener &listener, int modelSet)
	Constructor.
virtual	~DtEntityExtentVisualizer ()
	Destructor.
virtual void	setOffset (const DtVector &offset)
	Sets the offset of the cuboid in body coordinates (x = y, y = x, z = -z).
virtual void	setShowExtents (bool)
	Different in setVisible in that it will do a show/hide with the show/hide context of HiddenBySetting.
virtual void	setShowOnlyIfSelected (bool)
	Will show only if the item is also selected.
bool	showOnlyIfSelected () const
virtual void	setSelected (bool)
	Override to show/hide if show only if selected mode is on.
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 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 makVrv::DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info.
static const makVrv::DtVisualizerSchema &	theDt3DEntityExtentSchema ()
	Schema for this visualizer.

Protected Member Functions
virtual makVrv::DtModelAgent *	createExtentModelAgent ()
	Creates the cuboid object to visualize extents.
virtual void	createModelAgents ()
	Creates scribe agent, if requested.
virtual void	destroyModelAgents ()
	Destroys scribe agent.
virtual void	setVisualizerDefinition (const makVrv::DtVisualizerDefinition &visDef)
	Set initial values.
Protected Member Functions inherited from makVrf::DtEntityExtentVisualizer
virtual void	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using.
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::DtAttachableCuboidModelAgent *	myCuboidAgent
makVrv::DtScribeBoxModelAgent *	myScribeBox
double	myScribeWidth
bool	myScribeOccluded
bool	myScribeEnabled
bool	mySmoothScribeLine
Protected Attributes inherited from makVrf::DtEntityExtentVisualizer
makVrv::DtModelAgent *	myEntityExtentModelAgent
makVrv::DtAttachableUpdaterAgent *	myUpdater
makVrv::DtSceneObjectAgent *	myExtentVisualizerAgent
float	myColor [4]
DtVector	myDimensions
DtVector	myOffset
bool	myShowOnlyIfSelected
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

Dt3DEntityExtentVisualizer objects are responsible for displaying 3D representations of Entity extents.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrf::Dt3DEntityExtentVisualizer::~Dt3DEntityExtentVisualizer ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrf::Dt3DEntityExtentVisualizer::setDimensions ( const DtVector &  dim )

virtual

Sets the dimensions of the cuboid (length is X, width is Y, height is Z)

Reimplemented from makVrf::DtEntityExtentVisualizer.

virtual void makVrf::Dt3DEntityExtentVisualizer::setColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the color of the cuboid.

Reimplemented from makVrf::DtEntityExtentVisualizer.

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

static const makVrv::DtVisualizerSchema& makVrf::Dt3DEntityExtentVisualizer::theDt3DEntityExtentSchema ( )

static

Schema for this visualizer.

virtual void makVrf::Dt3DEntityExtentVisualizer::setVisible ( bool  )

virtual

Hide the scribe box if not visible.

Reimplemented from makVrf::DtEntityExtentVisualizer.

virtual makVrv::DtModelAgent* makVrf::Dt3DEntityExtentVisualizer::createExtentModelAgent ( )

protectedvirtual

Creates the cuboid object to visualize extents.

Implements makVrf::DtEntityExtentVisualizer.

virtual void makVrf::Dt3DEntityExtentVisualizer::createModelAgents ( )

protectedvirtual

Creates scribe agent, if requested.

Reimplemented from makVrf::DtEntityExtentVisualizer.

virtual void makVrf::Dt3DEntityExtentVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys scribe agent.

Reimplemented from makVrf::DtEntityExtentVisualizer.

virtual void makVrf::Dt3DEntityExtentVisualizer::setVisualizerDefinition ( const makVrv::DtVisualizerDefinition &  visDef )

protectedvirtual

Set initial values.

Reimplemented from makVrv::DtStateVisualizer.

Member Data Documentation

makVrv::DtAttachableCuboidModelAgent* makVrf::Dt3DEntityExtentVisualizer::myCuboidAgent

protected

makVrv::DtScribeBoxModelAgent* makVrf::Dt3DEntityExtentVisualizer::myScribeBox

protected

double makVrf::Dt3DEntityExtentVisualizer::myScribeWidth

protected

bool makVrf::Dt3DEntityExtentVisualizer::myScribeOccluded

protected

bool makVrf::Dt3DEntityExtentVisualizer::myScribeEnabled

protected

bool makVrf::Dt3DEntityExtentVisualizer::mySmoothScribeLine

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCore/3DEntityExtentVisualizer.h