makVrv::Dt3DVolumetricLineFacade Class Reference

Contains Dt3DLineFacade class. More...

Inheritance diagram for makVrv::Dt3DVolumetricLineFacade:

Public Member Functions
	Dt3DVolumetricLineFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	Dt3DVolumetricLineFacade (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~Dt3DVolumetricLineFacade ()
	DTOR.
virtual void	setSolid (bool)
	Sets the line solid (true) or outlined (false). Default is true.
virtual void	setModelDefinition (const std::string &)
	Sets the model definition for the model.
virtual void	setColor (float r, float g, float b, float a)
	@ Color setting routines Sets the color for the line.
virtual void	setOutsideColor (float r, float g, float b, float a)
	Sets the outside color of the line, leaving the inside color alone.
virtual void	setInsideColor (float r, float g, float b, float a)
	Sets the inside color of the line, leaving the outside color along.
virtual void	setPhysicalLineWidth (double)
	Sets the physical line width of the line. Default is 50.
virtual void	setPhysicalLineHeight (double)
	Sets the physical line height of of the line. Default is 50.
virtual double	physicalLineHeight () const
	Gets the physical line height.
virtual void	setVisible (bool)
	Sets the object visible.
virtual void	setOutlineWidth (int)
	No-op.
virtual void	setPickable (bool)
	Sets pickable or not.
virtual void	setScribed (bool)
	Sets whether or not line is scribed.
virtual void	setDimensions (float w, float h)
virtual void	setScribeColor (float r, float g, float b, float a)
	Sets the color of the scribe. By default it is based on outside color at 0% alpha.
virtual void	setScribeWidth (float width)
	Sets the width of the scribe line in pixel space.
virtual void	setUseDynamicOrigin (bool)
	If true, when the origin changes all the points move with the origin.
Dt3DVolumetricLineModelAgent *	volumetricLineModelAgent () const
	Model agent used by this class.
Public Member Functions inherited from makVrv::DtVolumetricLineFacadeBase
	DtVolumetricLineFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtVolumetricLineFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will DtVolumetricLineFacadeBase a new scene object agent for the given model set and element id.
virtual	~DtVolumetricLineFacadeBase ()
	DTOR.
virtual void	setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
	Sets the points for the area.
virtual void	addPoint (int index, const DtVector &)
	Adds a point to the line. Returns the index of the newly added point.
virtual void	removePoint (int)
	Removes a point from the line.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the line.
virtual const DtVector &	origin () const
virtual void	setPoint (int iIndex, const DtVector &)
	Sets position in the line.
virtual const std::vector < DtVector > &	points () const
	Returns the points of the facade.
virtual double	physicalLineWidth () const
	Returns the physical line width.
virtual bool	pickable () const
	Returns whether or not item is pickable.
virtual makVrv::DtUniqueID	uniqueId () const
	Returns the unique id of the scene object agent.
virtual makVrv::DtElementID	elementId () const
	Returns the element id of the scene object agent.
virtual int	modelSet () const
	Returns the model set.
DtSceneObjectAgent *	sceneObjectAgent () const
	Returns the scene object agent associated with this facade.

Protected Member Functions
void	createVolumetricLineAgent ()
	Creates the line agent. Called from constructor.

Protected Attributes
Dt3DVolumetricLineModelAgent *	myLine
bool	myScribeColorSet
float	myScribeWidth
double	myPhysicalLineHeight
float	myInsideColor [4]
float	myOutsideColor [4]
Protected Attributes inherited from makVrv::DtVolumetricLineFacadeBase
DtAgentManagerInterface &	myAgentManagerInterface
DtSceneObjectAgent *	mySceneObjectAgent
bool	myOwnsSceneObjectAgent
double	myPhysicalLineWidth
int	myOutlineWidth
int	myModelSet
bool	mySelected
DtVector	myOrigin
std::vector< DtVector >	myControlPoints
bool	myPickable
bool	myVisible
makVrv::DtElementID	myElementId
bool	myScribed

Detailed Description

Contains Dt3DLineFacade class.

Facade interface for constructing 3D volumetric line objects. See the Dt2DVolumetricLineModel and Dt3DVolumetricLineModel for documentation

Constructor & Destructor Documentation

makVrv::Dt3DVolumetricLineFacade::Dt3DVolumetricLineFacade	(	DtAgentManagerInterface &	,
		DtSceneObjectAgent *	agent,
		DtElementID	id,
		int	modelSet
	)

Constructor that will take an existing scene object agent.

makVrv::Dt3DVolumetricLineFacade::Dt3DVolumetricLineFacade	(	DtAgentManagerInterface &	,
		int	modelSet,
		DtElementID	id,
		bool	distribute = true
	)

Will create a new scene object agent for the given model set and element id.

virtual makVrv::Dt3DVolumetricLineFacade::~Dt3DVolumetricLineFacade ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::Dt3DVolumetricLineFacade::setSolid ( bool  )

virtual

Sets the line solid (true) or outlined (false). Default is true.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setModelDefinition ( const std::string &  )

virtual

Sets the model definition for the model.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setColor ( float  r, float  g, float  b, float  a  )

virtual

@ Color setting routines Sets the color for the line.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setOutsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the outside color of the line, leaving the inside color alone.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setInsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the inside color of the line, leaving the outside color along.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setPhysicalLineWidth ( double  )

virtual

Sets the physical line width of the line. Default is 50.

Reimplemented from makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setPhysicalLineHeight ( double  )

virtual

Sets the physical line height of of the line. Default is 50.

virtual double makVrv::Dt3DVolumetricLineFacade::physicalLineHeight ( ) const

virtual

Gets the physical line height.

virtual void makVrv::Dt3DVolumetricLineFacade::setVisible ( bool  )

virtual

Sets the object visible.

Reimplemented from makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setOutlineWidth ( int  )

inlinevirtual

No-op.

Implements makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setPickable ( bool  )

virtual

Sets pickable or not.

Reimplemented from makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setScribed ( bool  )

virtual

Sets whether or not line is scribed.

You will need to scribe a line if you want the edges of the line to appear separate from the body of the object. If you do not scribe the object the edges will be difficult to differentiate from the rest of the model

Reimplemented from makVrv::DtVolumetricLineFacadeBase.

virtual void makVrv::Dt3DVolumetricLineFacade::setDimensions ( float  w, float  h  )

virtual

virtual void makVrv::Dt3DVolumetricLineFacade::setScribeColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the color of the scribe. By default it is based on outside color at 0% alpha.

virtual void makVrv::Dt3DVolumetricLineFacade::setScribeWidth ( float  width )

virtual

Sets the width of the scribe line in pixel space.

This will set a flag such that when the line width is changed this width is not, so, once set, you will need to continue to set to keep pace with line width.

virtual void makVrv::Dt3DVolumetricLineFacade::setUseDynamicOrigin ( bool  )

virtual

If true, when the origin changes all the points move with the origin.

Default is false. This means that when the origin changes only point 0 moves

Implements makVrv::DtVolumetricLineFacadeBase.

Dt3DVolumetricLineModelAgent* makVrv::Dt3DVolumetricLineFacade::volumetricLineModelAgent

(

)

const

Model agent used by this class.

void makVrv::Dt3DVolumetricLineFacade::createVolumetricLineAgent ( )

protected

Creates the line agent. Called from constructor.

Member Data Documentation

Dt3DVolumetricLineModelAgent* makVrv::Dt3DVolumetricLineFacade::myLine

protected

bool makVrv::Dt3DVolumetricLineFacade::myScribeColorSet

protected

float makVrv::Dt3DVolumetricLineFacade::myScribeWidth

protected

double makVrv::Dt3DVolumetricLineFacade::myPhysicalLineHeight

protected

float makVrv::Dt3DVolumetricLineFacade::myInsideColor[4]

protected

float makVrv::Dt3DVolumetricLineFacade::myOutsideColor[4]

protected

---

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

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