Interface class for a Spider Web Facade. More...

Inheritance diagram for makVrv::DtSpiderWebFacadeBase:

Public Member Functions
virtual	~DtSpiderWebFacadeBase ()
	DTOR. More...


virtual void	setPosition (const DtVector &position)
	Set/Get the global position of the spider web. More...

virtual DtVector	position () const


virtual void	setOrientation (const DtTaitBryan &orientation)
	Set/Get the orientation of the spider web Calls to this function will override prior calls to setHeading. More...

virtual DtTaitBryan	orientation () const


virtual void	setHeading (float heading)
	Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation Default value is 0 radians. More...

virtual float	heading () const


virtual void	setMaxAngleSegment (double angleSegmentMax)
	Set/Get the max angle segment used when building the spider web Default value is PI / 18. More...

virtual double	maxAngleSegment () const


virtual void	setRadius (double x)
	Set/Get the radius (in meters) of the spider web Default value is 100. More...

virtual double	radius () const


virtual void	setScale (float scale)
	Set/Get the spider web's scale factor Default value is 1. More...

virtual float	scale () const


virtual void	setVisible (bool isVisible)
	Set/Get whether the spider web is visible Default value is true (visible) More...

virtual bool	isVisible () const


virtual void	setNumberOfSpokes (unsigned int numSpokes)
	Set/Get the number of spokes the spider web has Default value is 6 spokes. More...

virtual unsigned int	numberOfSpokes () const


virtual void	setNumberOfRings (unsigned int numRings)
	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


virtual void	setIsInnerRingFilled (bool filled)
	Set/Get whether the inner most ring of the spider web is filled Default is true. More...

virtual bool	isInnerRingFilled () const


virtual void	setRingIntervalDistance (double interval)
	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


virtual void	setLineStipplePattern (unsigned int stipplePattern)
	Set/Get the line stipple pattern of the spider web Default value is 0xFFFF. More...

virtual unsigned int	lineStipplePattern () const


virtual void	setLineWidth (float width)
	Set/Get the line width of the spider web Default value is 1. More...

virtual float	lineWidth () const


virtual void	setColor (float r, float g, float b, float a)
	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


virtual void	setOpacity (float opacity)
	Set/Get the opacity of the spider web Valid range for argument values are 0.0 - 1.0. More...

virtual float	opacity () const


virtual void	setSelected (bool)
	Set/Get whether or not the spider web is selected Default value is false (not selected) More...

virtual bool	isSelected () const


virtual void	setSelectedColor (float r, float g, float b, float a)
	Set/Get the color of the spider web. More...

virtual bool	getSelectedColor (float &r, float &g, float &b, float &a) const


virtual void	setPickable (bool pickable)
	Set/Get to handle or not handle mouse events Default value is false (not pickable) More...

virtual bool	isPickable () const


virtual void	setListenToDisplayUnitSettings (bool listen)
	Set/Get whether or not to listen to display unit settings Default value is true. More...

virtual bool	listenToDisplayUnitSettings () const


virtual void	setGroup (int groupNum)
	Set/Get the group this overlay will be drawn in. More...

virtual int	group () const


virtual void	setIsDecorated (bool isDecorated)
	Set/Get whether or not this spider web is decorated. More...

virtual bool	isDecorated () const


virtual void	setFontFile (std::string fontFile)
	Set/Get the font file to use for the spider web. More...

virtual std::string	fontFile () const


virtual void	setFontPointSize (float pointSize)
	Set/Get the font point size for the spider web. More...

virtual float	fontPointSize () const


virtual void	setFontColor (float r, float g, float b, float a)
	Set/Get the font color for the spider web. More...

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


virtual void	setDistanceUnit (DtSharedDisplayUnitsSettings::DistanceUnits unit)
	Set/Get the distance unit to use for the spider web. More...

virtual DtSharedDisplayUnitsSettings::DistanceUnits	distanceUnit () const


virtual void	setDistanceDecimals (unsigned int decimals)
	Set/Get the number of decimals to use for distance for the spider web. More...

virtual unsigned int	distanceDecimals () const


virtual void	setOrientationUnit (DtSharedDisplayUnitsSettings::OrientationUnits unit)
	Set/Get the orientation unit to use for the spider web. More...

virtual DtSharedDisplayUnitsSettings::OrientationUnits	orientationUnit () const


virtual void	setOrientationDecimals (unsigned int decimals)
	Set/Get the number of decimals to use for orientation values. More...

virtual unsigned int	orientationDecimals () const


virtual void	setNorthUnit (DtSharedDisplayUnitsSettings::NorthUnits unit)
	Set/Get the north unit to use for the spider web. More...

virtual DtSharedDisplayUnitsSettings::NorthUnits	northUnit () const


virtual void	setPosition (int index, const DtVector &position)
	Set the position of a vertex in the wedge. More...

virtual void	setModelDefinition (const std::string &)
	Sets the model definition on the model instance. More...

Protected Member Functions
	DtSpiderWebFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that takes an existing scene object agent Throws a DtException if the provided DtSceneObjectAgent is NULL. More...

	DtSpiderWebFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Constructor that creates a new scene object agent The given model set and element id is used to create the new scene object agent. More...

virtual void	updateColors ()
	Passes set color values down to the model. More...

Protected Attributes
DtOverlaySpiderWebModelAgent *	mySpiderWebModelAgent

DtSceneObjectAgent *	mySceneObjectAgent

DtAgentManagerInterface &	myAgentManagerInterface

bool	myOwnsSceneObjectAgent

int	myModelSet

DtVector	myPosition

DtVector	myRelativePosition

DtTaitBryan	myOrientation

DtSharedDisplayUnitsSettings::OrientationUnits	myOrientationUnitToUse

unsigned int	myOrientationDecimalsToUse

DtSharedDisplayUnitsSettings::DistanceUnits	myDistanceUnitToUse

unsigned int	myDistanceDecimalsToUse

DtSharedDisplayUnitsSettings::NorthUnits	myNorthToUse

float	myHeading

double	myRadius

unsigned int	myNumberOfSpokes

unsigned int	myNumberOfRings

double	myRingIntervalDistance

bool	myIsInnerRingFilled

bool	myIsDecorated

std::string	myFontFile

float	myFontPointSize

float	myFontColor [4]

bool	myVisible

float	myScale

float	myColor [4]

float	mySelectedColor [4]

float	myLineWidth

unsigned int	myLineStipplePattern

double	myMaxAngleSegment

DtElementID	myElementId

bool	myDynamicOrigin

int	myGroup

bool	mySelected

bool	myPickable

bool	myListenToDisplayUnitSettings

Private Member Functions
	DtSpiderWebFacadeBase ()
	Default Constructor not implemented. More...

	DtSpiderWebFacadeBase (const DtSpiderWebFacadeBase &)
	Copy Constructor not implemented � Copy not allowed. More...

DtSpiderWebFacadeBase &	operator= (const DtSpiderWebFacadeBase &)
	Assignment Operator not implemented � Copy not allowed. More...

Detailed Description

Interface class for a Spider Web Facade.

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.

Constructor & Destructor Documentation

makVrv::DtSpiderWebFacadeBase::DtSpiderWebFacadeBase	(	DtAgentManagerInterface &	,
		DtSceneObjectAgent *	agent,
		DtElementID	id,
		int	modelSet
	)

protected

Constructor that takes an existing scene object agent Throws a DtException if the provided DtSceneObjectAgent is NULL.

makVrv::DtSpiderWebFacadeBase::DtSpiderWebFacadeBase	(	DtAgentManagerInterface &	,
		int	modelSet,
		DtElementID	id,
		bool	distribute = `true`
	)

protected

Constructor that creates a new scene object agent The given model set and element id is used to create the new scene object agent.

virtual makVrv::DtSpiderWebFacadeBase::~DtSpiderWebFacadeBase ( )

virtual

DTOR.

makVrv::DtSpiderWebFacadeBase::DtSpiderWebFacadeBase ( )

private

Default Constructor not implemented.

makVrv::DtSpiderWebFacadeBase::DtSpiderWebFacadeBase ( const DtSpiderWebFacadeBase & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

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

virtual

Set/Get the global position of the spider web.

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

virtual

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

virtual

Set/Get the orientation of the spider web Calls to this function will override prior calls to setHeading.

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setHeading ( float heading )

virtual

Set the heading of the spider web, in radians from True North Calls to this function will override prior calls to setOrientation Default value is 0 radians.

virtual float makVrv::DtSpiderWebFacadeBase::heading ( ) const

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

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).

Default value is 5 rings

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

virtual

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

virtual

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

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

virtual

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

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).

Default is 0 - setNumberOfRings is used instead.

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::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 (0, 0, 0, 1)

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

virtual

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

virtual

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

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setSelected ( bool )

virtual

Set/Get whether or not the spider web is selected Default value is false (not selected)

virtual bool makVrv::DtSpiderWebFacadeBase::isSelected ( ) const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setSelectedColor	(	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::DtSpiderWebFacadeBase::getSelectedColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setPickable ( bool pickable )

virtual

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

virtual bool makVrv::DtSpiderWebFacadeBase::isPickable ( ) const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setListenToDisplayUnitSettings ( bool listen )

virtual

Set/Get whether or not to listen to display unit settings Default value is true.

virtual bool makVrv::DtSpiderWebFacadeBase::listenToDisplayUnitSettings ( ) const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::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::DtSpiderWebFacadeBase::group ( ) const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::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 true.

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setFontFile ( std::string fontFile )

virtual

Set/Get the font file to use for the spider web.

Default value is "FreeSans.otf".

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

virtual

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

virtual

Set/Get the font point size for the spider web.

Default value is 20.

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::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., .7).

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

virtual

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

virtual

Set/Get the distance unit to use for the spider web.

