Implementation of a 2D (overlay) Wedge Facade This class creates and initializes a DtOverlayWedgeModelAgent and adds the model to its parent DtSceneObjectAgent (which is created in or passed into the class's constructor). More...

Inheritance diagram for makVrv::Dt2DWedgeFacade:

[legend]

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

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

Public Member Functions inherited from makVrv::DtWedgeFacadeBase
virtual	~DtWedgeFacadeBase ()
	DTOR. More...

virtual void	setFillPattern (const std::vector< unsigned int > &)
	Set/Get the fill pattern of the wedge. More...

virtual void	setColor (float r, float g, float b, float a)
	Set/Get the inside, outside, and central vertex color of the wedge. More...

virtual void	setDynamicOrigin (bool)
	Sets whether or not the origin's position is changing or not If the origin is changing, we use the DtWedgeUpdaterAgent to update the wedge's origin instead of using the wedge's scene object directly. More...

virtual makVrv::DtUniqueID	uniqueId () const
	Returns the unique id of the scene object agent. More...

virtual makVrv::DtElementID	elementId () const
	Returns the element id of the scene object agent. More...

virtual int	modelSet () const
	Returns the model set. More...

DtEllipseUpdaterAgent *	findUpdater () const
	Returns the updater agent for this class This function can return null. More...

DtSceneObjectAgent *	sceneObjectAgent () const
	Returns the scene object agent for this class. More...

DtOverlayWedgeModelAgent *	findWedgeAgent () const
	Returns the wedge model agent used for this class This function can return null. More...

virtual void	setOrigin (const DtVector &position)
	Set/Get the global position of the wedge. More...

virtual DtVector	origin () const

virtual void	setRelativePosition (const DtVector &relPos)
	Set/Get the local translation of the wedge. More...

virtual DtVector	relativePosition () const

virtual void	setMaxAngleSegment (double angleSegmentMax)
	Set/Get the max angle segment used when building the geometry. More...

virtual double	maxAngleSegment () const

virtual void	setRadius (float len)
	Set/Get the radius of the wedge. More...

virtual float	radius () const

virtual void	setScale (float scale)
	Set/Get the numeric factor the wedge is scaled by. More...

virtual float	scale () const

virtual void	setVisible (bool isVisible)
	Set/Get whether the wedge is visible. More...

virtual bool	isVisible () const

virtual void	setSelected (bool)
	Set/Get whether or not the wedge is selected. More...

virtual bool	isSelected () const

virtual void	setStartAngle (double startAngle)
	Set/Get the start angle of the wedge, in radians. More...

virtual double	startAngle () const

virtual void	setWedgeSpan (double wedgeSpan)
	Set/Get the span of the wedge, in radians. More...

virtual double	wedgeSpan () const

virtual void	setFill (bool)
	Set/Get whether or not to draw a filled wedge. More...

virtual bool	isFill () const

virtual void	setOutline (bool)
	Set/Get whether or not to outline a filled wedge. More...

virtual bool	isOutline () const

virtual void	setSolidFillCenter (bool)
	Set/Get whether to solid fill or gradient fill the wedge. More...

virtual bool	isSolidFillCenter () const

virtual void	setStipplePattern (unsigned int stipplePattern)
	Set/Get the stipple pattern for the wedge. More...

virtual unsigned int	stipplePattern () const

virtual void	setOutlineWidth (float)
	Set/Get the outline width of the wedge. More...

virtual float	outlineWidth () const

virtual void	setCentralVertexColor (float r, float g, float b, float a)
	Set/Get the color of the wedge's central vertex. More...

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

virtual void	setInsideColor (float r, float g, float b, float a)
	Set/Get the inside color of the wedge. More...

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

virtual void	setOutsideColor (float r, float g, float b, float a)
	Set/Get the outside color of the wedge. More...

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

virtual void	setSelectedInsideColor (float r, float g, float b, float a)
	Set/Get the inside color of the wedge when selected. More...

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

virtual void	setSelectedOutsideColor (float r, float g, float b, float a)
	Set/Get the outside color of the wedge when selected. More...

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

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

virtual int	group () const

virtual void	setPickable (bool)
	Set/Get whether or not items are pickable. More...

virtual bool	isPickable () 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	createAndInitializeWedgeAgent ()
	Creates the wedge agent. More...

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

	DtWedgeFacadeBase (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
	Dt2DWedgeFacade ()
	Default Constructor not implemented. More...

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

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

Additional Inherited Members
Protected Attributes inherited from makVrv::DtWedgeFacadeBase
DtOverlayWedgeModelAgent *	myWedgeModelAgent

DtSceneObjectAgent *	mySceneObjectAgent

DtAgentManagerInterface &	myAgentManagerInterface

bool	myOwnsSceneObjectAgent

int	myModelSet

int	myGroup

DtVector	myPosition

DtVector	myRelativePosition

double	myStartAngle

double	myMaxAngleSegment

double	myWedgeSpan

double	myRadius

float	myScale

bool	myVisible

DtEllipseUpdaterAgent *	myUpdater

bool	myFill

bool	mySolidFillCenter

unsigned int	myStipplePattern

bool	myOutline

float	myOutlineWidth

float	myInsideColor [4]

float	myOutsideColor [4]

float	mySelectedInsideColor [4]

float	mySelectedOutsideColor [4]

float	myCentralVertexColor [4]

bool	myPickable

makVrv::DtElementID	myElementId

bool	myDynamicOrigin

bool	mySelected

bool	mySelectedInsideColorSet

bool	myCentralVertexColorSet

Detailed Description

Implementation of a 2D (overlay) Wedge Facade This class creates and initializes a DtOverlayWedgeModelAgent and adds the model to its parent DtSceneObjectAgent (which is created in or passed into the class's constructor).

The drawn wedge has the following geometric parameters:

Start Angle: Change the angle the wedge begins at
Wedge Span: Change the angular span of the wedge
Position: Change the position of the wedge's origin
Radius: Change the radius of the circle used to draw the wedge
Max Angle Segment: Affects the number of vertices used by changing the angular difference between vertices along the arc of the wedge. If you want to use X vertices to draw arc of the wedge, then the Max Angle Segment is equal to Wedge Span / X.
Scale: Change the numeric factor that the wedge is scaled by

The drawn wedge has the following style properties:

Line Width: Change the width of all of the wedge's line segments
Line Color: Change the color of all of the wedge's line segments
Line Stipple Pattern: Change the stipple pattern of all of the wedge's line segments
Outlined/Filled: Change whether or not the wedge is outlined, filled, or both
Pattern Filled: Change whether or not the wedge is filled with a stipple pattern
Gradient Filled: Change whether or not the wedge is filled with a gradient
Solid Filled: Change whether or not the wedge is filled with a solid color
Inside Color: Change the inside color of the wedge
Outside Color: Change the outside color of the wedge

Special Considerations:

In a 2D plane, the positive Y-Axis is 0 radians with clockwise being the positive direction
The wedge span cannot be negative and cannot be greater than PI

Constructor & Destructor Documentation

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

Constructor that takes an existing scene object agent.

makVrv::Dt2DWedgeFacade::Dt2DWedgeFacade	(	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::Dt2DWedgeFacade::~Dt2DWedgeFacade ( )

virtual

DTOR.

makVrv::Dt2DWedgeFacade::Dt2DWedgeFacade ( )

private

Default Constructor not implemented.

makVrv::Dt2DWedgeFacade::Dt2DWedgeFacade ( const Dt2DWedgeFacade & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

void makVrv::Dt2DWedgeFacade::createAndInitializeWedgeAgent ( )

protected

Creates the wedge agent.

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

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-10-branch/include/vrvCore/Dt2DWedgeFacade.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation