makVrv::DtExtrudedPolygonModel Class Reference

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

Inheritance diagram for makVrv::DtExtrudedPolygonModel:

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

Public Member Functions
	DtExtrudedPolygonModel (DtDe &de, DtUniqueID id)
	~DtExtrudedPolygonModel ()
virtual void	setPolygonMode (int)=0
virtual void	setHeight (float)=0
virtual void	setDimensions (float w, float h)=0
virtual int	pointCount () const =0
virtual DtVector	point (int) const =0
virtual void	setInsideColor (float r, float g, float b, float a)=0
virtual void	setOutsideColor (float r, float g, float b, float a)=0
virtual void	setLineWidth (float width)=0
virtual void	setScribeWidth (float width)=0
virtual void	setScribed (bool b)=0
virtual void	setScribeAllPolygons (bool)=0
virtual void	setScribeColor (float r, float g, float b, float a)=0
virtual void	setWidth (float)
virtual void	setUpExtent (float)=0
virtual void	setDownExtent (float)=0
virtual void	setLeftExtent (float)=0
virtual void	setRightExtent (float)=0
Public Member Functions inherited from makVrv::DtPolygonModel
	DtPolygonModel (DtDe &de, DtUniqueID id)
virtual	~DtPolygonModel ()
virtual void	addPoint (const DtVector &point, int index)=0
virtual void	setPickable (bool enabled)=0
virtual void	removePoint (int index)=0
virtual void	setPoint (int index, const DtVector &)=0
virtual void	setOrigin (const DtVector &)=0
virtual void	setStipplePattern (unsigned int stipplePattern)=0
virtual void	setTexturePath (const std::string &texturePath)=0
virtual void	setNumTextureTiles (double numTiles)=0
virtual void	setColor (float r, float g, float b, float a)=0
virtual void	setFill (bool)
virtual const std::vector < DtVector > &	points () const =0
Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)
virtual	~DtModel ()
DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)
virtual void	setModelDefinition (const std::string &str)
virtual const std::string &	modelDefinitionName ()
virtual void	saveModelToFile (const std::string &filename)
virtual const std::string &	className () const
virtual DtUniqueID	uniqueId () const
unsigned int	transformSize () const
virtual void	setPosition (int vtx, const DtVector &position)
virtual const DtVector &	position (int vtx=0) const
virtual void	removePosition (int vtx)
virtual void	setPositionOffset (const DtVector &positionOffset)
virtual const DtVector &	positionOffset () const
virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
virtual const DtTaitBryan &	orientation (int vtx=0) const
virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)
virtual const DtTaitBryan &	orientationOffset () const
virtual void	enableColorBlending (bool b)
virtual void	setBlendColor (float r, float g, float b, float a)
virtual void	getBlendColor (float &r, float &g, float &b, float &a)
virtual bool	colorBlendingEnabled () const
virtual void	enableLighting (bool l)
virtual DtModelSetId	modelSet () const
const DtVector &	boundingBoxExtents () const
void	getBoundingBoxExtents (double &x, double &y, double &z) const
const DtVector &	boundingBoxCenter () const
virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
void	setContributesToBound (bool trueOrFalse)
bool	contributesToBound () const
DtDe &	de ()
virtual void	setModelInstance (DtModelInstance *modelInstance)
virtual void	promoteBackgroundModelInstance (const DtModelDefinition &defintion)
virtual void	setVisible (bool isVisible)
virtual bool	visible () const
DtUniqueID	sceneObjectId () const
virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
virtual void	addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)
virtual void	setElementId (DtElementID id)
virtual void	removedFromSceneObject ()
virtual void	setIsSupportModel (bool isSupport)=0
virtual void	setSolid (bool isSolid)
virtual bool	isProp ()
virtual void	updateMinLastFrameDistance (float distance)
virtual void	resetLastFrameDistance ()
virtual float	minLastFrameDistance () const
virtual DtModelInstance *	modelInstance ()
virtual const DtModelInstance *	modelInstance () const
int	visualizerType () const
virtual bool	supportsMultithreadedLoad ()
virtual void	backgroundLoad ()
virtual void	foregroundLoad ()
virtual bool	isActivelyBackgroundLoading ()
virtual DtLoaderHandle *	getLoadQueueHandle ()

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed
boost::signalslib::signal < void(DtModel *)>	signal_modelChanged
boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
boost::signalslib::signal < void(DtModelInstance *, DtModel *)>	signal_modelInstanceCreated
boost::signalslib::signal < void(DtModelInstance *, DtModel *)>	signal_modelInstanceToBeDestroyed
Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList
Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, DtModelSetId modelSet, int visualizerType)=0
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
virtual void	removeFromScene ()=0
virtual void	initializeModelInstance ()
void	slot_modelInstanceChanged (DtModelInstance *instance)
virtual void	waitAndClearLoadHandle ()
virtual void	removedFromLoadQueue ()
virtual void	setDoneBackgroundLoading ()
virtual void	setActivelyBackgroundLoading ()
Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle
DtDe &	myDe
const DtUniqueID	myUniqueId
DtUniqueID	myElementId
DtUniqueID	myParentSceneObjectID
bool	myColorBlendingEnabled
DtModelInstance *	myBackgroundModelInstance
float	myMinLastFrameDistance
TransformList	myTransforms
DtModelInstance *	myModelInstance
DtModelSetId	myModelSet
int	myVisualizerType
bool	myContributesToBound
bool	myIsPropFlag
float	myBlendColor [4]
bool	myVisibleFlag
DtVector	myPositionOffset
DtTaitBryan	myOrientationOffset
std::string	myModelDefinitionName
bool	myRequireModelInstance = true
Static Protected Attributes inherited from makVrv::DtModel
static bool	theInittedState

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

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

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtExtrudedPolygonModel.h