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

Contains Dt3DEllipseFacadeclass. More...

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

Public Member Functions

 Dt3DEllipseFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 Dt3DEllipseFacade (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~Dt3DEllipseFacade ()
 DTOR.
virtual void setModelDefinition (const std::string &)
 Sets the model definition for the model.
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the ellipse.
virtual void setSelected (bool)
 Sets whether or not the ellipse is selected.
virtual void setPosition (int index, const DtVector &v)
 Sets database position in updater (if created) or model agent.
virtual void setFillPattern (const std::vector< unsigned int > &)
 Unimplemented as ellipses to not currently support fill patterns.
virtual void setStipplePattern (int)
 Unimplemented as ellipses do not currently support stipple patterns.
virtual void setLineWidth (int)
 Sets the width of the outside line.
virtual void setXRadius (double)
 Sets the X Radius of the llipse.
virtual void setYRadius (double)
 Sets the Y Radius of the ellipse.
virtual void setDimensions (double, double)
 Sets the dimensions of the ellipse.
virtual void setOutsideColor (float r, float g, float b, float a)
 Sets the outside color (rim) if available.
virtual void setInsideColor (float r, float g, float b, float a)
 Sets inside color (fill) if available.
virtual void setFill (bool)
 Sets whether or not to fill ellipse. If fill style of line is specified, will override this flag.
virtual void setPickable (bool)
 Sets whether or not items are pickable.
virtual void setVisible (bool)
 Sets whether or not item is visible.
bool selected () const
 Returns whether or not this facade is selected.
virtual void setScribeWidth (float width)
 Sets the width of the scribe line in pixel space.
int scribeWidth () const
 Returns current scribe width.
virtual void setScribed (bool)
 Sets whether or not line is scribed.
virtual void setScribeColor (float r, float g, float b, float a)
 Sets the color of the scribe. By default it is based on outside color at 0% alpha.
virtual void setLineHeight (float)
 Sets the height of all lines in the area (up extent). Setting this will turn off line width.
virtual void setSolid (bool b)
 Sets whether or not this item is solid (filled)
virtual void setScribeAllPolygons (bool)
 Sets whether or not to only scribe the outline (and not the line edges).
virtual void startClamping ()
 Create an updater to update the orientation of this object, not the position.
DtExtrudedEllipseModelAgent * ellipseModelAgent () const
 Returns the ellipse model agent for this class.
virtual void setUpExtent (float)
virtual float upExtent () const
virtual void setDownExtent (float)
virtual float downExtent () const
virtual void setLeftExtent (float)
virtual float leftExtent () const
virtual void setRightExtent (float)
virtual float rightExtent () const
- Public Member Functions inherited from makVrv::DtEllipseFacadeBase
 DtEllipseFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 DtEllipseFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~DtEllipseFacadeBase ()
 DTOR.
virtual void setPoints (const std::vector< DtVector > &)
 Sets the origin, and, possible radii of the ellipse.
virtual void setOrigin (const DtVector &)
 Sets the origin of the ellipse.
virtual makVrv::DtUniqueID uniqueId () const
 Returns the unique id of the scene object agent.
virtual makVrv::DtElementID elementId () const
 Returns the element id of the scene object agent.
virtual int modelSet () const
 Returns the model set.
virtual void setDynamicOrigin (bool)
 Sets whether or origin is set in the updater or retrieved from the scene object.
virtual void stopClamping ()
 Stops clamping the ellipse.
DtEllipseUpdaterAgent * updater () const
 Returns the updater agent for this class.
DtSceneObjectAgent * sceneObjectAgent () const
 Returns the scene object agent for this class.

Protected Member Functions

void createEllipseAgent ()
 Creates ellipse agent. Called from constructor.

Protected Attributes

DtExtrudedEllipseModelAgent * myEllipseModelAgent
bool myFill
bool mySelected
float myLineHeight
float myUpExtent
float myDownExtent
float myRightExtent
float myLeftExtent
bool myScribeColorSet
float myScribeWidth
- Protected Attributes inherited from makVrv::DtEllipseFacadeBase
DtSceneObjectAgent * mySceneObjectAgent
DtAgentManagerInterfacemyAgentManagerInterface
bool myOwnsSceneObjectAgent
DtEllipseUpdaterAgent * myUpdater
float myInsideColor [4]
float myOutsideColor [4]
int myLineWidth
int myModelSet
int myNumPoints
double myXRadius
double myYRadius
makVrv::DtElementID myElementId
bool myDynamicOrigin

Detailed Description

Contains Dt3DEllipseFacadeclass.

Facade for a 3D (overlay). This class will not clamp by default ellipse.

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

makVrv::Dt3DEllipseFacade::Dt3DEllipseFacade ( DtAgentManagerInterface ,
int  modelSet,
DtElementID  id,
bool  distribute = true 
)

Will create a new scene object agent for the given model set and element id.

virtual makVrv::Dt3DEllipseFacade::~Dt3DEllipseFacade ( )
virtual

DTOR.

Member Function Documentation

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

Sets the model definition for the model.

Implements makVrv::DtEllipseFacadeBase.

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

Sets the color for the ellipse.

This will apply to all segments of the area. If the default (all 0's), uses the default as defined in the visual definition

Reimplemented from makVrv::DtEllipseFacadeBase.

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

Sets whether or not the ellipse is selected.

Implements makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setPosition ( int  index,
const DtVector v 
)
virtual

Sets database position in updater (if created) or model agent.

Reimplemented from makVrv::DtEllipseFacadeBase.

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

Unimplemented as ellipses to not currently support fill patterns.

Implements makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setStipplePattern ( int  )
virtual

Unimplemented as ellipses do not currently support stipple patterns.

Implements makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setLineWidth ( int  )
virtual

Sets the width of the outside line.

Implements makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setXRadius ( double  )
virtual

Sets the X Radius of the llipse.

Reimplemented from makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setYRadius ( double  )
virtual

Sets the Y Radius of the ellipse.

Reimplemented from makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setDimensions ( double  ,
double   
)
virtual

Sets the dimensions of the ellipse.

Reimplemented from makVrv::DtEllipseFacadeBase.

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

Sets the outside color (rim) if available.

Reimplemented from makVrv::DtEllipseFacadeBase.

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

Sets inside color (fill) if available.

Reimplemented from makVrv::DtEllipseFacadeBase.

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

Sets whether or not to fill ellipse. If fill style of line is specified, will override this flag.

Implements makVrv::DtEllipseFacadeBase.

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

Sets whether or not items are pickable.

Implements makVrv::DtEllipseFacadeBase.

virtual void makVrv::Dt3DEllipseFacade::setVisible ( bool  )
virtual

Sets whether or not item is visible.

Implements makVrv::DtEllipseFacadeBase.

bool makVrv::Dt3DEllipseFacade::selected ( ) const
inline

Returns whether or not this facade is selected.

virtual void makVrv::Dt3DEllipseFacade::setScribeWidth ( float  width)
virtual

Sets the width of the scribe line in pixel space.

This will set a flag such that when the line width is changed this width is not, so, once set, you will need to continue to set to keep pace with line width.

int makVrv::Dt3DEllipseFacade::scribeWidth ( ) const

Returns current scribe width.

virtual void makVrv::Dt3DEllipseFacade::setScribed ( bool  )
virtual

Sets whether or not line is scribed.

virtual void makVrv::Dt3DEllipseFacade::setScribeColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the scribe. By default it is based on outside color at 0% alpha.

virtual void makVrv::Dt3DEllipseFacade::setLineHeight ( float  )
virtual

Sets the height of all lines in the area (up extent). Setting this will turn off line width.

virtual void makVrv::Dt3DEllipseFacade::setSolid ( bool  b)
virtual

Sets whether or not this item is solid (filled)

virtual void makVrv::Dt3DEllipseFacade::setScribeAllPolygons ( bool  )
virtual

Sets whether or not to only scribe the outline (and not the line edges).

Only valid if scribed is true. If set to true will scribe all point connections along the polygon. If false will only scribe the top and bottom of the polygon

virtual void makVrv::Dt3DEllipseFacade::setUpExtent ( float  )
virtual

Sets the values of the extents of the line. Extents of the line are different than the width or height in that in setting the width or height those are centered around the points. The extents work from the point and move in the direction of the extent in topographic space. For example, if you imagine a straight line, the up extent moves straight up from that line, the down extent straight down, left to the left and right to the right. As the line rotates and orients the extents orient and rotate with that line

virtual float makVrv::Dt3DEllipseFacade::upExtent ( ) const
virtual
virtual void makVrv::Dt3DEllipseFacade::setDownExtent ( float  )
virtual
virtual float makVrv::Dt3DEllipseFacade::downExtent ( ) const
virtual
virtual void makVrv::Dt3DEllipseFacade::setLeftExtent ( float  )
virtual
virtual float makVrv::Dt3DEllipseFacade::leftExtent ( ) const
virtual
virtual void makVrv::Dt3DEllipseFacade::setRightExtent ( float  )
virtual
virtual float makVrv::Dt3DEllipseFacade::rightExtent ( ) const
virtual
virtual void makVrv::Dt3DEllipseFacade::startClamping ( )
virtual

Create an updater to update the orientation of this object, not the position.

Reimplemented from makVrv::DtEllipseFacadeBase.

DtExtrudedEllipseModelAgent* makVrv::Dt3DEllipseFacade::ellipseModelAgent ( ) const

Returns the ellipse model agent for this class.

void makVrv::Dt3DEllipseFacade::createEllipseAgent ( )
protected

Creates ellipse agent. Called from constructor.

Member Data Documentation

DtExtrudedEllipseModelAgent* makVrv::Dt3DEllipseFacade::myEllipseModelAgent
protected
bool makVrv::Dt3DEllipseFacade::myFill
protected
bool makVrv::Dt3DEllipseFacade::mySelected
protected
float makVrv::Dt3DEllipseFacade::myLineHeight
protected
float makVrv::Dt3DEllipseFacade::myUpExtent
protected
float makVrv::Dt3DEllipseFacade::myDownExtent
protected
float makVrv::Dt3DEllipseFacade::myRightExtent
protected
float makVrv::Dt3DEllipseFacade::myLeftExtent
protected
bool makVrv::Dt3DEllipseFacade::myScribeColorSet
protected
float makVrv::Dt3DEllipseFacade::myScribeWidth
protected

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

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)