VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions
makVrv::DtPolygonModel Class Reference

Distributed model for drawing polygons with attached vertices. More...

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

Public Member Functions

 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 setLockUpdates (bool lock)=0
 Will either update or batch updates until a future unlock is given.
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.
- 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 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.
void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance.
void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
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 removedFromSceneObject ()
 Called when the model was removed from a scene object.
virtual void setSolid (bool isSolid)=0
 Set whether or not other scene objects can ground clamp to this model.
virtual DtModelInstancemodelInstance ()
 Get the model instance.
virtual const DtModelInstancemodelInstance () 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
DtDemyDe
const DtUniqueID myUniqueId

Detailed Description

Distributed model for drawing polygons with attached vertices.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtPolygonModel::~DtPolygonModel ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtPolygonModel::addPoint ( const DtVector point,
int  index 
)
pure virtual

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

Implemented in makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgPolygonModel, makVrv::DtOverlayRectangleModel, makVrv::DtOsgExtrudedCircleModel, and makVrv::DtOsgExtrudedPolygonModel.

virtual void makVrv::DtPolygonModel::setLockUpdates ( bool  lock)
pure virtual
virtual void makVrv::DtPolygonModel::setPickable ( bool  enabled)
pure virtual
virtual void makVrv::DtPolygonModel::removePoint ( int  index)
pure virtual
virtual int makVrv::DtPolygonModel::pointCount ( ) const
pure virtual
virtual DtVector makVrv::DtPolygonModel::point ( int  ) const
pure virtual
virtual void makVrv::DtPolygonModel::setPoint ( int  index,
const DtVector  
)
pure virtual

Sets point at the specified index.

When setting the point, if the origin is set, the vector will need to be offset from the origin as models will account for the origin set.

Implemented in makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgPolygonModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgExtrudedCircleModel, and makVrv::DtOsgExtrudedPolygonModel.

virtual void makVrv::DtPolygonModel::setOrigin ( const DtVector )
pure virtual
virtual void makVrv::DtPolygonModel::setStipplePattern ( unsigned int  stipplePattern)
pure virtual
virtual void makVrv::DtPolygonModel::setWidth ( float  width)
pure virtual
virtual void makVrv::DtPolygonModel::setTexturePath ( const std::string &  texturePath)
pure virtual
virtual void makVrv::DtPolygonModel::setNumTextureTiles ( double  numTiles)
pure virtual
virtual void makVrv::DtPolygonModel::setColor ( float  r,
float  g,
float  b,
float  a 
)
pure virtual
virtual void makVrv::DtPolygonModel::setUseDynamicOrigin ( bool  )
pure virtual

Set whether or not to use dynamic origin.

Will not cause redraw or recalulate, but will effect how point 0 is used when using setPosition. If true will not set the point 0 to be at the origin, but rather will respect the current value. Default is false

Implemented in makVrv::DtOsgExtrudedCircleModel, makVrv::DtOsgOverlayPolygonModel, makVrv::DtOsgOverlayRectangleModel, makVrv::DtOsgExtrudedPolygonModel, and makVrv::DtOsgPolygonModel.

virtual void makVrv::DtPolygonModel::setFill ( bool  )
virtual

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)