This class is a virtual class that all Extruded polygon models must implement. More...

Inheritance diagram for makVrv::DtExtrudedPolygonModel:

Public Types
enum	PolygonMode { TopAndBottom = 0, Top = 1, Bottom = 2 }

Public Member Functions
	DtExtrudedPolygonModel (DtDe &de, DtUniqueID id)
	Constructor.
	~DtExtrudedPolygonModel ()
	Destructor.
virtual void	setPolygonMode (int)=0
	Sets the display mode of the polygon.
virtual void	setHeight (float)=0
	Sets the height of the polygon ("up/down" the origin point).
virtual void	setDimensions (float w, float h)=0
	Sets the dimensions of the outline of the circle to have width and height.
virtual int	pointCount () const =0
	Retrieves the number of points in the model.
virtual DtVector	point (int) const =0
	Retrieves the point (inclusive of the origin)
virtual void	setInsideColor (float r, float g, float b, float a)=0
	Set the inside color of the polygon, if filled.
virtual void	setOutsideColor (float r, float g, float b, float a)=0
	Set the outside color of the polygon (essentially the same as setColor)
virtual void	setLineWidth (float width)=0
	Sets the width of the line in pixel space, not world.
virtual void	setScribeWidth (float width)=0
	Sets the width of the scribe line in pixel space.
virtual void	setScribed (bool b)=0
	Sets the line to be scribed (default true)
virtual void	setScribeAllPolygons (bool)=0
	Sets whether or not to only scribe the outline (and not the line edges).
virtual void	setScribeColor (float r, float g, float b, float a)=0
	Sets the color of the scribe line.
virtual void	setWidth (float)
	Override to no-op.

virtual void	setUpExtent (float)=0
	Sets the height of the polygon ("above" the origin point)
virtual void	setDownExtent (float)=0
	Sets the height of the polygon ("below" the origin point)
virtual void	setLeftExtent (float)=0
	Sets the height of the polygon ("left" of the origin point)
virtual void	setRightExtent (float)=0
	Sets the height of the polygon ("right" of the origin point)
Public Member Functions inherited from makVrv::DtPolygonModel
	DtPolygonModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtPolygonModel ()
	DTOR.
virtual void	addPoint (const DtVector &point, int index)=0
	Add a new point to the line at the specified index, or, at the end if index is -1.
virtual void	setPickable (bool enabled)=0
	Sets whether or not the line is pickable.
virtual void	removePoint (int index)=0
	Removes the point from the specified index.
virtual void	setPoint (int index, const DtVector &)=0
	Sets point at the specified index.
virtual void	setOrigin (const DtVector &)=0
	Sets the origin. Will offset points.
virtual void	setStipplePattern (unsigned int stipplePattern)=0
	Sets stipple pattern for the polygon.
virtual void	setTexturePath (const std::string &texturePath)=0
	Set the path to the polygon's texture.
virtual void	setNumTextureTiles (double numTiles)=0
	Set the number of times to tile the polygon's texture.
virtual void	setColor (float r, float g, float b, float a)=0
	Set the color of the polygon.
virtual void	setUseDynamicOrigin (bool)=0
	Set whether or not to use dynamic origin.
virtual void	setFill (bool)
	Calls setSolid.
virtual const std::vector < DtVector > &	points () const =0
	Returns the vertices (local database coordinates) that are used to draw this linear object.
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
	CTOR.
virtual	~DtModel ()
	DTOR.
virtual void	setModelDefinition (const std::string &str)
	Set the model definition.
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.
virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model.
virtual void	removePosition (int vtx)
	Remove a transform at the given position.
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	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model.
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 void	setVisible (bool isVisible)
	Set the visible state of the model.
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 void	setIsSupportModel (bool isSupport)=0
	Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model)
virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in.
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.

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
Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
	Virtual Functions to be implemented, add this model to the scene.
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop.
virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene.
virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance.
void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed.
Protected Attributes inherited from makVrv::DtModel
DtDe &	myDe
const DtUniqueID	myUniqueId
bool	myColorBlendingEnabled

Detailed Description

This class is a virtual class that all Extruded polygon models must implement.

Member Enumeration Documentation

enum makVrv::DtExtrudedPolygonModel::PolygonMode

Enumerator:

TopAndBottom
Top	Place face to fill polygon at top and bottom of polygon.
Bottom	Place face at top of polygon.

Constructor & Destructor Documentation

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

Constructor.

makVrv::DtExtrudedPolygonModel::~DtExtrudedPolygonModel ( )

Destructor.

Member Function Documentation

virtual void makVrv::DtExtrudedPolygonModel::setPolygonMode ( int )

pure virtual

Sets the display mode of the polygon.

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setUpExtent ( float )

pure virtual

Sets the height of the polygon ("above" the origin point)

Sets the values of the extents of the line. Extents of the line are different than the width or height in that in setting the width or height those are centered around the points. The extents work from the point and move in the direction of the extent in topographic space. For example, if you imagine a straight line, the up extent moves straight up from that line, the down extent straight down, left to the left and right to the right. As the line rotates and orients the extents orient and rotate with that line

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setDownExtent ( float )

pure virtual

Sets the height of the polygon ("below" the origin point)

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setLeftExtent ( float )

pure virtual

Sets the height of the polygon ("left" of the origin point)

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setRightExtent ( float )

pure virtual

Sets the height of the polygon ("right" of the origin point)

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setHeight ( float )

pure virtual

Sets the height of the polygon ("up/down" the origin point).

If width is set, will zero out width and only contain height or for the entire polygon

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

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

pure virtual

Sets the dimensions of the outline of the circle to have width and height.

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual int makVrv::DtExtrudedPolygonModel::pointCount ( ) const

pure virtual

Retrieves the number of points in the model.

Implements makVrv::DtPolygonModel.

Implemented in makVrv::DtOsgExtrudedEllipseModel, and makVrv::DtOsgExtrudedPolygonModel.

virtual DtVector makVrv::DtExtrudedPolygonModel::point ( int ) const

pure virtual

Retrieves the point (inclusive of the origin)

Implements makVrv::DtPolygonModel.

Implemented in makVrv::DtOsgExtrudedEllipseModel, and makVrv::DtOsgExtrudedPolygonModel.

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

pure virtual

Set the inside color of the polygon, if filled.

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

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

pure virtual

Set the outside color of the polygon (essentially the same as setColor)

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setLineWidth ( float width )

pure virtual

Sets the width of the line in pixel space, not world.

Clears out any existing dimensional size

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

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

pure 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.

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setScribed ( bool b )

pure virtual

Sets the line to be scribed (default true)

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

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

pure 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

Implemented in makVrv::DtOsgExtrudedEllipseModel, and makVrv::DtOsgExtrudedPolygonModel.

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

pure virtual

Sets the color of the scribe line.

Once set it will always be different than the color of the main polygon

Implemented in makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgExtrudedEllipseModel.

virtual void makVrv::DtExtrudedPolygonModel::setWidth ( float )

virtual

Override to no-op.

Implements makVrv::DtPolygonModel.

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

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation