makVrv::DtSpiderWebModelInstance Class Reference

vrvGraphics implementation of the Spider Web Model

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:

• Number of Spokes: Change the number of spokes the spider web has
• Number of Rings: Change the number of rings the spider web has. When setting the number of rings explicitly, any ring interval distance specified by the user will be ignored. The drawn rings will be at even intervals and a outer ring is always drawn at the spider web radius.
• Filled Inner Ring: Change whether or not the innermost ring in the spider web is filled. If not filled, the spokes will begin at the inner most ring as opposed to the origin.
• Ring Interval Distance: Change the interval distance between rings in the spider web. The total number of rings drawn will depend on the radius of the spider web. For example, if the radius is 35m and the interval distance between rings is 10m, then 3 rings are drawn and there won't be a ring present at the radius of the spider web.
• Position: Change the position of the spider web's origin
• Radius: Change the radius of the circle used to draw the spider web
• Max Angle Segment: Affects the number of vertices used to draw each ring of the spider web. If you want to use X vertices to draw each ring of the spider web, then Max Angle Segment is equal to (2*PI) / X.
• Scale: Change the numeric factor that the spider web is scaled by

A spider web has the following style properties:

• Line Width: Change the width of all of the spider web's line segments
• Line Color: Change the color of all of the spider web's line segments
• Line Stipple Pattern: Change the stipple pattern of all of the spider web's line segments

Special Considerations:

• The spokes and rings will be drawn equally distanced from each other
• The spokes indicate the number of diameter length spokes, i.e. there will be 2 times the number of radius length spokes.

Inheritance diagram for makVrv::DtSpiderWebModelInstance:

Public Member Functions
	DtSpiderWebModelInstance (DtDe &de)
virtual	~DtSpiderWebModelInstance ()
virtual void	setOverlay (unsigned int overlayId)
virtual bool	realize (DtModelDefinition &definition)
virtual void	update ()
virtual void	recreateSpiderWeb ()
virtual void	setPosition (const DtVector &position)
virtual DtVector	position () const
virtual void	setOrientation (const DtTaitBryan &orientation)
virtual DtTaitBryan	orientation () 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, unsigned long long userData)
virtual bool	eventsEnabled () const
virtual void	setGroup (int groupNum)
virtual int	group () const
virtual void	setIsDecorated (bool isDecorated)
virtual bool	isDecorated () const
virtual void	setFontFile (const 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
Public Member Functions inherited from makVrv::DtModelInstance
	DtModelInstance (DtDe &de)
virtual	~DtModelInstance ()
virtual bool	cloneInstance (DtModelDefinition &definition)
const std::string &	realizedDefinitionName () const
virtual bool	saveModelToFile (const std::string &filename) const
const DtVector &	boundingBoxExtents () const
void	getBoundingBoxExtents (double &x, double &y, double &z) const
const DtVector &	boundingBoxCenter () const
void	getBoundingBoxCenter (double &x, double &y, double &z) const
void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
const DtVector &	allGeometryboundingBoxExtents () const
void	getAllGeometryBoundingBoxExtents (double &x, double &y, double &z) const
const DtVector &	allGeometryboundingBoxCenter () const
void	getAllGeometryBoundingBoxCenter (double &x, double &y, double &z) const
void	getAllGeometryBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
virtual void	setContributesToBound (bool trueOrFalse)
bool	contributesToBound () const
virtual void	setBlendColor (float r, float g, float b, float a)
virtual void	enableColorBlending (bool b)

Protected Member Functions
virtual void	createSpiderWebIfNecessary ()
virtual void	deleteSpiderWeb ()
virtual void	updateColors ()
virtual void	setSpokeVertexPosition (unsigned int spokeIndex, unsigned int vertexIndex, double x, double y, double z)=0
virtual void	setRingVertexPosition (unsigned int ringIndex, unsigned int vertexIndex, double x, double y, double z)=0
virtual void	setLabelPosition (unsigned int labelIndex, double x, double y, double z)=0

Protected Attributes
unsigned int	myOverlay
bool	myEventsEnabled
unsigned long long	myUserData
DtVector	myPosition
DtDcm	myOrientationDcm
DtTaitBryan	myOrientationTaitBryan
double	myRadius
unsigned int	myNumberOfSpokes
unsigned int	myNumberOfRings
double	myRingIntervalDistance
bool	myIsRingIntervalSet
bool	myIsInnerRingFilled
bool	myIsDecorated
bool	myVisible
float	myScale
float	myColor [4]
float	myLineWidth
unsigned int	myLineStipplePattern
std::string	myFontFile
float	myFontPointSize
float	myFontColor [4]
double	myMaxAngleSegment
DtSharedDisplayUnitsSettings::OrientationUnits	myOrientationUnitToUse
unsigned int	myOrientationDecimalsToUse
DtSharedDisplayUnitsSettings::DistanceUnits	myDistanceUnitToUse
unsigned int	myDistanceDecimalsToUse
int	myGroup
std::vector< DtSegmentedLine * >	mySpokes
std::vector< DtSegmentedLine * >	myRings
std::vector< DtTextProxy * >	myLabels
Protected Attributes inherited from makVrv::DtModelInstance
DtDe &	myDe
std::string	myRealizedModelDefinitionName
DtVector	myBoundingBoxCenter
DtVector	myBoundingBoxExtents
DtVector	myBoundingBoxMinimum
DtVector	myBoundingBoxMaximum
DtVector	myAllGeometryBoundingBoxCenter
DtVector	myAllGeometryBoundingBoxExtents
DtVector	myAllGeometryBoundingBoxMinimum
DtVector	myAllGeometryBoundingBoxMaximum
bool	myContributesToBound
bool	myColorBlendingEnabled
float	myBlendRed
float	myBlendBlue
float	myBlendGreen
float	myBlendAlpha

Additional Inherited Members
Static Public Member Functions inherited from makVrv::DtModelInstance
static float	readFloat (const std::string &paramName, const DtModelDefinition &definition)
static DtVector	readVector (const std::string &paramName, const DtModelDefinition &definition)
Public Attributes inherited from makVrv::DtModelInstance
boost::signalslib::signal < void(DtModelInstance *)>	signal_modelInstanceChanged

Constructor & Destructor Documentation

makVrv::DtSpiderWebModelInstance::DtSpiderWebModelInstance

(

DtDe &

de

)

CTOR.

virtual makVrv::DtSpiderWebModelInstance::~DtSpiderWebModelInstance ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtSpiderWebModelInstance::setPosition ( const DtVector &  position )

virtual

Set/Get the global position of the spider web.

virtual DtVector makVrv::DtSpiderWebModelInstance::position ( ) const

virtual

Set/Get the global position of the spider web.

virtual void makVrv::DtSpiderWebModelInstance::setOrientation ( const DtTaitBryan &  orientation )

virtual

Set the global orientation of the spider web.

virtual DtTaitBryan makVrv::DtSpiderWebModelInstance::orientation ( ) const

virtual

Set the global orientation of the spider web.

virtual void makVrv::DtSpiderWebModelInstance::setMaxAngleSegment ( double  angleSegmentMax )

virtual

Set/Get the max angle segment used when building the spider web Default value is PI / 18.

virtual double makVrv::DtSpiderWebModelInstance::maxAngleSegment ( ) const

virtual

Set/Get the max angle segment used when building the spider web Default value is PI / 18.

virtual void makVrv::DtSpiderWebModelInstance::setRadius ( double  x )

virtual

Set/Get the radius (in meters) of the spider web Default value is 0.

virtual double makVrv::DtSpiderWebModelInstance::radius ( ) const

virtual

Set/Get the radius (in meters) of the spider web Default value is 0.

virtual void makVrv::DtSpiderWebModelInstance::setScale ( float  scale )

virtual

Set/Get the spider web's scale factor Default value is 1.

virtual float makVrv::DtSpiderWebModelInstance::scale ( ) const

virtual

Set/Get the spider web's scale factor Default value is 1.

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

virtual

Set/Get whether the spider web is visible Default value is true (visible)

Implements makVrv::DtModelInstance.

virtual bool makVrv::DtSpiderWebModelInstance::isVisible ( ) const

virtual

Set/Get whether the spider web is visible Default value is true (visible)

virtual void makVrv::DtSpiderWebModelInstance::setNumberOfSpokes ( unsigned int  numSpokes )

virtual

Set/Get the number of spokes the spider web has Default value is 0.

virtual unsigned int makVrv::DtSpiderWebModelInstance::numberOfSpokes ( ) const

virtual

Set/Get the number of spokes the spider web has Default value is 0.

virtual void makVrv::DtSpiderWebModelInstance::setNumberOfRings ( unsigned int  numRings )

virtual

Set/Get the number of rings the spider web has Default value is 0. Any prior call to setRingIntervalDistance(...) is ignored, the ring interval distance will be (radius / number_of_rings).

virtual unsigned int makVrv::DtSpiderWebModelInstance::numberOfRings ( ) const

virtual

Set/Get the number of rings the spider web has Default value is 0. Any prior call to setRingIntervalDistance(...) is ignored, the ring interval distance will be (radius / number_of_rings).

virtual void makVrv::DtSpiderWebModelInstance::setIsInnerRingFilled ( bool  filled )

virtual

Set/Get whether the inner most ring of the spider web is filled Default is true.

virtual bool makVrv::DtSpiderWebModelInstance::isInnerRingFilled ( ) const

virtual

Set/Get whether the inner most ring of the spider web is filled Default is true.

virtual void makVrv::DtSpiderWebModelInstance::setRingIntervalDistance ( double  interval )

virtual

Set/Get the ring interval distance for the spider web (in meters) Default value is 0. Any prior call to setNumberOfRings(...) is ignored, the number of rings drawn will be (radius / ring_interval_distance).

virtual double makVrv::DtSpiderWebModelInstance::ringIntervalDistance ( ) const

virtual

Set/Get the ring interval distance for the spider web (in meters) Default value is 0. Any prior call to setNumberOfRings(...) is ignored, the number of rings drawn will be (radius / ring_interval_distance).

virtual void makVrv::DtSpiderWebModelInstance::setLineStipplePattern ( unsigned int  stipplePattern )

virtual

Set/Get the line stipple pattern of the spider web Default value is 0xFFFF.

virtual unsigned int makVrv::DtSpiderWebModelInstance::lineStipplePattern ( ) const

virtual

Set/Get the line stipple pattern of the spider web Default value is 0xFFFF.

virtual void makVrv::DtSpiderWebModelInstance::setLineWidth ( float  width )

virtual

Set/Get the line width of the spider web Default value is 1.

virtual float makVrv::DtSpiderWebModelInstance::lineWidth ( ) const

virtual

Set/Get the line width of the spider web Default value is 1.

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

virtual

Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0. Default value is (1, 1, 1, 1)

virtual bool makVrv::DtSpiderWebModelInstance::getColor ( float &  r, float &  g, float &  b, float &  a  ) const

virtual

Set/Get the color of the spider web Valid range for argument values are 0.0 - 1.0. Default value is (1, 1, 1, 1)

virtual void makVrv::DtSpiderWebModelInstance::setOpacity ( float  opacity )

virtual

Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0. Default value is 1.

virtual float makVrv::DtSpiderWebModelInstance::opacity ( ) const

virtual

Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0. Default value is 1.

virtual void makVrv::DtSpiderWebModelInstance::setEventsEnabled ( bool  enabled, unsigned long long  userData  )

virtual

Set/Get to handle or not handle mouse events Default value is false (events not enabled)

virtual bool makVrv::DtSpiderWebModelInstance::eventsEnabled ( ) const

virtual

Set/Get to handle or not handle mouse events Default value is false (events not enabled)

virtual void makVrv::DtSpiderWebModelInstance::setGroup ( int  groupNum )

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. Default value is 1.

virtual int makVrv::DtSpiderWebModelInstance::group ( ) const

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. Default value is 1.

virtual void makVrv::DtSpiderWebModelInstance::setIsDecorated ( bool  isDecorated )

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). Default value is false.

virtual bool makVrv::DtSpiderWebModelInstance::isDecorated ( ) const

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). Default value is false.

virtual void makVrv::DtSpiderWebModelInstance::setFontFile ( const std::string &  fontFile )

virtual

Set/Get the font file to use for the spider web. Default value is "FreeSans.otf".

virtual std::string makVrv::DtSpiderWebModelInstance::fontFile ( ) const

virtual

Set/Get the font file to use for the spider web. Default value is "FreeSans.otf".

virtual void makVrv::DtSpiderWebModelInstance::setFontPointSize ( float  pointSize )

virtual

Set/Get the font point size for the spider web. Default value is 20.

virtual float makVrv::DtSpiderWebModelInstance::fontPointSize ( ) const

virtual

Set/Get the font point size for the spider web. Default value is 20.

virtual void makVrv::DtSpiderWebModelInstance::setFontColor ( float  r, float  g, float  b, float  a  )

virtual

Set/Get the font color for the spider web. Default value is (1., 1., 1., 0.7).

virtual bool makVrv::DtSpiderWebModelInstance::getFontColor ( float &  r, float &  g, float &  b, float &  a  ) const

virtual

Set/Get the font color for the spider web. Default value is (1., 1., 1., 0.7).

virtual void makVrv::DtSpiderWebModelInstance::setDistanceUnit ( DtSharedDisplayUnitsSettings::DistanceUnits  unit )

