Interface class for a Circular Wedge Facade. More...

Inheritance diagram for makVrv::DtWedgeFacadeBase:

Public Member Functions
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
	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...

Protected Attributes
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

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

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

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

Detailed Description

Interface class for a Circular Wedge Facade.

A 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

A 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::DtWedgeFacadeBase::DtWedgeFacadeBase	(	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::DtWedgeFacadeBase::DtWedgeFacadeBase	(	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::DtWedgeFacadeBase::~DtWedgeFacadeBase ( )

virtual

DTOR.

makVrv::DtWedgeFacadeBase::DtWedgeFacadeBase ( )

private

Default Constructor not implemented.

makVrv::DtWedgeFacadeBase::DtWedgeFacadeBase ( const DtWedgeFacadeBase & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtWedgeFacadeBase::setOrigin ( const DtVector & position )

virtual

Set/Get the global position of the wedge.

virtual DtVector makVrv::DtWedgeFacadeBase::origin ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setRelativePosition ( const DtVector & relPos )

virtual

Set/Get the local translation of the wedge.

Default value is DtVector(0, 0, 0).

virtual DtVector makVrv::DtWedgeFacadeBase::relativePosition ( ) const

virtual

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

virtual

Set/Get the max angle segment used when building the geometry.

Default value is PI / 18.

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setRadius ( float len )

virtual

Set/Get the radius of the wedge.

Default value is 1.0.

virtual float makVrv::DtWedgeFacadeBase::radius ( ) const

virtual

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

virtual

Set/Get the numeric factor the wedge is scaled by.

Default Value is 1.0.

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

virtual

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

virtual

Set/Get whether the wedge is visible.

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

virtual

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

virtual

Set/Get whether or not the wedge is selected.

Default value is false.

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setStartAngle ( double startAngle )

virtual

Set/Get the start angle of the wedge, in radians.

virtual double makVrv::DtWedgeFacadeBase::startAngle ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setWedgeSpan ( double wedgeSpan )

virtual

Set/Get the span of the wedge, in radians.

Valid range for argument values are 0 to PI radians. Default value is PI radians.

virtual double makVrv::DtWedgeFacadeBase::wedgeSpan ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setFill ( bool )

virtual

Set/Get whether or not to draw a filled wedge.

If false, an outline of the wedge is drawn. Default value is true (filled wedge).

virtual bool makVrv::DtWedgeFacadeBase::isFill ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setOutline ( bool )

virtual

Set/Get whether or not to outline a filled wedge.

This function does nothing if setFill(false). Default value is false (no outline).

virtual bool makVrv::DtWedgeFacadeBase::isOutline ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setSolidFillCenter ( bool )

virtual

Set/Get whether to solid fill or gradient fill the wedge.

This function does nothing if setFill(false). Default value is false (gradient filled wedge).

virtual bool makVrv::DtWedgeFacadeBase::isSolidFillCenter ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setFillPattern ( const std::vector< unsigned int > & )

virtual

Set/Get the fill pattern of the wedge.

This function will call setFill(true).

virtual void makVrv::DtWedgeFacadeBase::setStipplePattern ( unsigned int stipplePattern )

virtual

Set/Get the stipple pattern for the wedge.

Default value is 0xFFFFFFFF (Solid Line).

virtual unsigned int makVrv::DtWedgeFacadeBase::stipplePattern ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setOutlineWidth ( float )

virtual

Set/Get the outline width of the wedge.

Uses DtLineSegmentInterface::setWidth. Default value is 1.0.

virtual float makVrv::DtWedgeFacadeBase::outlineWidth ( ) const

virtual

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

virtual

Set/Get the inside, outside, and central vertex color of the wedge.

Akin to calling setInsideColor(...), setOutsideColor(...).

virtual void makVrv::DtWedgeFacadeBase::setCentralVertexColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the color of the wedge's central vertex.

Valid range for argument values are 0.0 - 1.0. Default value is (0, 0, 0, 0).

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setInsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the inside color of the wedge.

Valid range for argument values are 0.0 - 1.0. Default value is (0, 0, 0, 1). This function will also update mySelectedInsideColor if setSelectedInsideColor(...) was not be called beforehand

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setOutsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the outside color of the wedge.

Valid range for argument values are 0.0 - 1.0. Default value is (0, 0, 0, 1).

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setSelectedInsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the inside color of the wedge when selected.

Valid range for argument values are 0.0 - 1.0. Default value is (0, 0, 0, 1).

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setSelectedOutsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the outside color of the wedge when selected.

Valid range for argument values are 0.0 - 1.0. Default value is (1, 1, 1, 1).

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setGroup ( int p )

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 int makVrv::DtWedgeFacadeBase::group ( ) const

virtual

virtual void makVrv::DtWedgeFacadeBase::setPickable ( bool )

virtual

Set/Get whether or not items are pickable.

Default value is false.

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

virtual

virtual void makVrv::DtWedgeFacadeBase::setDynamicOrigin ( bool )

virtual

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.

The updater will ensure the wedge is updated according to the changing origin.

virtual makVrv::DtUniqueID makVrv::DtWedgeFacadeBase::uniqueId ( ) const

virtual

Returns the unique id of the scene object agent.

virtual makVrv::DtElementID makVrv::DtWedgeFacadeBase::elementId ( ) const

virtual

Returns the element id of the scene object agent.

virtual int makVrv::DtWedgeFacadeBase::modelSet ( ) const

virtual

Returns the model set.

DtEllipseUpdaterAgent* makVrv::DtWedgeFacadeBase::findUpdater ( ) const

Returns the updater agent for this class This function can return null.

DtSceneObjectAgent* makVrv::DtWedgeFacadeBase::sceneObjectAgent ( ) const

Returns the scene object agent for this class.

DtOverlayWedgeModelAgent* makVrv::DtWedgeFacadeBase::findWedgeAgent ( ) const

Returns the wedge model agent used for this class This function can return null.

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

virtual

Set the position of a vertex in the wedge.

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

virtual

Sets the model definition on the model instance.

virtual void makVrv::DtWedgeFacadeBase::updateColors ( )

protectedvirtual

Passes set color values down to the model.

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

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

DtOverlayWedgeModelAgent* makVrv::DtWedgeFacadeBase::myWedgeModelAgent

protected

DtSceneObjectAgent* makVrv::DtWedgeFacadeBase::mySceneObjectAgent

protected

DtAgentManagerInterface& makVrv::DtWedgeFacadeBase::myAgentManagerInterface

protected

bool makVrv::DtWedgeFacadeBase::myOwnsSceneObjectAgent

protected

int makVrv::DtWedgeFacadeBase::myModelSet

protected

int makVrv::DtWedgeFacadeBase::myGroup

protected

DtVector makVrv::DtWedgeFacadeBase::myPosition

protected

DtVector makVrv::DtWedgeFacadeBase::myRelativePosition

protected

double makVrv::DtWedgeFacadeBase::myStartAngle

protected

double makVrv::DtWedgeFacadeBase::myMaxAngleSegment

protected

double makVrv::DtWedgeFacadeBase::myWedgeSpan

protected

double makVrv::DtWedgeFacadeBase::myRadius

protected

float makVrv::DtWedgeFacadeBase::myScale

protected

bool makVrv::DtWedgeFacadeBase::myVisible

protected

DtEllipseUpdaterAgent* makVrv::DtWedgeFacadeBase::myUpdater

protected

bool makVrv::DtWedgeFacadeBase::myFill

protected

bool makVrv::DtWedgeFacadeBase::mySolidFillCenter

protected

unsigned int makVrv::DtWedgeFacadeBase::myStipplePattern

protected

bool makVrv::DtWedgeFacadeBase::myOutline

protected

float makVrv::DtWedgeFacadeBase::myOutlineWidth

protected

float makVrv::DtWedgeFacadeBase::myInsideColor[4]

protected

float makVrv::DtWedgeFacadeBase::myOutsideColor[4]

protected

float makVrv::DtWedgeFacadeBase::mySelectedInsideColor[4]

protected

float makVrv::DtWedgeFacadeBase::mySelectedOutsideColor[4]

protected

float makVrv::DtWedgeFacadeBase::myCentralVertexColor[4]

protected

bool makVrv::DtWedgeFacadeBase::myPickable

protected

makVrv::DtElementID makVrv::DtWedgeFacadeBase::myElementId

protected

bool makVrv::DtWedgeFacadeBase::myDynamicOrigin

protected

bool makVrv::DtWedgeFacadeBase::mySelected

protected

bool makVrv::DtWedgeFacadeBase::mySelectedInsideColorSet

protected

bool makVrv::DtWedgeFacadeBase::myCentralVertexColorSet

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation