makVrv::DtVolumetricLineFacadeBase Class Reference

Contains DtVolumetricLineFacadeBase class. More...

Inheritance diagram for makVrv::DtVolumetricLineFacadeBase:

Public Member Functions
	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 void	setVisible (bool)
	Sets the object visible.
virtual const std::vector < DtVector > &	points () const
	Returns the points of the facade.
virtual void	setScribed (bool)
	Sets whether or not line is scribed.
virtual void	setPhysicalLineWidth (double)
	Sets the physical line width (in meters) of this volumetric line.
virtual double	physicalLineWidth () const
	Returns the physical line width.
virtual void	setPickable (bool)
	Sets whether or not item is pickable.
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.
virtual void	setOutlineWidth (int)=0
	Sets the width of the outside line. Default is 2.
virtual void	setSolid (bool)=0
	Sets whether or not this is a solid item.
virtual void	setUseDynamicOrigin (bool)=0
	If true, when the origin changes all the points move with the origin.
virtual void	setModelDefinition (const std::string &)=0
	Sets the model definition for the model.
virtual void	setColor (float r, float g, float b, float a)=0
	@ Color setting routines Sets the color for the line.
virtual void	setOutsideColor (float r, float g, float b, float a)=0
	Sets the outside color of the line, leaving the inside color alone.
virtual void	setInsideColor (float r, float g, float b, float a)=0
	Sets the inside color of the line, leaving the outside color along.

Protected Attributes
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 DtVolumetricLineFacadeBase class.

Facade interface for constructing volumetric line objects. See Dt2DVolumetricLineModel and Dt3DVolumetricLineModel for more information on the usage of these classes

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

makVrv::DtVolumetricLineFacadeBase::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 makVrv::DtVolumetricLineFacadeBase::~DtVolumetricLineFacadeBase ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtVolumetricLineFacadeBase::setPoints ( const std::vector< DtVector > &  , const DtVector &  withOffset = DtVector::zero()  )

virtual

Sets the points for the area.

If withOffset is specified, the offset is added to the supplied points

virtual void makVrv::DtVolumetricLineFacadeBase::addPoint ( int  index, const DtVector &    )

virtual

Adds a point to the line. Returns the index of the newly added point.

virtual void makVrv::DtVolumetricLineFacadeBase::removePoint ( int  )

virtual

Removes a point from the line.

virtual void makVrv::DtVolumetricLineFacadeBase::setOrigin ( const DtVector &  )

virtual

Sets the origin of the line.

virtual const DtVector& makVrv::DtVolumetricLineFacadeBase::origin ( ) const

virtual

virtual void makVrv::DtVolumetricLineFacadeBase::setPoint ( int  iIndex, const DtVector &    )

virtual

Sets position in the line.

If the index is > the number of current points on the line the point array is resized to the size of the index

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

virtual

Sets the object visible.

Reimplemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

virtual const std::vector<DtVector>& makVrv::DtVolumetricLineFacadeBase::points ( ) const

virtual

Returns the points of the facade.

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

virtual

Sets whether or not line is scribed.

Default is to do nothing. Implemented by subclasses that support line scribing.

Reimplemented in makVrv::Dt3DVolumetricLineFacade.

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

virtual

Sets the physical line width (in meters) of this volumetric line.

Reimplemented in makVrv::Dt2DVolumetricLineFacade, and makVrv::Dt3DVolumetricLineFacade.

virtual double makVrv::DtVolumetricLineFacadeBase::physicalLineWidth ( ) const

virtual

Returns the physical line width.

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

virtual

Sets whether or not item is pickable.

Reimplemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

virtual bool makVrv::DtVolumetricLineFacadeBase::pickable ( ) const

virtual

Returns whether or not item is pickable.

virtual makVrv::DtUniqueID makVrv::DtVolumetricLineFacadeBase::uniqueId ( ) const

virtual

Returns the unique id of the scene object agent.

virtual makVrv::DtElementID makVrv::DtVolumetricLineFacadeBase::elementId ( ) const

virtual

Returns the element id of the scene object agent.

virtual int makVrv::DtVolumetricLineFacadeBase::modelSet ( ) const

virtual

Returns the model set.

DtSceneObjectAgent* makVrv::DtVolumetricLineFacadeBase::sceneObjectAgent

(

)

const

Returns the scene object agent associated with this facade.

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

pure virtual

Sets the model definition for the model.

Pure methods that must be overridden to consider this class an implementation of a volumetric line

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure virtual

@ Color setting routines Sets the color for the line.

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure virtual

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

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure virtual

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

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure virtual

Sets the width of the outside line. Default is 2.

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure virtual

Sets whether or not this is a solid item.

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

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

pure 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

Implemented in makVrv::Dt3DVolumetricLineFacade, and makVrv::Dt2DVolumetricLineFacade.

Member Data Documentation

DtAgentManagerInterface& makVrv::DtVolumetricLineFacadeBase::myAgentManagerInterface

protected

DtSceneObjectAgent* makVrv::DtVolumetricLineFacadeBase::mySceneObjectAgent

protected

bool makVrv::DtVolumetricLineFacadeBase::myOwnsSceneObjectAgent

protected

double makVrv::DtVolumetricLineFacadeBase::myPhysicalLineWidth

protected

int makVrv::DtVolumetricLineFacadeBase::myOutlineWidth

protected

int makVrv::DtVolumetricLineFacadeBase::myModelSet

protected

bool makVrv::DtVolumetricLineFacadeBase::mySelected

protected

DtVector makVrv::DtVolumetricLineFacadeBase::myOrigin

protected

std::vector<DtVector> makVrv::DtVolumetricLineFacadeBase::myControlPoints

protected

bool makVrv::DtVolumetricLineFacadeBase::myPickable

protected

bool makVrv::DtVolumetricLineFacadeBase::myVisible

protected

makVrv::DtElementID makVrv::DtVolumetricLineFacadeBase::myElementId

protected

bool makVrv::DtVolumetricLineFacadeBase::myScribed

protected

---

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

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