virtual

Set/Get the distance unit to use for the spider web. Default value is Nautical Miles.

virtual DtSharedDisplayUnitsSettings::DistanceUnits makVrv::DtSpiderWebModelInstance::distanceUnit ( ) const

virtual

Set/Get the distance unit to use for the spider web. Default value is Nautical Miles.

virtual void makVrv::DtSpiderWebModelInstance::setDistanceDecimals ( unsigned int  decimals )

virtual

Set/Get the number of decimals to use for distance for the spider web. Default value is 0.

virtual unsigned int makVrv::DtSpiderWebModelInstance::distanceDecimals ( ) const

virtual

Set/Get the number of decimals to use for distance for the spider web. Default value is 0.

virtual void makVrv::DtSpiderWebModelInstance::setOrientationUnit ( DtSharedDisplayUnitsSettings::OrientationUnits  unit )

virtual

Set/Get the orientation unit to use for the spider web. Default value is Degrees.

virtual DtSharedDisplayUnitsSettings::OrientationUnits makVrv::DtSpiderWebModelInstance::orientationUnit ( ) const

virtual

Set/Get the orientation unit to use for the spider web. Default value is Degrees.

virtual void makVrv::DtSpiderWebModelInstance::setOrientationDecimals ( unsigned int  decimals )

virtual

Set/Get the number of decimals to use for orientation values. Default value is 0.

virtual unsigned int makVrv::DtSpiderWebModelInstance::orientationDecimals ( ) const

virtual

Set/Get the number of decimals to use for orientation values. Default value is 0.

virtual void makVrv::DtSpiderWebModelInstance::setOverlay ( unsigned int  overlayId )

virtual

Set the overlay the model will be rendered on.

virtual bool makVrv::DtSpiderWebModelInstance::realize ( DtModelDefinition &  definition )

virtual

Apply model definition defaults.

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtSpiderWebModelInstance::update ( )

virtual

virtual void makVrv::DtSpiderWebModelInstance::recreateSpiderWeb ( )

virtual

Force the recreation of the spider web Akin to calling deleteSpiderWeb() and createSpiderWebIfNecessary()

virtual void makVrv::DtSpiderWebModelInstance::createSpiderWebIfNecessary ( )

protectedvirtual

Create my spider web according to current state.

