![]() |
VR-Forces Developer's Guide
|
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:

Public Types | |
| enum | DtListenToDisplayUnitSettingIndex { DtListenToDisplayUnitSettingIndex::North, DtListenToDisplayUnitSettingIndex::Orientation, DtListenToDisplayUnitSettingIndex::Distance } |
Public Member Functions | |
| DtOverlaySpiderWebModel (DtDe &de, DtUniqueID id) | |
| DtOverlaySpiderWebModel ()=delete | |
| DtOverlaySpiderWebModel (const DtOverlaySpiderWebModel &)=delete | |
| DtOverlaySpiderWebModel & | operator= (const DtOverlaySpiderWebModel &)=delete |
| virtual | ~DtOverlaySpiderWebModel () |
| virtual void | setModelDefinition (const std::string &str) |
| virtual void | setAltitudeBasedConfigurations (const makArchives::DtAltitudeBasedScaleConfigurationRecordCollection &configs) |
| virtual void | clearAltitudeBasedConfigurations () |
| virtual void | setLodOutAltitude (double lodOutAltitude) |
| virtual void | setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled) |
Model setters/getters (abstract) | |
| virtual void | setPosition (const DtVector &position) |
| virtual DtVector | position () const |
| virtual void | setPosition (int vtx, const DtVector &position) override |
| virtual void | setOrientation (const DtTaitBryan &orientation) |
| virtual DtTaitBryan | orientation () const |
| virtual void | setHeading (float heading) |
| virtual float | heading () const |
| virtual void | setMaxAngleSegment (double angleSegmentMax) |
| virtual double | maxAngleSegment () const |
| virtual void | setRadius (double x) |
| virtual double | radius () const |
| virtual void | setScale (float scale) |
| virtual float | scale () const |
| virtual void | setVisible (bool isVisible) |
| virtual bool | isVisible () const |
| virtual void | setNumberOfSpokes (unsigned int numSpokes) |
| virtual unsigned int | numberOfSpokes () const |
| virtual void | setNumberOfRings (unsigned int numRings) |
| virtual unsigned int | numberOfRings () const |
| virtual void | setIsInnerRingFilled (bool filled) |
| virtual bool | isInnerRingFilled () const |
| virtual void | setRingIntervalDistance (double interval) |
| virtual double | ringIntervalDistance () const |
| virtual void | setLineStipplePattern (unsigned int stipplePattern) |
| virtual unsigned int | lineStipplePattern () const |
| virtual void | setLineWidth (float width) |
| virtual float | lineWidth () const |
| virtual void | setColor (float r, float g, float b, float a) |
| virtual bool | getColor (float &r, float &g, float &b, float &a) const |
| virtual void | setOpacity (float opacity) |
| virtual float | opacity () const |
| virtual void | setEventsEnabled (bool enabled) |
| virtual bool | eventsEnabled () const |
| virtual void | setListenToNorthDisplayUnitSettings (bool listenToNorthUnitToUse) |
| virtual bool | listenToNorthDisplayUnitSettings () const |
| virtual void | setListenToOrientationDisplayUnitSettings (bool listenToOrientationUnitToUse) |
| virtual bool | listenToOrientationDisplayUnitSettings () const |
| virtual void | setListenToDistanceDisplayUnitSettings (bool listenToDistanceUnitToUse) |
| virtual bool | listenToDistanceDisplayUnitSettings () const |
| virtual void | setGroup (int groupNum) |
| virtual int | group () const |
| virtual void | setIsDecorated (bool isDecorated) |
| virtual bool | isDecorated () const |
| virtual void | setFontFile (std::string fontFile) |
| virtual std::string | fontFile () const |
| virtual void | setFontPointSize (float pointSize) |
| virtual float | fontPointSize () const |
| virtual void | setFontColor (float r, float g, float b, float a) |
| virtual bool | getFontColor (float &r, float &g, float &b, float &a) const |
| virtual void | setDistanceUnit (DtSharedDisplayUnitsSettings::DistanceUnits unit) |
| virtual DtSharedDisplayUnitsSettings::DistanceUnits | distanceUnit () const |
| virtual void | setDistanceDecimals (unsigned int decimals) |
| virtual unsigned int | distanceDecimals () const |
| virtual void | setOrientationUnit (DtSharedDisplayUnitsSettings::OrientationUnits unit) |
| virtual DtSharedDisplayUnitsSettings::OrientationUnits | orientationUnit () const |
| virtual void | setOrientationDecimals (unsigned int decimals) |
| virtual unsigned int | orientationDecimals () const |
| virtual void | setNorthUnit (DtSharedDisplayUnitsSettings::NorthUnits unit) |
| virtual DtSharedDisplayUnitsSettings::NorthUnits | northUnit () const |
Public Member Functions inherited from makVrv::DtModel | |
| DtModel (DtDe &de, DtUniqueID id) | |
| virtual | ~DtModel () |
| DtModelInstance * | createModelInstance (const std::string &modelDefName, bool realize=true) |
| virtual const std::string & | modelDefinitionName () |
| virtual void | saveModelToFile (const std::string &filename) |
| virtual const std::string & | className () const |
| virtual DtUniqueID | uniqueId () const |
| unsigned int | transformSize () const |
| virtual const DtVector & | position (int vtx=0) const |
| virtual void | removePosition (int vtx) |
| virtual void | setPositionOffset (const DtVector &positionOffset) |
| virtual const DtVector & | positionOffset () const |
| virtual void | setOrientation (int vtx, const DtTaitBryan &orientation) |
| virtual void | setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation) |
| virtual const DtTaitBryan & | orientation (int vtx=0) const |
| virtual void | setOrientationOffset (const DtTaitBryan &orientationOffset) |
| virtual const DtTaitBryan & | orientationOffset () const |
| virtual void | enableColorBlending (bool b) |
| virtual void | setBlendColor (float r, float g, float b, float a) |
| virtual void | getBlendColor (float &r, float &g, float &b, float &a) |
| virtual bool | colorBlendingEnabled () const |
| virtual void | enableLighting (bool l) |
| virtual DtModelSetId | modelSet () const |
| const DtVector & | boundingBoxExtents () const |
| void | getBoundingBoxExtents (double &x, double &y, double &z) const |
| const DtVector & | boundingBoxCenter () const |
| virtual void | getBoundingBoxCenter (double &x, double &y, double &z) const |
| virtual void | getBoundingBoxComponents (DtVector &minimum, DtVector &maximum) |
| void | setContributesToBound (bool trueOrFalse) |
| bool | contributesToBound () const |
| DtDe & | de () |
| virtual void | setModelInstance (DtModelInstance *modelInstance) |
| virtual void | promoteBackgroundModelInstance (const DtModelDefinition &defintion) |
| virtual bool | visible () const |
| DtUniqueID | sceneObjectId () const |
| virtual void | addedToSceneObjectAsProp (const DtUniqueID &sceneObj) |
| virtual void | addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType) |
| virtual void | setElementId (DtElementID id) |
| virtual void | removedFromSceneObject () |
| virtual void | setSolid (bool isSolid) |
| virtual bool | isProp () |
| virtual void | updateMinLastFrameDistance (float distance) |
| virtual void | resetLastFrameDistance () |
| virtual float | minLastFrameDistance () const |
| virtual DtModelInstance * | modelInstance () |
| virtual const DtModelInstance * | modelInstance () const |
| int | visualizerType () const |
| virtual bool | supportsMultithreadedLoad () |
| virtual void | backgroundLoad () |
| virtual void | foregroundLoad () |
| virtual bool | isActivelyBackgroundLoading () |
| virtual DtLoaderHandle * | getLoadQueueHandle () |
Protected Member Functions | |
| virtual bool | listenToDisplayUnitSignals () const |
| virtual void | setOverlay (unsigned int overlayId) |
| virtual void | update () |
| virtual void | render () |
| virtual void | recreateSpiderWeb () |
| virtual void | createSpiderWebIfNecessary () |
| virtual void | deleteSpiderWeb () |
| virtual void | updateColors () |
| virtual void | updateAltitudeBasedConfigurationsForLabels () |
| virtual void | set3DPositionAux (double x, double y, double z, float tempPackedCoords[4]) |
| virtual void | setSpokeVertexPosition (unsigned int spokeIndex, unsigned int vertexIndex, double x, double y, double z) |
| virtual void | setRingVertexPosition (unsigned int ringIndex, unsigned int vertexIndex, double x, double y, double z) |
| virtual void | setLabelPosition (unsigned int labelIndex, double x, double y, double z) |
| virtual void | slot_displayUnitUnitChanged (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int newUnit, unsigned int oldUnit) |
| virtual void | slot_displayUnitDecimalsChanged (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int newDecimals, unsigned int oldDecimals) |
| virtual void | slot_coordinateSystemChanged () |
| virtual void | addToScene (const DtUniqueID &sceneObjectId, DtModelSetId modelSet, int visualizerType) |
| virtual void | removeFromScene () |
| virtual void | setIsSupportModel (bool isSupport) |
Protected Member Functions inherited from makVrv::DtModel | |
| virtual void | addToSceneAsProp (const DtUniqueID &sceneObjectId) |
| virtual void | initializeModelInstance () |
| void | slot_modelInstanceChanged (DtModelInstance *instance) |
| virtual void | waitAndClearLoadHandle () |
| virtual void | removedFromLoadQueue () |
| virtual void | setDoneBackgroundLoading () |
| virtual void | setActivelyBackgroundLoading () |
Additional Inherited Members | |
Public Attributes inherited from makVrv::DtModel | |
| boost::signalslib::signal < void(DtModel *)> | signal_modelToBeDestroyed |
| boost::signalslib::signal < void(DtModel *)> | signal_modelChanged |
| boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR > | signal_visibilityChangeRequested |
| boost::signalslib::signal < void(DtModelInstance *, DtModel *)> | signal_modelInstanceCreated |
| boost::signalslib::signal < void(DtModelInstance *, DtModel *)> | signal_modelInstanceToBeDestroyed |
Protected Types inherited from makVrv::DtModel | |
| typedef std::vector < ObjectTransform > | TransformList |
Static Protected Attributes inherited from makVrv::DtModel | |
| static bool | theInittedState |
| makVrv::DtOverlaySpiderWebModel::DtOverlaySpiderWebModel | ( | DtDe & | de, |
| DtUniqueID | id | ||
| ) |
CTOR.
|
delete |
Default Constructor not implemented.
|
delete |
Copy Constructor not implemented – Copy not allowed.
|
virtual |
DTOR.
|
delete |
Assignment Operator not implemented – Copy not allowed.
|
virtual |
Sets the model definition on the model instance.
Reimplemented from makVrv::DtModel.
|
virtual |
Set/Get the global position of the spider web.
|
virtual |
Set/Get the global position of the spider web.
|
overridevirtual |
Set the position of a control vertex in the model.
Reimplemented from makVrv::DtModel.
|
virtual |
Set the global orientation of the spider web Calls to this function will override prior calls to setHeading.
|
virtual |
Set the global orientation of the spider web Calls to this function will override prior calls to setHeading.
|
virtual |
Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation.
|
virtual |
Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation.
|
virtual |
Set/Get the max angle segment used when building the spider web.
|
virtual |
Set/Get the max angle segment used when building the spider web.
|
virtual |
Set/Get the radius (in meters) of the spider web.
|
virtual |
Set/Get the radius (in meters) of the spider web.
|
virtual |
Set/Get the spider web's scale factor.
|
virtual |
Set/Get the spider web's scale factor.
|
virtual |
Set/Get whether the spider web is visible.
Reimplemented from makVrv::DtModel.
|
virtual |
Set/Get whether the spider web is visible.
Set/Get the number of spokes the spider web has.
Set/Get the number of spokes the spider web has.
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).
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).
|
virtual |
Set/Get whether the inner most ring of the spider web is filled.
|
virtual |
Set/Get whether the inner most ring of the spider web is filled.
|
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).
|
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).
|
virtual |
Set/Get the line stipple pattern of the spider web.
Set/Get the line stipple pattern of the spider web.
|
virtual |
Set/Get the line width of the spider web.
|
virtual |
Set/Get the line width of the spider web.
|
virtual |
Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0.
Reimplemented from makVrv::DtModel.
|
virtual |
Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0.
|
virtual |
Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0.
|
virtual |
Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0.
|
virtual |
Set/Get to handle or not handle mouse events.
|
virtual |
Set/Get to handle or not handle mouse events.
|
virtual |
Set/Get whether or not to listen to display unit settings for which North to use. Default value is true.
|
virtual |
Set/Get whether or not to listen to display unit settings for which North to use. Default value is true.
|
virtual |
Set/Get whether or not to listen to display unit settings for which Orientation unit to use. Default value is true.
|
virtual |
Set/Get whether or not to listen to display unit settings for which Orientation unit to use. Default value is true.
|
virtual |
Set/Get whether or not to listen to display unit settings for which Distance unit to use. Default value is true.
|
virtual |
Set/Get whether or not to listen to display unit settings for which Distance unit to use. Default value is true.
|
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.
|
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.
|
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).
|
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).
|
virtual |
Set/Get the font file to use for the spider web.
|
virtual |
Set/Get the font file to use for the spider web.
|
virtual |
Set/Get the font point size for the spider web.
|
virtual |
Set/Get the font point size for the spider web.
|
virtual |
Set/Get the font color for the spider web.
|
virtual |
Set/Get the font color for the spider web.
|
virtual |
Set/Get the distance unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the distance unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
Set/Get the number of decimals to use for distance for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
Set/Get the number of decimals to use for distance for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the orientation unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the orientation unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the number of decimals to use for orientation values. This function does nothing if setListenToDisplayUnitSettings(true).
Set/Get the number of decimals to use for orientation values. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the north unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set/Get the north unit to use for the spider web. This function does nothing if setListenToDisplayUnitSettings(true).
|
virtual |
Set an altitude-specific (meters) font scale for the labels of the spider web. This will multiply the font size times the scale to get an effective font size. Allows for 1) scaling of font without changing font size and 2) the use of different font scales depending on the altitude of the camera rendering the label.
|
virtual |
Clear altitude-specific fonts, if any were defined. Altitude-specific fonts are defined using setFontScaleByMinimumAltitude(...).
|
virtual |
Set the altitude, in meters, at which this label will no longer appear. This is only used if setIsLodOutAltitudeEnabled(true).
|
virtual |
Set whether or not this label widget will use the LOD Out Altitude property. The LOD Out Altitude property is set using setLodOutAltitude(...).
|
protectedvirtual |
Attaches the model to the scene.
Implements makVrv::DtModel.
|
protectedvirtual |
Detaches the model from the scene.
Implements makVrv::DtModel.
|
protectedvirtual |
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.
|
protectedvirtual |
Utility function which dictates whether we should listen to display unit signals.
Set the overlay the model will be rendered on.
|
protectedvirtual |
Called on tick.
|
protectedvirtual |
|
protectedvirtual |
Force the recreation of the spider web Akin to calling deleteSpiderWeb() and createSpiderWebIfNecessary()
|
protectedvirtual |
Create my spider web according to current state.
|
protectedvirtual |
Delete spider web.
|
protectedvirtual |
Update the vertex colors.
|
protectedvirtual |
Update the altitude based configurations for all currently created labels.
|
protectedvirtual |
Utility function for transforming a vertex and setting it on the spider web.
|
protectedvirtual |
Set a vertex position of a spider web spoke.
|
protectedvirtual |
Set a vertex position of a spider web ring.
|
protectedvirtual |
Set the position of a spider web label.
|
protectedvirtual |
Detect when the unit of measurement to use for a display unit has changed.
|
protectedvirtual |
Detect when the number of decimals places to use for a display unit has changed.
|
protectedvirtual |
slot for when the coordinate system changes
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
local clone of the system wide coordinate system. for thread safety.