![]() |
VR-Forces 4.10 Class Documentation
|
Interface class for an Overlay Spider Web Model. More...

Public Member Functions | |
| DtOverlaySpiderWebModel (DtDe &de, DtUniqueID id) | |
| CTOR. More... | |
| virtual | ~DtOverlaySpiderWebModel () |
| DTOR. More... | |
Model setters/getters (abstract) | |
| virtual void | setPosition (const DtVector &position)=0 |
| Set/Get the global position of the spider web. More... | |
| virtual DtVector | position () const =0 |
| virtual void | setOrientation (const DtTaitBryan &orientation)=0 |
| Set the global orientation of the spider web Calls to this function will override prior calls to setHeading. More... | |
| virtual DtTaitBryan | orientation () const =0 |
| virtual void | setHeading (float heading)=0 |
| Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation. More... | |
| virtual float | heading () const =0 |
| virtual void | setMaxAngleSegment (double angleSegmentMax)=0 |
| Set/Get the max angle segment used when building the spider web. More... | |
| virtual double | maxAngleSegment () const =0 |
| virtual void | setRadius (double x)=0 |
| Set/Get the radius (in meters) of the spider web. More... | |
| virtual double | radius () const =0 |
| virtual void | setScale (float scale)=0 |
| Set/Get the spider web's scale factor. More... | |
| virtual float | scale () const =0 |
| virtual void | setVisible (bool isVisible)=0 |
| Set/Get whether the spider web is visible. More... | |
| virtual bool | isVisible () const =0 |
| virtual void | setNumberOfSpokes (unsigned int numSpokes)=0 |
| Set/Get the number of spokes the spider web has. More... | |
| virtual unsigned int | numberOfSpokes () const =0 |
| virtual void | setNumberOfRings (unsigned int numRings)=0 |
| Set/Get the number of rings the spider web has Any prior call to setRingIntervalDistance(...) is ignored, the ring interval distance will be (radius / number_of_rings). More... | |
| virtual unsigned int | numberOfRings () const =0 |
| virtual void | setIsInnerRingFilled (bool filled)=0 |
| Set/Get whether the inner most ring of the spider web is filled. More... | |
| virtual bool | isInnerRingFilled () const =0 |
| virtual void | setRingIntervalDistance (double interval)=0 |
| Set/Get the ring interval distance for the spider web (in meters) Any prior call to setNumberOfRings(...) is ignored, the number of rings drawn will be (radius / ring_interval_distance). More... | |
| virtual double | ringIntervalDistance () const =0 |
| virtual void | setLineStipplePattern (unsigned int stipplePattern)=0 |
| Set/Get the line stipple pattern of the spider web. More... | |
| virtual unsigned int | lineStipplePattern () const =0 |
| virtual void | setLineWidth (float width)=0 |
| Set/Get the line width of the spider web. More... | |
| virtual float | lineWidth () const =0 |
| virtual void | setColor (float r, float g, float b, float a)=0 |
| Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0. More... | |
| virtual bool | getColor (float &r, float &g, float &b, float &a) const =0 |
| virtual void | setOpacity (float opacity)=0 |
| Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0. More... | |
| virtual float | opacity () const =0 |
| virtual void | setEventsEnabled (bool enabled)=0 |
| Set/Get to handle or not handle mouse events. More... | |
| virtual bool | eventsEnabled () const =0 |
| virtual void | setListenToDisplayUnitSettings (bool listen)=0 |
| Set/Get whether or not to listen to display unit settings. More... | |
| virtual bool | listenToDisplayUnitSettings () const =0 |
| virtual void | setGroup (int groupNum)=0 |
| Set/Get the group this overlay will be drawn in. More... | |
| virtual int | group () const =0 |
| virtual void | setIsDecorated (bool isDecorated)=0 |
| Set/Get whether or not this spider web is decorated. More... | |
| virtual bool | isDecorated () const =0 |
| virtual void | setFontFile (std::string fontFile)=0 |
| Set/Get the font file to use for the spider web. More... | |
| virtual std::string | fontFile () const =0 |
| virtual void | setFontPointSize (float pointSize)=0 |
| Set/Get the font point size for the spider web. More... | |
| virtual float | fontPointSize () const =0 |
| virtual void | setFontColor (float r, float g, float b, float a)=0 |
| Set/Get the font color for the spider web. More... | |
| virtual bool | getFontColor (float &r, float &g, float &b, float &a) const =0 |
| virtual void | setDistanceUnit (DtSharedDisplayUnitsSettings::DistanceUnits unit)=0 |
| Set/Get the distance unit to use for the spider web. More... | |
| virtual DtSharedDisplayUnitsSettings::DistanceUnits | distanceUnit () const =0 |
| virtual void | setDistanceDecimals (unsigned int decimals)=0 |
| Set/Get the number of decimals to use for distance for the spider web. More... | |
| virtual unsigned int | distanceDecimals () const =0 |
| virtual void | setOrientationUnit (DtSharedDisplayUnitsSettings::OrientationUnits unit)=0 |
| Set/Get the orientation unit to use for the spider web. More... | |
| virtual DtSharedDisplayUnitsSettings::OrientationUnits | orientationUnit () const =0 |
| virtual void | setOrientationDecimals (unsigned int decimals)=0 |
| Set/Get the number of decimals to use for orientation values. More... | |
| virtual unsigned int | orientationDecimals () const =0 |
| virtual void | setNorthUnit (DtSharedDisplayUnitsSettings::NorthUnits unit)=0 |
| Set/Get the north unit to use for the spider web. More... | |
| virtual DtSharedDisplayUnitsSettings::NorthUnits | northUnit () const =0 |
Public Member Functions inherited from makVrv::DtModel | |
| DtModel (DtDe &de, DtUniqueID id) | |
| CTOR. More... | |
| virtual | ~DtModel () |
| DTOR. More... | |
| DtModelInstance * | createModelInstance (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 DtVector & | position (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 DtVector & | positionOffset () 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 DtVector & | boundingBoxExtents () 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 DtVector & | boundingBoxCenter () 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... | |
| DtDe & | de () |
| 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 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 void | setSolid (bool isSolid) |
| Set whether or not other this model is drawn filled in. 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 DtModelInstance * | modelInstance () |
| Get the model instance. More... | |
| virtual const DtModelInstance * | modelInstance () 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 DtLoaderHandle * | getLoadQueueHandle () |
| returns the load queue object More... | |
Private Member Functions | |
| DtOverlaySpiderWebModel () | |
| Default Constructor not implemented. More... | |
| DtOverlaySpiderWebModel (const DtOverlaySpiderWebModel &) | |
| Copy Constructor not implemented – Copy not allowed. More... | |
| DtOverlaySpiderWebModel & | operator= (const DtOverlaySpiderWebModel &) |
| Assignment Operator not implemented – Copy not allowed. 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 | |
| DtLoaderHandle * | myInLoadQueueHandle |
| DtDe & | myDe |
| 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... | |
| DtModelInstance * | myBackgroundModelInstance |
| 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... | |
| DtModelInstance * | myModelInstance |
| 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 |
Interface class for an Overlay Spider Web Model.
An overlay model is positioned in 3D space and drawn onto a model set specific overlay.
A spider web is defined by: 1) An origin vertex, 2) a radius, 3) the number of spokes, and 4) the number of rings OR ring interval distance
A spider web has the following geometric parameters:
A spider web has the following style properties:
Special Considerations:
| makVrv::DtOverlaySpiderWebModel::DtOverlaySpiderWebModel | ( | DtDe & | de, |
| DtUniqueID | id | ||
| ) |
CTOR.
|
virtual |
DTOR.
|
private |
Default Constructor not implemented.
|
private |
Copy Constructor not implemented – Copy not allowed.
|
pure virtual |
Set/Get the global position of the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set the global orientation of the spider web Calls to this function will override prior calls to setHeading.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the max angle segment used when building the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the radius (in meters) of the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the spider web's scale factor.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get whether the spider web is visible.
Reimplemented from makVrv::DtModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the number of spokes the spider web has.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the number of rings the spider web has Any prior call to setRingIntervalDistance(...) is ignored, the ring interval distance will be (radius / number_of_rings).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get whether the inner most ring of the spider web is filled.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the ring interval distance for the spider web (in meters) Any prior call to setNumberOfRings(...) is ignored, the number of rings drawn will be (radius / ring_interval_distance).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the line stipple pattern of the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the line width of the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0.
Reimplemented from makVrv::DtModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get to handle or not handle mouse events.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get whether or not to listen to display unit settings.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the group this overlay will be drawn in.
The higher the group number, the "closer" to the eyepoint this overlay will be drawn. Use this function to stack overlay objects in the particular order you want them displayed.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get whether or not this spider web is decorated.
When a spider web is decorated, informative labels appear at each ring and spoke indicating the distance of the ring from the center and the angle of each spoke from North (True/Magnetic are supported).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the font file to use for the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the font point size for the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the font color for the spider web.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the distance unit to use for the spider web.
This function does nothing if setListenToDisplayUnitSettings(true).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the number of decimals to use for distance for the spider web.
This function does nothing if setListenToDisplayUnitSettings(true).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the orientation unit to use for the spider web.
This function does nothing if setListenToDisplayUnitSettings(true).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the number of decimals to use for orientation values.
This function does nothing if setListenToDisplayUnitSettings(true).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Set/Get the north unit to use for the spider web.
This function does nothing if setListenToDisplayUnitSettings(true).
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
pure virtual |
Implemented in makVrv::DtOsgOverlaySpiderWebModel.
|
private |
Assignment Operator not implemented – Copy not allowed.