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

Dt2DVolumetricLineModel is the model interface 2D volumetric lines. More...

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

Public Member Functions

 Dt2DVolumetricLineModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~Dt2DVolumetricLineModel ()
 DTOR. More...
 
virtual void setColor (float r, float g, float b, float a)=0
 Set the inside and outside color of the line. More...
 
virtual void setInsideColor (float r, float g, float b, float a)=0
 Set the inside color of the line if filled. More...
 
virtual void setOutsideColor (float r, float g, float b, float a)=0
 Set the outideside color of the line. More...
 
virtual void setUseDynamicOrigin (bool)=0
 If true, when the origin changes all the points move with the origin. More...
 
virtual void setOutlineWidth (float width)=0
 Set the width of the line. More...
 
virtual void setPhysicalLineWidth (double width)=0
 Width (in meters) of the line. More...
 
virtual void setEventsEnabled (bool)=0
 Sets whether or not the line is selectable. More...
 
virtual void setEventWidth (float)=0
 Sets the width of the selectable line area for handling events. More...
 
virtual void setSolid (bool)=0
 Sets whether or not this volumetric line is filled or just outlined. More...
 
virtual void setGroup (int)=0
 Sets the layer group on which to draw this object. More...
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtModel ()
 DTOR. More...
 
DtModelInstancecreateModelInstance (const std::string &modelDefName, bool realize=true)
 Set the model definition and creates an instance of the model. More...
 
virtual void setModelDefinition (const std::string &str)
 Set the model definition. More...
 
virtual const std::string & modelDefinitionName ()
 returns the model definition name. More...
 
virtual void saveModelToFile (const std::string &filename)
 
virtual const std::string & className () const
 Get the class name of the model instance owner. More...
 
unsigned int transformSize () const
 Get the number of position/orientations this model has. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model. More...
 
virtual const DtVectorposition (int vtx=0) const
 Get the Position of a given point. More...
 
virtual void removePosition (int vtx)
 Remove a transform at the given position. More...
 
virtual void setPositionOffset (const DtVector &positionOffset)
 Set the position offset of the model. More...
 
virtual const DtVectorpositionOffset () const
 Get the Position Offset of the model. More...
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model. More...
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 Set the position and orientation of a vertex in the model at the same time. More...
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 Get the Orientation of a given point. More...
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 Set the Orientation Offset of the model. More...
 
virtual const DtTaitBryan & orientationOffset () const
 Get the Orientation Offset of the model. More...
 
virtual void enableColorBlending (bool b)
 Enable / disable color blending for this model. More...
 
virtual void setBlendColor (float r, float g, float b, float a)
 Set color to use if color blending is enabled. More...
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 Returns the blend color. More...
 
virtual bool colorBlendingEnabled () const
 Returns whether or not blending is enabled. More...
 
virtual void enableLighting (bool l)
 set whether the model is lit; this may not be an option on all models More...
 
virtual int modelSet () const
 Get the model set this model is part of. More...
 
const DtVectorboundingBoxExtents () const
 Get the bounding box extents of the model instance. More...
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 Get the bounding box extents of the model instance. More...
 
const DtVectorboundingBoxCenter () const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get the minimum and maximum X,Y,Z components of the bounding box. More...
 
void setContributesToBound (bool trueOrFalse)
 Set whether this model instance contributes to an object's overall bounding volume. More...
 
bool contributesToBound () const
 Get whether this model instance contributes to an object's overall bounding volume. More...
 
DtDede ()
 Get the DtDe object. More...
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer. More...
 
virtual void promoteBackgroundModelInstance (DtModelDefinition &defintion)
 Internally set the model instance pointer to the background one, also realizes and sends signal. More...
 
virtual void setVisible (bool isVisible)
 Set the visible state of the model. More...
 
virtual bool visible () const
 Get the visible state of the model. More...
 
DtUniqueID parentSceneObjectID () const
 Parent of the model. More...
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 Called when a scene object added the model as a prop. More...
 
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. More...
 
virtual void setElementId (DtUniqueID id)
 Called when the element ID of the model's parent object is set. More...
 
virtual void removedFromSceneObject ()
 Called when the model was removed from a scene object. More...
 
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) More...
 
virtual bool isProp ()
 Return whether or not this model was added as a prop. More...
 
virtual void updateMinLastFrameDistance (float distance)
 updates the closest distance to an observer over the last frame More...
 
virtual void resetLastFrameDistance ()
 resets the closest distance to an observer More...
 