This function does nothing if setListenToDisplayUnitSettings(true). Default value is Nautical Miles.

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

virtual

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

virtual

Set/Get the number of decimals to use for distance for the spider web.

This function does nothing if setListenToDisplayUnitSettings(true). Default value is 0.

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

virtual

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

virtual

Set/Get the orientation unit to use for the spider web.

This function does nothing if setListenToDisplayUnitSettings(true). Default value is degrees.

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

virtual

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

virtual

Set/Get the number of decimals to use for orientation values.

This function does nothing if setListenToDisplayUnitSettings(true). Default value is 0.

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

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setNorthUnit ( DtSharedDisplayUnitsSettings::NorthUnits unit )

virtual

Set/Get the north unit to use for the spider web.

This function does nothing if setListenToDisplayUnitSettings(true). Default value is True North.

virtual DtSharedDisplayUnitsSettings::NorthUnits makVrv::DtSpiderWebFacadeBase::northUnit ( ) const

virtual

virtual void makVrv::DtSpiderWebFacadeBase::setPosition	(	int	index,
		const DtVector &	position
	)

virtual

Set the position of a vertex in the wedge.

virtual void makVrv::DtSpiderWebFacadeBase::setModelDefinition ( const std::string & )

virtual

Sets the model definition on the model instance.

virtual void makVrv::DtSpiderWebFacadeBase::updateColors ( )

protectedvirtual

Passes set color values down to the model.

DtSpiderWebFacadeBase& makVrv::DtSpiderWebFacadeBase::operator= ( const DtSpiderWebFacadeBase & )

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

DtOverlaySpiderWebModelAgent* makVrv::DtSpiderWebFacadeBase::mySpiderWebModelAgent

protected

DtSceneObjectAgent* makVrv::DtSpiderWebFacadeBase::mySceneObjectAgent

protected

DtAgentManagerInterface& makVrv::DtSpiderWebFacadeBase::myAgentManagerInterface

protected

bool makVrv::DtSpiderWebFacadeBase::myOwnsSceneObjectAgent

protected

int makVrv::DtSpiderWebFacadeBase::myModelSet

protected

DtVector makVrv::DtSpiderWebFacadeBase::myPosition

protected

DtVector makVrv::DtSpiderWebFacadeBase::myRelativePosition

protected

DtTaitBryan makVrv::DtSpiderWebFacadeBase::myOrientation

protected

DtSharedDisplayUnitsSettings::OrientationUnits makVrv::DtSpiderWebFacadeBase::myOrientationUnitToUse

protected

unsigned int makVrv::DtSpiderWebFacadeBase::myOrientationDecimalsToUse

protected

DtSharedDisplayUnitsSettings::DistanceUnits makVrv::DtSpiderWebFacadeBase::myDistanceUnitToUse

protected

unsigned int makVrv::DtSpiderWebFacadeBase::myDistanceDecimalsToUse

protected

DtSharedDisplayUnitsSettings::NorthUnits makVrv::DtSpiderWebFacadeBase::myNorthToUse

protected

float makVrv::DtSpiderWebFacadeBase::myHeading

protected

double makVrv::DtSpiderWebFacadeBase::myRadius

protected

unsigned int makVrv::DtSpiderWebFacadeBase::myNumberOfSpokes

protected

unsigned int makVrv::DtSpiderWebFacadeBase::myNumberOfRings

protected

double makVrv::DtSpiderWebFacadeBase::myRingIntervalDistance

protected

bool makVrv::DtSpiderWebFacadeBase::myIsInnerRingFilled

protected

bool makVrv::DtSpiderWebFacadeBase::myIsDecorated

protected

std::string makVrv::DtSpiderWebFacadeBase::myFontFile

protected

float makVrv::DtSpiderWebFacadeBase::myFontPointSize

protected

float makVrv::DtSpiderWebFacadeBase::myFontColor[4]

protected

bool makVrv::DtSpiderWebFacadeBase::myVisible

protected

float makVrv::DtSpiderWebFacadeBase::myScale

protected

float makVrv::DtSpiderWebFacadeBase::myColor[4]

protected

float makVrv::DtSpiderWebFacadeBase::mySelectedColor[4]

protected

float makVrv::DtSpiderWebFacadeBase::myLineWidth

protected

unsigned int makVrv::DtSpiderWebFacadeBase::myLineStipplePattern

protected

double makVrv::DtSpiderWebFacadeBase::myMaxAngleSegment

protected

DtElementID makVrv::DtSpiderWebFacadeBase::myElementId

protected

bool makVrv::DtSpiderWebFacadeBase::myDynamicOrigin

protected

int makVrv::DtSpiderWebFacadeBase::myGroup

protected

bool makVrv::DtSpiderWebFacadeBase::mySelected

protected

bool makVrv::DtSpiderWebFacadeBase::myPickable

protected

bool makVrv::DtSpiderWebFacadeBase::myListenToDisplayUnitSettings

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtSpiderWebFacadeBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation