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

DtOsg3DTextModel is a model class for creating attachable projected text. More...

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

Public Member Functions

 DtOsg3DTextModel (DtDe &de, DtUniqueID id)
virtual ~DtOsg3DTextModel ()
virtual void setVisible (bool visible)
 Set the visible state of the model.
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model.
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model.
virtual void setColor (float r, float g, float b, float a)
 Set the text's color in RGBA.
virtual void setFont (const std::string &fontName)
 Set the font for the 3D text.
virtual void setFontSize (double size)
 Set the font size in pixels.
virtual void setText (const std::string &text)
 Set the text to display.
virtual void setModelDefinition (const std::string &modelDefinition)
 Set the model definition.
virtual void setIsSupportModel (bool isSupport)
 Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)
- Public Member Functions inherited from makVrv::Dt3DTextModel
 Dt3DTextModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~Dt3DTextModel ()
 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.
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 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 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 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.

Protected Member Functions

virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
 Virtual Functions to be implemented, add this model to the scene.
virtual void removeFromScene ()
 Virtual Functions to be implemented, remove this model from the scene.
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer.

Protected Attributes

DtOsgSceneConnectormySceneConnector
Dt3DTextModelInstancemyTextModelInstance

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

Detailed Description

DtOsg3DTextModel is a model class for creating attachable projected text.

It creates its own model instance.

Constructor & Destructor Documentation

makVrv::DtOsg3DTextModel::DtOsg3DTextModel ( DtDe de,
DtUniqueID  id 
)
virtual makVrv::DtOsg3DTextModel::~DtOsg3DTextModel ( )
virtual

Member Function Documentation

virtual void makVrv::DtOsg3DTextModel::setVisible ( bool  isVisible)
virtual

Set the visible state of the model.

Parameters
[in]isVisibleis the new visible state; true = visible, false = hidden.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DTextModel::setPosition ( int  vtx,
const DtVector position 
)
virtual

Set the position of a control vertex in the model.

Reimplemented from makVrv::DtModel.

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

Set the orientation of a vertex in the model.

Reimplemented from makVrv::DtModel.

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

Set the text's color in RGBA.

Implements makVrv::Dt3DTextModel.

virtual void makVrv::DtOsg3DTextModel::setFont ( const std::string &  fontName)
virtual

Set the font for the 3D text.

Implements makVrv::Dt3DTextModel.

virtual void makVrv::DtOsg3DTextModel::setFontSize ( double  size)
virtual

Set the font size in pixels.

Implements makVrv::Dt3DTextModel.

virtual void makVrv::DtOsg3DTextModel::setText ( const std::string &  text)
virtual

Set the text to display.

Implements makVrv::Dt3DTextModel.

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

Set the model definition.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsg3DTextModel::setIsSupportModel ( bool  isSupport)
virtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

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

Virtual Functions to be implemented, add this model to the scene.

Implements makVrv::DtModel.

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

Virtual Functions to be implemented, remove this model from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsg3DTextModel::setModelInstance ( DtModelInstance modelInstance)
protectedvirtual

Internally set the model instance pointer.

If an existing model instance is set, it will be deleted. To clear the current model instance only, passing a Null pointer 0 is supported.

Warning
Only public for internal use
Parameters
Input
modelInstancepointer to a model instance.

Reimplemented from makVrv::DtModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsg3DTextModel::mySceneConnector
protected
Dt3DTextModelInstance* makVrv::DtOsg3DTextModel::myTextModelInstance
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)