virtual void makVrv::DtSpiderWebModelInstance::deleteSpiderWeb ( )

protectedvirtual

Delete spider web.

virtual void makVrv::DtSpiderWebModelInstance::updateColors ( )

protectedvirtual

Update the vertex colors.

virtual void makVrv::DtSpiderWebModelInstance::setSpokeVertexPosition ( unsigned int  spokeIndex, unsigned int  vertexIndex, double  x, double  y, double  z  )

protectedpure virtual

Set a vertex position of a spider web spoke.

Implemented in makVrv::DtOverlaySpiderWebModelInstance.

virtual void makVrv::DtSpiderWebModelInstance::setRingVertexPosition ( unsigned int  ringIndex, unsigned int  vertexIndex, double  x, double  y, double  z  )

protectedpure virtual

Set a vertex position of a spider web ring.

Implemented in makVrv::DtOverlaySpiderWebModelInstance.

virtual void makVrv::DtSpiderWebModelInstance::setLabelPosition ( unsigned int  labelIndex, double  x, double  y, double  z  )

protectedpure virtual

Set the position of a spider web label.

Implemented in makVrv::DtOverlaySpiderWebModelInstance.

Member Data Documentation

unsigned int makVrv::DtSpiderWebModelInstance::myOverlay

protected

bool makVrv::DtSpiderWebModelInstance::myEventsEnabled

protected

unsigned long long makVrv::DtSpiderWebModelInstance::myUserData

protected

DtVector makVrv::DtSpiderWebModelInstance::myPosition

protected

DtDcm makVrv::DtSpiderWebModelInstance::myOrientationDcm

protected

DtTaitBryan makVrv::DtSpiderWebModelInstance::myOrientationTaitBryan

protected

double makVrv::DtSpiderWebModelInstance::myRadius

protected

unsigned int makVrv::DtSpiderWebModelInstance::myNumberOfSpokes

protected

unsigned int makVrv::DtSpiderWebModelInstance::myNumberOfRings

protected

double makVrv::DtSpiderWebModelInstance::myRingIntervalDistance

protected

bool makVrv::DtSpiderWebModelInstance::myIsRingIntervalSet

protected

bool makVrv::DtSpiderWebModelInstance::myIsInnerRingFilled

protected

bool makVrv::DtSpiderWebModelInstance::myIsDecorated

protected

bool makVrv::DtSpiderWebModelInstance::myVisible

protected

float makVrv::DtSpiderWebModelInstance::myScale

protected

float makVrv::DtSpiderWebModelInstance::myColor[4]

protected

float makVrv::DtSpiderWebModelInstance::myLineWidth

protected

unsigned int makVrv::DtSpiderWebModelInstance::myLineStipplePattern

protected

std::string makVrv::DtSpiderWebModelInstance::myFontFile

protected

float makVrv::DtSpiderWebModelInstance::myFontPointSize

protected

float makVrv::DtSpiderWebModelInstance::myFontColor[4]

protected

double makVrv::DtSpiderWebModelInstance::myMaxAngleSegment

protected

DtSharedDisplayUnitsSettings::OrientationUnits makVrv::DtSpiderWebModelInstance::myOrientationUnitToUse

protected

unsigned int makVrv::DtSpiderWebModelInstance::myOrientationDecimalsToUse

protected

DtSharedDisplayUnitsSettings::DistanceUnits makVrv::DtSpiderWebModelInstance::myDistanceUnitToUse

protected

unsigned int makVrv::DtSpiderWebModelInstance::myDistanceDecimalsToUse

protected

int makVrv::DtSpiderWebModelInstance::myGroup

protected

std::vector<DtSegmentedLine*> makVrv::DtSpiderWebModelInstance::mySpokes

protected

std::vector<DtSegmentedLine*> makVrv::DtSpiderWebModelInstance::myRings

protected

std::vector<DtTextProxy*> makVrv::DtSpiderWebModelInstance::myLabels

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvOsg/DtSpiderWebModelInstance.h