VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
makVrv::DtOsgExtrudedPolygonModel Class Reference

OSG implementation of 3D Extruded Polygon. More...

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

Public Member Functions

 DtOsgExtrudedPolygonModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtOsgExtrudedPolygonModel ()
 DTOR.
virtual void addPoint (const DtVector &position, int index=-1)
 Add a new point on the Polygon 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.
virtual int pointCount () const
 Retrieves the number of points in the model.
virtual DtVector point (int) const
 Retrieves the point inclusive of the origin.
virtual void setOrigin (const DtVector &)
 Sets the origin.
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Sets the orientation of the Polygon.
virtual void setStipplePattern (unsigned int stipple)
 Parameters for Polygon stippling.
virtual void setColor (float r, float g, float b, float a)
 Sets the color of the Polygon.
virtual void setLockUpdates (bool)
 Will prevent changes from Polygon being taken. Call setLockUpdates(false) to flush all changes.
virtual void setSolid (bool solid)
 Sets shape solid or outPolygond only.
virtual void setFill (bool filled)
 Sets whether or not the polygon is filled or simply an outline.
virtual void setPickable (bool)
 Sets whether or not Polygon is pickable.
virtual void setVisible (bool)
 Sets model shown/hidden.
virtual void setUpExtent (float)
 Sets the height of the Polygon ("above" the origin point)
virtual void setDownExtent (float)
 Sets the height of the Polygon ("below" the origin point)
virtual void setHeight (float)
 Sets the height of the Polygon (-half height to + half height around center).
virtual void setDimensions (float width, float height)
 Sets the dimensions of the Polygon.
virtual void setLineWidth (float width)
 Sets the width of the line in pixel space, not world.
virtual void setScribed (bool b)
 Sets the Polygon to be scribed (default true)
virtual void setScribeColor (float r, float g, float b, float a)
 Sets the color of the scribe line.
virtual void setScribeOccluded (bool b)
 Sets the scribed Polygon to be occluded by the terrain (default true)
virtual void setTexturePath (const std::string &texturePath)
 Set the path to the polygon's texture.
virtual void setNumTextureTiles (double numTiles)
 Set the number of times to tile the polygon's texture.
virtual void setPolygonMode (int)
 Sets the polygon mode.
virtual void setUseDynamicOrigin (bool)
 Set whether or not to use dynamic origin.
- Public Member Functions inherited from makVrv::DtExtrudedPolygonModel
 DtExtrudedPolygonModel (DtDe &de, DtUniqueID id)
 Constructor.
 ~DtExtrudedPolygonModel ()
 Destructor.
virtual void setWidth (float)
 Override to no-op.
- Public Member Functions inherited from makVrv::DtPolygonModel
 DtPolygonModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtPolygonModel ()
 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 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 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 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 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.

Protected Member Functions

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.
virtual void setModelDefinition (const std::string &str)
 Sets the model definition on the model instance.

Protected Attributes

DtOsgSceneConnectormySceneConnector
DtUniqueID myParentId
DtVector myOrigin
bool myUseDynamicOrigin

Additional Inherited Members

- Public Types inherited from makVrv::DtExtrudedPolygonModel
enum  PolygonMode { TopAndBottom = 0, Top = 1, Bottom = 2 }
- 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

OSG implementation of 3D Extruded Polygon.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgExtrudedPolygonModel::~DtOsgExtrudedPolygonModel ( )
virtual

DTOR.

Member Function Documentation

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

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

Implements makVrv::DtPolygonModel.

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

Removes the point at the specified index.

Implements makVrv::DtPolygonModel.

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

Calls removePoint.

Reimplemented from makVrv::DtModel.

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

Sets the position of the point at the specified index.

Implements makVrv::DtPolygonModel.

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

If index is 0, sets origin.

Reimplemented from makVrv::DtModel.

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

Retrieves the number of points in the model.

Implements makVrv::DtExtrudedPolygonModel.

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

Retrieves the point inclusive of the origin.

Implements makVrv::DtExtrudedPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setOrigin ( const DtVector )
virtual

Sets the origin.

Implements makVrv::DtPolygonModel.

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

Sets the orientation of the Polygon.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setStipplePattern ( unsigned int  stipple)
virtual

Parameters for Polygon stippling.

Implements makVrv::DtPolygonModel.

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

Sets the color of the Polygon.

Implements makVrv::DtPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setLockUpdates ( bool  )
virtual

Will prevent changes from Polygon being taken. Call setLockUpdates(false) to flush all changes.

Implements makVrv::DtPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setSolid ( bool  solid)
virtual

Sets shape solid or outPolygond only.

If outPolygond only, and not scribed, will scribe the Polygon with color of alpha

Implements makVrv::DtModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setFill ( bool  filled)
virtual

Sets whether or not the polygon is filled or simply an outline.

Reimplemented from makVrv::DtPolygonModel.

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

Sets whether or not Polygon is pickable.

Implements makVrv::DtPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setVisible ( bool  )
virtual

Sets model shown/hidden.

Reimplemented from makVrv::DtModel.

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

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

Implements makVrv::DtExtrudedPolygonModel.

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

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

Implements makVrv::DtExtrudedPolygonModel.

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

Sets the height of the Polygon (-half height to + half height around center).

If width is set, will 0 out width or for the entire Polygon

Implements makVrv::DtExtrudedPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setDimensions ( float  width,
float  height 
)
virtual

Sets the dimensions of the Polygon.

Implements makVrv::DtExtrudedPolygonModel.

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

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

Clears out any existing dimensional size

Implements makVrv::DtExtrudedPolygonModel.

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

Sets the Polygon to be scribed (default true)

Implements makVrv::DtExtrudedPolygonModel.

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

Sets the color of the scribe line.

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

Implements makVrv::DtExtrudedPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setScribeOccluded ( bool  b)
virtual

Sets the scribed Polygon to be occluded by the terrain (default true)

Implements makVrv::DtExtrudedPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setTexturePath ( const std::string &  texturePath)
virtual

Set the path to the polygon's texture.

Implements makVrv::DtPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setNumTextureTiles ( double  numTiles)
virtual

Set the number of times to tile the polygon's texture.

Implements makVrv::DtPolygonModel.

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

Sets the polygon mode.

Implements makVrv::DtExtrudedPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::setUseDynamicOrigin ( bool  )
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

Implements makVrv::DtPolygonModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::addToScene ( const DtUniqueID sceneObjectId,
int  modelSet,
int  visualizerType 
)
protectedvirtual

Attaches the model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgExtrudedPolygonModel::removeFromScene ( )
protectedvirtual

Detaches the model from the scene.

Implements makVrv::DtModel.

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

Sets the model definition on the model instance.

Reimplemented from makVrv::DtModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgExtrudedPolygonModel::mySceneConnector
protected
DtUniqueID makVrv::DtOsgExtrudedPolygonModel::myParentId
protected
DtVector makVrv::DtOsgExtrudedPolygonModel::myOrigin
protected
bool makVrv::DtOsgExtrudedPolygonModel::myUseDynamicOrigin
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)