VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Private Member Functions
makVrv::Dt2DArcFacade Class Reference

Implementation of a 2D (overlay) Arc Facade. More...

Inheritance diagram for makVrv::Dt2DArcFacade:
Inheritance graph
[legend]

Public Member Functions

 Dt2DArcFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that takes an existing scene object agent. More...
 
 Dt2DArcFacade (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 ~Dt2DArcFacade ()
 Destructor. More...
 
- Public Member Functions inherited from makVrv::DtArcFacadeBase
virtual ~DtArcFacadeBase ()
 Destructor. More...
 
virtual void setDynamicOrigin (bool)
 Sets whether or not the origin's position is changing or not If the origin is changing (hence dynamic), we use the DtArcUpdaterAgent to update the arc's origin instead of using the arc'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...
 
DtArcUpdaterAgent * findUpdater () const
 Returns the updater agent for this class, can return null. More...
 
DtSceneObjectAgent * sceneObjectAgent () const
 Returns the scene object agent for this class. More...
 
virtual void setPosition (int index, const DtVector &position)
 Set the position of a vertex in the arc. More...
 
virtual void setModelDefinition (const std::string &)
 Sets the model definition for the model. More...
 
virtual void setPickable (bool)
 Sets whether or not items are pickable. More...
 
virtual void setGroup (int)
 Sets the group this overlay will be drawn in The higher the group number, the "closer" to the eyepoint this overlay will be drawn. More...
 
DtOverlayArcModelAgent * findArcAgent ()
 Returns the arc model agent used for this class This function can return null. More...
 
virtual void setSelected (bool)
 Set/Get whether or not the arc is selected Default value is false (not selected) More...
 
virtual bool isSelected () const
 
virtual void setDimensions (double x, double y)
 Set/Get the axis lengths of the ellipse used to draw the arc Default value is 0, 0. More...
 
virtual bool getDimensions (double &x, double &y) const
 
virtual void setScale (float scale)
 Set/Get the scale factor of the arc Default value is 1. More...
 
virtual float scale () const
 
virtual void setVisible (bool isVisible)
 Set/Get whether the arc is visible Default value is true (visible) More...
 
virtual bool isVisible () const
 
virtual void setMaxAngleSegment (double angleSegmentMax)
 Set/Get the max angle segment used when building the geometry Default value is PI / 18. More...
 
virtual double maxAngleSegment () const
 
virtual void setStartAngle (double startAngle)
 Set/Get the start angle of the arc, in radians Default value is 0. More...
 
virtual double startAngle () const
 
virtual void setEndAngle (double endAngle)
 Set/Get the end angle of the arc, in radians Default value is PI. More...
 
virtual double endAngle () const
 
virtual void setStipplePattern (unsigned int stipplePattern)
 Set/Get the stipple line pattern of the arc Default value is 0xFFFF. More...
 
virtual unsigned int stipplePattern () const
 
virtual void setLineWidth (float width)
 Set/Get the line width of the arc Uses DtLineSegmentInterface::setWidth 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 arc - default is (0, 0, 0, 1). More...
 
virtual bool getColor (float &r, float &g, float &b, float &a) const
 
virtual void setSelectedColor (float r, float g, float b, float a)
 Set/Get the selected color of the arc - default is (1, 1, 1, 1). More...
 
virtual bool getSelectedColor (float &r, float &g, float &b, float &a) const
 

Protected Member Functions

void createAndInitializeArcAgent ()
 Creates the arc agent. More...
 
- Protected Member Functions inherited from makVrv::DtArcFacadeBase
 DtArcFacadeBase (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...
 
 DtArcFacadeBase (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

 Dt2DArcFacade ()
 Default Constructor not implemented. More...
 
 Dt2DArcFacade (const Dt2DArcFacade &)
 Copy Constructor not implemented – Copy not allowed. More...
 
Dt2DArcFacadeoperator= (const Dt2DArcFacade &)
 Assignment Operator not implemented – Copy not allowed. More...
 

Additional Inherited Members

- Protected Attributes inherited from makVrv::DtArcFacadeBase
DtOverlayArcModelAgent * myArcModelAgent
 
DtSceneObjectAgent * mySceneObjectAgent
 
DtAgentManagerInterfacemyAgentManagerInterface
 
bool myOwnsSceneObjectAgent
 
int myModelSet
 
DtArcUpdaterAgent * myUpdater
 
float myColor [4]
 
float mySelectedColor [4]
 
makVrv::DtElementID myElementId
 
bool myDynamicOrigin
 
bool mySelected
 
DtVector myPosition
 
double myStartAngle
 
double myEndAngle
 
double myMaxAngleSegment
 
double myDimensions [2]
 
float myScale
 
bool myVisible
 
unsigned int myStipplePattern
 
float myLineWidth
 

Detailed Description

Implementation of a 2D (overlay) Arc Facade.

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

This implementation draws an elliptical arc with the following geometric parameters:

This implementation draws an elliptical arc has the following style properties:

A utility function is provided to allow arc generation given vertices - refer to setVertices for more info.

Constructor & Destructor Documentation

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

Constructor that takes an existing scene object agent.

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

Destructor.

makVrv::Dt2DArcFacade::Dt2DArcFacade ( )
private

Default Constructor not implemented.

makVrv::Dt2DArcFacade::Dt2DArcFacade ( const Dt2DArcFacade )
private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

void makVrv::Dt2DArcFacade::createAndInitializeArcAgent ( )
protected

Creates the arc agent.

Dt2DArcFacade& makVrv::Dt2DArcFacade::operator= ( const Dt2DArcFacade )
private

Assignment Operator not implemented – Copy not allowed.


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)