VR-Forces 4.3 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::DtOsgScribeBoxModel Class Reference

This is a realization of DtScribeBoxModel. More...

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

Public Member Functions

 DtOsgScribeBoxModel (DtDe &de, DtUniqueID &id)
 CTOR.
virtual ~DtOsgScribeBoxModel ()
 Virtual DTOR.
virtual void setOccluded (bool)
 Sets whether or not scribe is occluded (default is false)
virtual void setLineSmoothing (bool)
 Sets whether or not lines are smoothing.
virtual void setModelScalingEnabled (bool b)
 Indicate whether or not the scribe box may be model-scaled Default is false.
virtual void setLocalModelScalingEnabled (bool enabled)
 Set whether local model scaling is enabled ( false by default )
virtual void setLocalModelScalingAmount (float localScale)
 Set the amount of local scaling to apply ( when enabled ).
virtual void setColor (float r, float g, float b, float alpha)
 Sets the color of the scribe line.
virtual void setLineWidth (double lineWidth)
 Sets the width of the scribe line.
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 setSolid (bool solid)
 Set whether or not other scene objects can ground clamp to this model.
virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
 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 ()
 Virtual Functions to be implemented, remove this model from the scene.
- Public Member Functions inherited from makVrv::DtScribeBoxModel
 DtScribeBoxModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtScribeBoxModel ()
 DTOR.
- 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 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 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 Attributes

DtOsgSceneConnectormySceneConnector
osg::Vec4 myColor
double myLineWidth

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 initializeModelInstance ()
 Push any state maintained by the model to the model instance.
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed.

Detailed Description

This is a realization of DtScribeBoxModel.

It is a model class that is used to create bounding scribe boxes. It creates its own model instance. Renaming (when the Attachable- is removed from the class name) is recommended

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgScribeBoxModel::~DtOsgScribeBoxModel ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual void makVrv::DtOsgScribeBoxModel::setColor ( float  r,
float  g,
float  b,
float  alpha 
)
virtual

Sets the color of the scribe line.

Implements makVrv::DtScribeBoxModel.

virtual void makVrv::DtOsgScribeBoxModel::setLineWidth ( double  lineWidth)
virtual

Sets the width of the scribe line.

Implements makVrv::DtScribeBoxModel.

virtual void makVrv::DtOsgScribeBoxModel::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::DtOsgScribeBoxModel::setPosition ( int  vtx,
const DtVector position 
)
virtual

Set the position of a control vertex in the model.

Reimplemented from makVrv::DtModel.

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

Set the orientation of a vertex in the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgScribeBoxModel::setSolid ( bool  isSolid)
virtual

Set whether or not other scene objects can ground clamp to this model.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgScribeBoxModel::setOccluded ( bool  )
virtual

Sets whether or not scribe is occluded (default is false)

Implements makVrv::DtScribeBoxModel.

virtual void makVrv::DtOsgScribeBoxModel::setLineSmoothing ( bool  )
virtual

Sets whether or not lines are smoothing.

Default is false. If line smoothing is on and line is not occluded, drawing might look a little odd due to the fact that smoothing needs blending

Implements makVrv::DtScribeBoxModel.

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

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

Implements makVrv::DtModel.

virtual void makVrv::DtOsgScribeBoxModel::addToSceneAsProp ( const DtUniqueID sceneObjectId)
virtual

Add this model to the scene as a prop.

All models are not required to re-implement this

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgScribeBoxModel::removeFromScene ( )
virtual

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

Implements makVrv::DtModel.

virtual void makVrv::DtOsgScribeBoxModel::setModelScalingEnabled ( bool  b)
virtual

Indicate whether or not the scribe box may be model-scaled Default is false.

Implements makVrv::DtScribeBoxModel.

virtual void makVrv::DtOsgScribeBoxModel::setLocalModelScalingEnabled ( bool  enabled)
virtual

Set whether local model scaling is enabled ( false by default )

Implements makVrv::DtScribeBoxModel.

virtual void makVrv::DtOsgScribeBoxModel::setLocalModelScalingAmount ( float  localScale)
virtual

Set the amount of local scaling to apply ( when enabled ).

Implements makVrv::DtScribeBoxModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgScribeBoxModel::mySceneConnector
protected
osg::Vec4 makVrv::DtOsgScribeBoxModel::myColor
protected
double makVrv::DtOsgScribeBoxModel::myLineWidth
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)