DtOsg3DVolumetricLineModel is the model implementation of 3D volumetric lines. More...

Inheritance diagram for makVrv::DtOsg3DVolumetricLineModel:

Public Member Functions
	DtOsg3DVolumetricLineModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtOsg3DVolumetricLineModel ()
	DTOR.
virtual void	setColor (float r, float g, float b, float a)
	Set the inside and outside color of the line.
virtual void	setInsideColor (float r, float g, float b, float a)
	Set the color at the center of the volumetric line.
virtual void	getInsideColor (float &r, float &g, float &b, float &a)
	Retrieves the inside color.
virtual void	setOutsideColor (float r, float g, float b, float a)
	Set the color on the outside of the volumetric line.
virtual void	getOutsideColor (float &r, float &g, float &b, float &a)
	Retrieves the inside color.
virtual void	setPhysicalLineHeight (double height)
	Set the height (in meters) of the line.
virtual void	setPhysicalLineWidth (double height)
	Set the width (in meters) of the line.
virtual void	setDimensions (double w, double h)
	Sets the width and height of the line.
virtual void	setPickable (bool)
	Sets whether or not the line is selectable.
virtual void	setSolid (bool)
	Sets whether or not this volumetric line is filled or just outlined.
virtual void	setScribed (bool)
	Sets whether or not the line is scribed.
virtual void	setScribeColor (float r, float g, float b, float a)
	Set the scribe line color.
virtual void	setScribeWidth (float)
	Sets the width of the scribe line.
virtual void	addPoint (const DtVector &position, int index=-1)
	Add a new point on the volumetric line at specified index, or at the end if index is -1.
virtual void	removePoint (int index)
	Removes the point at the specified index.
virtual void	removePosition (int index)
	Calls removePoint.
virtual void	setPoint (int index, const DtVector &position)
	Sets the position of the point at the specified index.
virtual void	setPosition (int index, const DtVector &position)
	If index is 0, sets origin.
void	setOrigin (const DtVector &origin)
	Sets origin of this line.
virtual void	setVisible (bool isVisible)
	Sets whether or not line is visible.
virtual void	setFill (bool f)
	Sets whether or not the object is filled (top and bottom)
virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Sets line orientation. Only vtx 0 is used.
virtual void	setScribeAllPolygons (bool)
	Sets whether or not to only scribe the outline (and not the line edges).
virtual void	setIsSupportModel (bool isSupport)
	Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)
virtual void	setUseDynamicOrigin (bool)
	If true, when the origin changes all the points move with the origin.
virtual void	setModelDefinition (const std::string &str)
	Sets the model definition on the model instance.
Public Member Functions inherited from makVrv::Dt3DVolumetricLineModel
	Dt3DVolumetricLineModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~Dt3DVolumetricLineModel ()
	DTOR.
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	saveModelToFile (const std::string &filename)
virtual std::string	className () const
	Get the class name of the model instance owner.
unsigned int	transformSize () const
	Get the number of position/orientations this model has.
const DtVector &	position (int vtx=0) const
	Get the Position of a given point.
const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point.
virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model.
virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled.
virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color.
virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled.
virtual void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models
virtual int	modelSet () const
	Get the model set this model is part of.
const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance.
void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance.
const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance.
virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box.
void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume.
bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume.
DtDe &	de ()
	Get the DtDe object.
virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer.
virtual bool	visible () const
	Get the visible state of the model.
DtUniqueID	parentSceneObjectID () const
	Parent of the model.
virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop.
virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
	Called when a scene object added the model with the given model set and visualizer type.
virtual void	setElementId (DtUniqueID id)
	Called when the element ID of the model's parent object is set.
virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object.
virtual bool	isProp ()
	Return whether or not this model was added as a prop.
virtual DtModelInstance *	modelInstance ()
	Get the model instance.
virtual const DtModelInstance *	modelInstance () const
	Get the model instance.
int	visualizerType () const
	The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel.

Protected Member Functions
virtual void	update ()
	Called on tick when updated, calls updateGeometry() of model instance.
virtual void	needsUpdate ()
	Sets needs update flag such that on next update pass the object is updated.

virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	Attaches the model to the scene.
virtual void	removeFromScene ()
	Detaches the model from the scene.

Protected Attributes
DtOsgSceneConnector *	mySceneConnector
DtUniqueID	myParentId
DtVector	myOrigin
bool	myNeedsUpdate
bool	myGeometryChanged
float	myPhysicalLineWidth
float	myPhysicalLineHeight
bool	myUseDynamicOrigin
geos::geom::CoordinateSequence *	myCoordinateSequence
DtCoordTransform	myGeocentricToTopographicTransform
DtCoordTransform	myTopographicToGeocentricTransform

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed.
boost::signal< void(DtModel *)>	signal_modelChanged
boost::signal< bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
	Signal when the visibility has been requested, if any slot returns false, it will not change.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceCreated
	Signal emitted when the model instance is created.
boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed.
Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Detailed Description

DtOsg3DVolumetricLineModel is the model implementation of 3D volumetric lines.

