Implementation for 2D (overlay) Spider Web Facade. More...

Inheritance diagram for makVrv::Dt2DSpiderWebFacade:

Public Member Functions
	Dt2DSpiderWebFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that takes an existing scene object agent. More...

	Dt2DSpiderWebFacade (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	~Dt2DSpiderWebFacade ()
	DTOR. More...

Public Member Functions inherited from makVrv::DtSpiderWebFacadeBase
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. More...

virtual DtTaitBryan	orientation () 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 Default value is 5 rings. More...

virtual unsigned int	numberOfRings () 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	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	setGroup (int groupNum)
	Set/Get the group this overlay will be drawn in. More...

virtual int	group () 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
void	createAndInitializeSpiderWebAgent ()
	Creates the spider web agent. More...

Protected Member Functions inherited from makVrv::DtSpiderWebFacadeBase
	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...

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

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

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

Additional Inherited Members
Protected Attributes inherited from makVrv::DtSpiderWebFacadeBase
DtOverlaySpiderWebModelAgent *	mySpiderWebModelAgent

DtSceneObjectAgent *	mySceneObjectAgent

DtAgentManagerInterface &	myAgentManagerInterface

bool	myOwnsSceneObjectAgent

int	myModelSet

DtVector	myPosition

DtVector	myRelativePosition

DtTaitBryan	myOrientation

double	myRadius

unsigned int	myNumberOfSpokes

unsigned int	myNumberOfRings

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

Detailed Description

Implementation for 2D (overlay) Spider Web Facade.

This class creates and initializes a DtOverlaySpiderWebModelAgent and adds the model to its parent DtSceneObjectAgent (which is created in or passed into the class's constructor).

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 rings the spider web has
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::Dt2DSpiderWebFacade::Dt2DSpiderWebFacade	(	DtAgentManagerInterface &	,
		DtSceneObjectAgent *	agent,
		DtElementID	id,
		int	modelSet
	)

Constructor that takes an existing scene object agent.

makVrv::Dt2DSpiderWebFacade::Dt2DSpiderWebFacade	(	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.

virtual makVrv::Dt2DSpiderWebFacade::~Dt2DSpiderWebFacade ( )

virtual

DTOR.

makVrv::Dt2DSpiderWebFacade::Dt2DSpiderWebFacade ( )

private

Default Constructor not implemented.

makVrv::Dt2DSpiderWebFacade::Dt2DSpiderWebFacade ( const Dt2DSpiderWebFacade & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

void makVrv::Dt2DSpiderWebFacade::createAndInitializeSpiderWebAgent ( )

protected

Creates the spider web agent.

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

private

Assignment Operator not implemented � Copy not allowed.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/Dt2DSpiderWebFacade.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation