VR-Forces 4.8 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 | Protected Attributes
makVrv::DtWindowEllipse Class Reference

A model-like object that draws a 2D ellipse. More...

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

Public Member Functions

 DtWindowEllipse (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtWindowEllipse ()
 DTOR. More...
 
virtual void setCenter (double x, double y)
 Set the center of the ellipse in normalized screen coordinates. More...
 
virtual void setDimensions (double xLength, double yLength)
 Set the dimensions of the ellipse (the lengths of its axes) in normalizes screen coordinates. More...
 
virtual void setNumVertices (int numVertices)
 Set the number of vertices to use in approximating the ellipse; Default is 32. More...
 
virtual void setVisible (bool isVisible)
 Set the ellipse's visibility. More...
 
virtual void setStipplePattern (unsigned int stipplePattern)
 Set the stipple pattern. More...
 
virtual void setColor (float r, float g, float b, float a)
 Set the ellipse's color. More...
 
virtual void setFill (bool fill)
 Set the ellipse to filled or outlined. More...
 
virtual void setInstance (DtWindowEllipseInstance *instance)
 Set or replace the line instance for the line Transfers ownership. More...
 
virtual DtWindowEllipseInstanceinstance ()
 Get the line instance for the line. More...
 
- Public Member Functions inherited from makVrv::DtWindowObject
 DtWindowObject (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtWindowObject ()
 DTOR. More...
 
virtual bool visible ()
 
virtual DtUniqueID uniqueId ()
 Returns the unique ID of this object. More...
 
DtWindowObjectgetParent ()
 Get the parent windowObject. More...
 
virtual ChildList childList ()
 Returns the child list. More...
 
virtual void addChild (DtUniqueID id)
 Add a child to this objects child list. More...
 
virtual void removeChild (DtUniqueID id)
 Remove a child from this objects child list. More...
 
virtual void getColor (float &r, float &g, float &b, float &a)
 
virtual Transform windowTransform ()
 Get the window transform that is the total transform of this object and all it's parents. More...
 
virtual DtVector2d windowScale ()
 Get the window scale of the object. More...
 
virtual DtClipBox clipBox ()
 Get this object's clip box specifications. More...
 
virtual void setParentId (DtUniqueID parentId)
 Get / Set Parent IDs. More...
 
virtual DtUniqueID getParentId ()
 
virtual void setPosition (double x, double y)
 Set / Get the window position of this object. More...
 
virtual void getPosition (double &x, double &y)
 
virtual void setScale (double scale)
 Set / Get the scale of the x y components. More...
 
virtual void setScale (double x, double y)
 
virtual void getScale (double &x, double &y)
 
virtual void setRotation (double rotation)
 Set / Get the rotation of the window object around it's set position, (0.0,0.0) if none is set. More...
 
virtual void getRotation (double &rotation)
 
virtual void setInheritColor (bool inheritColor)
 Set / Get whether this object inherits it's color from it's parent. More...
 
virtual bool inheritColor ()
 

Protected Member Functions

virtual void update ()
 Called on signal_postUpdate; time to update render data. More...
 
virtual void needsUpdate ()
 Called by all mutators to set up a postUpdate signal if not already connected. More...
 

Protected Attributes

DtWindowEllipseInstancemyInstance
 
bool myConnectedToPostUpdate
 
- Protected Attributes inherited from makVrv::DtWindowObject
DtDemyDe
 
DtUniqueID myUniqueId
 
DtUniqueID myParentId
 
ChildList myChildIdList
 
DtVector2d myPosition
 
DtVector2d myScale
 
DtVector2d myWindowScale
 
double myRotation
 
bool myVisible
 
bool myInheritColor
 
float myColorR
 
float myColorG
 
float myColorB
 
float myColorA
 
Transform myRelativeTransform
 
Transform myWindowTransform
 
DtClipBox myClipBox
 

Additional Inherited Members

- Public Types inherited from makVrv::DtWindowObject
typedef std::list< DtUniqueIDChildList
 typedef list for holding the IDs of the children of this class More...
 
typedef DtVector2< doubleDtVector2d
 typedef 2D Vector More...
 
typedef DtMatrix3< doubleTransform
 typedef 3x3 Matrix for holding this object's transform More...
 

Detailed Description

A model-like object that draws a 2D ellipse.

This ellipse class inherits from DtWindowObject() which means it can be included in a parent/child relationship with other window objects, including surfaces, polygons, text, and lines. Vertices for this ellipse are relative to a fixed position, this is the position set for the center. Rotations are also relative to this position. If a position is not set, the default position is (0.0,0.0). If this object is a child of a surface, and that surface has a clip box set, this objects vertices will automatically be clipped in it's update method. If this object is a child of another object, the position set is relative to the parent.

Constructor & Destructor Documentation

makVrv::DtWindowEllipse::DtWindowEllipse ( DtDe de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtWindowEllipse::~DtWindowEllipse ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindowEllipse::setCenter ( double  x,
double  y 
)
virtual

Set the center of the ellipse in normalized screen coordinates.

For example, setCenter(0.1, 0.5) sets the center to 10% horizontally from the left of the creen and 50% vertically from the bottom

virtual void makVrv::DtWindowEllipse::setDimensions ( double  xLength,
double  yLength 
)
virtual

Set the dimensions of the ellipse (the lengths of its axes) in normalizes screen coordinates.

For example, setDimensions(0.3, 0.5) sets the ellipse to 30% of the screen size horizontally and 50% vertically.

virtual void makVrv::DtWindowEllipse::setNumVertices ( int  numVertices)
virtual

Set the number of vertices to use in approximating the ellipse; Default is 32.

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

Set the ellipse's visibility.

Reimplemented from makVrv::DtWindowObject.

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

Set the stipple pattern.

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

Set the ellipse's color.

Reimplemented from makVrv::DtWindowObject.

virtual void makVrv::DtWindowEllipse::setFill ( bool  fill)
virtual

Set the ellipse to filled or outlined.

virtual void makVrv::DtWindowEllipse::setInstance ( DtWindowEllipseInstance instance)
virtual

Set or replace the line instance for the line Transfers ownership.

virtual DtWindowEllipseInstance* makVrv::DtWindowEllipse::instance ( )
virtual

Get the line instance for the line.

virtual void makVrv::DtWindowEllipse::update ( )
protectedvirtual

Called on signal_postUpdate; time to update render data.

virtual void makVrv::DtWindowEllipse::needsUpdate ( )
protectedvirtual

Called by all mutators to set up a postUpdate signal if not already connected.

Reimplemented from makVrv::DtWindowObject.

Member Data Documentation

DtWindowEllipseInstance* makVrv::DtWindowEllipse::myInstance
protected
bool makVrv::DtWindowEllipse::myConnectedToPostUpdate
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)