domEllipse Class Reference

#include <domEllipse.h>

Inheritance diagram for domEllipse:

[legend]

List of all members.

Classes
class	domRadius
Public Types
typedef daeTArray< domRadiusRef >	domRadius_Array
typedef daeSmartRef< domRadius >	domRadiusRef
Public Member Functions
virtual COLLADA_TYPE::TypeEnum	getElementType () const
const domExtra_Array &	getExtra_array () const
domExtra_Array &	getExtra_array ()
const domRadiusRef	getRadius () const
virtual daeInt	typeID () const
Static Public Member Functions
static DLLSPEC daeElementRef	create (DAE &dae)
static daeInt	ID ()
static DLLSPEC daeMetaElement *	registerElement (DAE &dae)
Protected Member Functions
	domEllipse (DAE &dae)
virtual domEllipse &	operator= (const domEllipse &cpy)
virtual	~domEllipse ()
Protected Attributes
domExtra_Array	elemExtra_array
domRadiusRef	elemRadius

---

Detailed Description

Describes an ellipse in 3D space. An ellipse is defined by its major and minor radii and, as with any conic curve, is positioned in space with a right-handed coordinate system where: - the origin is the center of the ellipse, - the "X Direction" defines the major axis, and

• the "Y Direction" defines the minor axis. The origin, "X Direction" and "Y Direction" of this coordinate system define the plane of the ellipse. The coordinate system is the local coordinate system of the ellipse. The "main Direction" of this coordinate system is the vector normal to the plane of the ellipse. The axis, of which the origin and unit vector are respectively the origin and "main Direction" of the local coordinate system, is termed the "Axis" or "main Axis" of the ellipse. The "main Direction" of the local coordinate system gives an explicit orientation to the ellipse (definition of the trigonometric sense), determining the direction in which the parameter increases along the ellipse. The Geom_Ellipse ellipse is parameterized by an angle: P(U) = O + MajorRad*Cos(U)*XDir + MinorRad*Sin(U)*YDir where: - P is the point of parameter U, - O, XDir and YDir are respectively the origin, "X <br> Direction" and "Y Direction" of its local coordinate system, - MajorRad and MinorRad are the major and minor radii of the ellipse. The "X Axis" of the local coordinate system therefore defines the origin of the parameter of the ellipse. An ellipse is a closed and periodic curve. The period is 2.*Pi and the parameter range is [ 0, 2.*Pi [.

Definition at line 36 of file domEllipse.h.

---

Member Typedef Documentation

typedef daeTArray<domRadiusRef> domEllipse::domRadius_Array

Definition at line 46 of file domEllipse.h.

typedef daeSmartRef<domRadius> domEllipse::domRadiusRef

Definition at line 43 of file domEllipse.h.

---

Constructor & Destructor Documentation

domEllipse::domEllipse

(

DAE &

dae

)

[inline, protected]

Constructor

Definition at line 127 of file domEllipse.h.

virtual domEllipse::~domEllipse

(

)

[inline, protected, virtual]

Destructor

Definition at line 131 of file domEllipse.h.

---

Member Function Documentation

static DLLSPEC daeElementRef domEllipse::create

(

DAE &

dae

)

[static]

Creates an instance of this class and returns a daeElementRef referencing it.

Returns:

a daeElementRef referencing an instance of this object.

virtual COLLADA_TYPE::TypeEnum domEllipse::getElementType

(

)

const [inline, virtual]

Reimplemented from daeElement.

Definition at line 39 of file domEllipse.h.

const domExtra_Array& domEllipse::getExtra_array

(

)

const [inline]

Gets the extra element array.

Returns:

Returns a constant reference to the array of extra elements.

Definition at line 122 of file domEllipse.h.

domExtra_Array& domEllipse::getExtra_array

(

)

[inline]

Gets the extra element array.

Returns:

Returns a reference to the array of extra elements.

Definition at line 117 of file domEllipse.h.

const domRadiusRef domEllipse::getRadius

(

)

const [inline]

Gets the radius element.

Returns:

a daeSmartRef to the radius element.

Definition at line 112 of file domEllipse.h.

static daeInt domEllipse::ID

(

)

[inline, static]

Definition at line 40 of file domEllipse.h.

virtual domEllipse& domEllipse::operator=

(

const domEllipse &

cpy

)

[inline, protected, virtual]

Overloaded assignment operator

Definition at line 135 of file domEllipse.h.

static DLLSPEC daeMetaElement* domEllipse::registerElement

(

DAE &

dae

)

[static]

Creates a daeMetaElement object that describes this element in the meta object reflection framework. If a daeMetaElement already exists it will return that instead of creating a new one.

Returns:

A daeMetaElement describing this COLLADA element.

virtual daeInt domEllipse::typeID

(

)

const [inline, virtual]

Returns this element's type ID. Every element is an instance of a type specified in the Collada schema, and every schema type has a unique ID.

Returns:

The element's type ID.

Implements daeElement.

Definition at line 41 of file domEllipse.h.

---

Member Data Documentation

domExtra_Array domEllipse::elemExtra_array [protected]

Definition at line 105 of file domEllipse.h.

domRadiusRef domEllipse::elemRadius [protected]

Definition at line 104 of file domEllipse.h.

---

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

• domEllipse.h