virtual float minLastFrameDistance () const
 gets the closest distance to an observer last frame More...
 
virtual DtModelInstancemodelInstance ()
 Get the model instance. More...
 
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. More...
 
virtual bool supportsMultithreadedLoad ()
 can be quickly overridden to disable background loading More...
 
virtual void backgroundLoad ()
 the chunk of loading that can safely happen in the background More...
 
virtual void foregroundLoad ()
 the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...
 
virtual bool isActivelyBackgroundLoading ()
 is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...
 
virtual DtLoaderHandlegetLoadQueueHandle ()
 returns the load queue object More...
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal
< void(DtModel *)> 
signal_modelToBeDestroyed
 Signal emitted when the model is to be destroyed. More...
 
boost::signalslib::signal
< void(DtModel *)> 
signal_modelChanged
 
boost::signalslib::signal
< bool(DtModel *, bool),
SlotReturnOR
signal_visibilityChangeRequested
 Signal when the visibility has been requested, if any slot returns false, it will not change. More...
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceCreated
 Signal emitted when the model instance is created. More...
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceToBeDestroyed
 Signal emitted when the model instance is to be destroyed. More...
 
- 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. More...
 
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop. More...
 
virtual void removeFromScene ()=0
 Virtual Functions to be implemented, remove this model from the scene. More...
 
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance. More...
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed. More...
 
virtual void waitAndClearLoadHandle ()
 avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...
 
virtual void removedFromLoadQueue ()
 deletes the myInLoadQueueHandle handle More...
 
virtual void setDoneBackgroundLoading ()
 called by async task, updates myCurrentlyLoading atomic More...
 
virtual void setActivelyBackgroundLoading ()
 called right before tbb task creation More...
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandlemyInLoadQueueHandle
 
DtDemyDe
 
const DtUniqueID myUniqueId
 The unique id is constant after initialization. More...
 
bool myColorBlendingEnabled
 The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...
 
DtModelInstancemyBackgroundModelInstance
 holds the model created in the background for a bit More...
 
float myMinLastFrameDistance
 last frames mimimal distance to the camera, calculated by the instancing system More...
 
TransformList myTransforms
 We keep our own copy in case we get updates before we get a model instance. More...
 
DtModelInstancemyModelInstance
 
int myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
DtUniqueID myParentSceneObjectID
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

Detailed Description

Dt2DVolumetricLineModel is the model interface 2D volumetric lines.

A 2D Volumetric line is a line model that can be given a meter width (think road). This will transform the line into a polygonal model that has half the length of the volume to the "left" of the line and the other half to the right. For example, if a line would normally look like:

X--—X--—X

A volumetric line with the same points would draw as:

!--------—! ! ! X--—X--—X ! ! !--------—!

By default this shape will be filled in with the outline color, however, you can also change the fill and color of the inside vs. outside.

The outline width, if set, will determine the thickness of the outline scribe of the volume

Constructor & Destructor Documentation

makVrv::Dt2DVolumetricLineModel::Dt2DVolumetricLineModel ( DtDe de,
DtUniqueID  id 
)
inline

CTOR.

virtual makVrv::Dt2DVolumetricLineModel::~Dt2DVolumetricLineModel ( )
inlinevirtual

DTOR.

Member Function Documentation

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

Set the inside and outside color of the line.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

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

Set the inside color of the line if filled.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

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

Set the outideside color of the line.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

virtual void makVrv::Dt2DVolumetricLineModel::setUseDynamicOrigin ( bool  )
pure virtual

If true, when the origin changes all the points move with the origin.

Default is false. This means that when the origin changes only point 0 moves

Implemented in makVrv::DtOsg2DVolumetricLineModel.

virtual void makVrv::Dt2DVolumetricLineModel::setOutlineWidth ( float  width)
pure virtual

Set the width of the line.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

virtual void makVrv::Dt2DVolumetricLineModel::setPhysicalLineWidth ( double  width)
pure virtual

Width (in meters) of the line.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

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

Sets whether or not the line is selectable.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

virtual void makVrv::Dt2DVolumetricLineModel::setEventWidth ( float  )
pure virtual

Sets the width of the selectable line area for handling events.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

virtual void makVrv::Dt2DVolumetricLineModel::setSolid ( bool  )
pure virtual

Sets whether or not this volumetric line is filled or just outlined.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsg2DVolumetricLineModel.

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

Sets the layer group on which to draw this object.

Implemented in makVrv::DtOsg2DVolumetricLineModel.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)