VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtOverlayPolygonModel Class Reference

Distributed model for drawing polygons on the overlay layer. More...

Inheritance diagram for makVrv::DtOverlayPolygonModel:
Inheritance graph
[legend]

Public Member Functions

 DtOverlayPolygonModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtOverlayPolygonModel ()
 DTOR.
virtual void setEventsEnabled (bool)=0
 Sets whether or not events are enabled.
virtual void setEventWidth (float width)=0
 Sets the events line width for the polygon model if it is outlined.
virtual void set2dOffset (int index, float x, float y)=0
 Sets the 2D offset of a vertex.
virtual void set3dDirection2dLength (int index, float x, float y, float z, float len)=0
 Sets a 3D direction with a 2D length of a vertex.
virtual void setFillPattern (const std::vector< unsigned int > &)=0
 Sets the full fill pattern of the polygon.
virtual void setOutline (bool)=0
 Sets whether or not to outline the polygon with a scribe as if unfilled, even when filled.
virtual void setInsideColor (float r, float g, float b, float a)=0
 Set the color at the center of the ellipse.
virtual void setOutsideColor (float r, float g, float b, float a)=0
 Set the color on the outside of the ellipse.
virtual void setSolidFillCenter (bool)=0
 Sets to fill the center solid (if filled) not gradiant. Default is false.
virtual void setGroup (int)=0
 The higher the z order the "closer" to the eyepoint this element will be drawn.
virtual const DtVectororigin () const =0
 Get the origin of the polygon.
- 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 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 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 setWidth (float width)=0
 Set the line width.
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 DtVectorposition (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 DtVectorboundingBoxExtents () 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 DtVectorboundingBoxCenter () 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.
DtDede ()
 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 DtModelInstancemodelInstance ()
 Get the model instance.
virtual const DtModelInstancemodelInstance () const
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
DtDemyDe
const DtUniqueID myUniqueId
bool myColorBlendingEnabled

Detailed Description

Distributed model for drawing polygons on the overlay layer.

Constructor & Destructor Documentation

makVrv::DtOverlayPolygonModel::DtOverlayPolygonModel ( DtDe de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtOverlayPolygonModel::~DtOverlayPolygonModel ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtOverlayPolygonModel::setEventsEnabled ( bool  )
pure virtual

Sets whether or not events are enabled.

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

virtual void makVrv::DtOverlayPolygonModel::setEventWidth ( float  width)
pure virtual

Sets the events line width for the polygon model if it is outlined.

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

virtual void makVrv::DtOverlayPolygonModel::set2dOffset ( int  index,
float  x,
float  y 
)
pure virtual

Sets the 2D offset of a vertex.

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

virtual void makVrv::DtOverlayPolygonModel::set3dDirection2dLength ( int  index,
float  x,
float  y,
float  z,
float  len 
)
pure virtual

Sets a 3D direction with a 2D length of a vertex.

This only works with outline polygons.

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

virtual void makVrv::DtOverlayPolygonModel::setFillPattern ( const std::vector< unsigned int > &  )
pure virtual

Sets the full fill pattern of the polygon.

Must also call setFill to enable fill mode

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

virtual void makVrv::DtOverlayPolygonModel::setOutline ( bool  )
pure virtual

Sets whether or not to outline the polygon with a scribe as if unfilled, even when filled.

Only valid if fill is also true

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.

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

Set the color at the center of the ellipse.

Implemented in makVrv::DtOsgOverlayRectangleModel, and makVrv::DtOsgOverlayPolygonModel.

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

Set the color on the outside of the ellipse.

Implemented in makVrv::DtOsgOverlayRectangleModel, and makVrv::DtOsgOverlayPolygonModel.

virtual void makVrv::DtOverlayPolygonModel::setSolidFillCenter ( bool  )
pure virtual

Sets to fill the center solid (if filled) not gradiant. Default is false.

Implemented in makVrv::DtOsgOverlayRectangleModel, and makVrv::DtOsgOverlayPolygonModel.

virtual void makVrv::DtOverlayPolygonModel::setGroup ( int  )
pure virtual

The higher the z order the "closer" to the eyepoint this element will be drawn.

Use this variable to stack overlay objects in the particular order you want them displayed

Implemented in makVrv::DtOsgOverlayRectangleModel, and makVrv::DtOsgOverlayPolygonModel.

virtual const DtVector& makVrv::DtOverlayPolygonModel::origin ( ) const
pure virtual

Get the origin of the polygon.

Implemented in makVrv::DtOsgOverlayPolygonModel, and makVrv::DtOsgOverlayRectangleModel.


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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)