Use this class to create a representation of a volumetric line that has an extruded width and extruded height. Since this class is more closely related to a closed polygonal area than a line with either width or height, this class is used rather than the DtOsgExtrudedLine model to calculate an extruded shape (width) around a the line itself as a closed figure. This can then be passed to the DtOsgExtrudedPolygonModel for rendering.

Constructor & Destructor Documentation

makVrv::DtOsg3DVolumetricLineModel::DtOsg3DVolumetricLineModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtOsg3DVolumetricLineModel::~DtOsg3DVolumetricLineModel ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Set the inside and outside color of the line.

Implements makVrv::Dt3DVolumetricLineModel.

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

virtual

Set the color at the center of the volumetric line.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::getInsideColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)

virtual

Retrieves the inside color.

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

virtual

Set the color on the outside of the volumetric line.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::getOutsideColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)

virtual

Retrieves the inside color.

virtual void makVrv::DtOsg3DVolumetricLineModel::setPhysicalLineHeight ( double height )

virtual

Set the height (in meters) of the line.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setPhysicalLineWidth ( double height )

virtual

Set the width (in meters) of the line.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setDimensions	(	double	w,
		double	h
	)

virtual

Sets the width and height of the line.

Implements makVrv::Dt3DVolumetricLineModel.

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

virtual

Sets whether or not the line is selectable.

Implements makVrv::Dt3DVolumetricLineModel.

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

virtual

Sets whether or not this volumetric line is filled or just outlined.

Implements makVrv::Dt3DVolumetricLineModel.

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

virtual

Sets whether or not the line is scribed.

Implements makVrv::Dt3DVolumetricLineModel.

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

virtual

Set the scribe line color.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setScribeWidth ( float )

virtual

Sets the width of the scribe line.

Implements makVrv::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::addPoint	(	const DtVector &	position,
		int	index = `-1`
	)

virtual

Add a new point on the volumetric line at specified index, or at the end if index is -1.

virtual void makVrv::DtOsg3DVolumetricLineModel::removePoint ( int index )

virtual

Removes the point at the specified index.

virtual void makVrv::DtOsg3DVolumetricLineModel::removePosition ( int index )

virtual

Calls removePoint.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setPoint	(	int	index,
		const DtVector &	position
	)

virtual

Sets the position of the point at the specified index.

virtual void makVrv::DtOsg3DVolumetricLineModel::setPosition	(	int	index,
		const DtVector &	position
	)

virtual

If index is 0, sets origin.

Reimplemented from makVrv::DtModel.

void makVrv::DtOsg3DVolumetricLineModel::setOrigin ( const DtVector & origin )

Sets origin of this line.

virtual void makVrv::DtOsg3DVolumetricLineModel::setVisible ( bool isVisible )

virtual

Sets whether or not line is visible.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setFill ( bool f )

virtual

Sets whether or not the object is filled (top and bottom)

virtual void makVrv::DtOsg3DVolumetricLineModel::setOrientation	(	int	vtx,
		const DtTaitBryan &	orientation
	)

virtual

Sets line orientation. Only vtx 0 is used.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setScribeAllPolygons ( bool )

virtual

Sets whether or not to only scribe the outline (and not the line edges).

Only valid if scribed is true. If set to true will scribe all point connections along the polygon. If false will only scribe the top and bottom of the polygon

virtual void makVrv::DtOsg3DVolumetricLineModel::setIsSupportModel ( bool isSupport )

virtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::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::Dt3DVolumetricLineModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::setModelDefinition ( const std::string & str )

virtual

Sets the model definition on the model instance.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::update ( )

protectedvirtual

Called on tick when updated, calls updateGeometry() of model instance.

virtual void makVrv::DtOsg3DVolumetricLineModel::needsUpdate ( )

protectedvirtual

Sets needs update flag such that on next update pass the object is updated.

virtual void makVrv::DtOsg3DVolumetricLineModel::addToScene	(	const DtUniqueID &	sceneObjectId,
		int	modelSet,
		int	visualizerType
	)

protectedvirtual

Attaches the model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsg3DVolumetricLineModel::removeFromScene ( )

protectedvirtual

Detaches the model from the scene.

Implements makVrv::DtModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsg3DVolumetricLineModel::mySceneConnector

protected

DtUniqueID makVrv::DtOsg3DVolumetricLineModel::myParentId

protected

DtVector makVrv::DtOsg3DVolumetricLineModel::myOrigin

protected

bool makVrv::DtOsg3DVolumetricLineModel::myNeedsUpdate

protected

bool makVrv::DtOsg3DVolumetricLineModel::myGeometryChanged

protected

float makVrv::DtOsg3DVolumetricLineModel::myPhysicalLineWidth

protected

float makVrv::DtOsg3DVolumetricLineModel::myPhysicalLineHeight

protected

bool makVrv::DtOsg3DVolumetricLineModel::myUseDynamicOrigin

protected

geos::geom::CoordinateSequence* makVrv::DtOsg3DVolumetricLineModel::myCoordinateSequence

protected

DtCoordTransform makVrv::DtOsg3DVolumetricLineModel::myGeocentricToTopographicTransform

protected

DtCoordTransform makVrv::DtOsg3DVolumetricLineModel::myTopographicToGeocentricTransform

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvOsg/DtOsg3DVolumetricLineModel.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation