domCircle Class Reference

#include <domCircle.h>

Inheritance diagram for domCircle:
Inheritance graph
[legend]

List of all members.

Classes

class  domRadius

Public Types

typedef daeTArray< domRadiusRefdomRadius_Array
typedef daeSmartRef< domRadiusdomRadiusRef

Public Member Functions

virtual COLLADA_TYPE::TypeEnum getElementType () const
const domExtra_ArraygetExtra_array () const
domExtra_ArraygetExtra_array ()
const domRadiusRef getRadius () const
virtual daeInt typeID () const

Static Public Member Functions

static DLLSPEC daeElementRef create (DAE &dae)
static daeInt ID ()
static DLLSPEC daeMetaElementregisterElement (DAE &dae)

Protected Member Functions

 domCircle (DAE &dae)
virtual domCircleoperator= (const domCircle &cpy)
virtual ~domCircle ()

Protected Attributes

domExtra_Array elemExtra_array
domRadiusRef elemRadius

Detailed Description

Describes a circle. A circle is defined by its radius and, as with any conic curve, is positioned in space with a right-handed coordinate system where: - the origin is the center of the circle, and - the origin, "X Direction" and "Y Direction" define the plane of the circle. This coordinate system is the local coordinate system of the circle. The "main Direction" of this coordinate system is the vector normal to the plane of the circle. 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 circle. The "main Direction" of the local coordinate system gives an explicit orientation to the circle (definition of the trigonometric sense), determining the direction in which the parameter increases along the circle. The Geom_Circle circle is parameterized by an angle: P(U) = O + R*Cos(U)*XDir + R*Sin(U)*YDir, where: - P is the point of parameter U, - O, XDir and YDir are respectively the origin, "X Direction" and "Y Direction" of its local coordinate system, - R is the radius of the circle. The "X Axis" of the local coordinate system therefore defines the origin of the parameter of the circle. The parameter is the angle with this "X Direction". A circle is a closed and periodic curve. The period is 2.*Pi and the parameter range is [ 0, 2.*Pi [.

Definition at line 33 of file domCircle.h.


Member Typedef Documentation

Definition at line 43 of file domCircle.h.

Definition at line 40 of file domCircle.h.


Constructor & Destructor Documentation

domCircle::domCircle ( DAE dae  )  [inline, protected]

Constructor

Definition at line 124 of file domCircle.h.

virtual domCircle::~domCircle (  )  [inline, protected, virtual]

Destructor

Definition at line 128 of file domCircle.h.


Member Function Documentation

static DLLSPEC daeElementRef domCircle::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 domCircle::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 36 of file domCircle.h.

const domExtra_Array& domCircle::getExtra_array (  )  const [inline]

Gets the extra element array.

Returns:
Returns a constant reference to the array of extra elements.

Definition at line 119 of file domCircle.h.

domExtra_Array& domCircle::getExtra_array (  )  [inline]

Gets the extra element array.

Returns:
Returns a reference to the array of extra elements.

Definition at line 114 of file domCircle.h.

const domRadiusRef domCircle::getRadius (  )  const [inline]

Gets the radius element.

Returns:
a daeSmartRef to the radius element.

Definition at line 109 of file domCircle.h.

static daeInt domCircle::ID (  )  [inline, static]

Definition at line 37 of file domCircle.h.

virtual domCircle& domCircle::operator= ( const domCircle cpy  )  [inline, protected, virtual]

Overloaded assignment operator

Definition at line 132 of file domCircle.h.

static DLLSPEC daeMetaElement* domCircle::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 domCircle::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 38 of file domCircle.h.


Member Data Documentation

Definition at line 102 of file domCircle.h.

Definition at line 101 of file domCircle.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


colladadom
Author(s): Du Hung Hou, Khronos.org, Marcus Barnes, Greg Corson, Herbert Law, Sebastian Schwarz, Steven Thomas, John Hsu (ros package), Tim Field (ros package)
autogenerated on Fri Jan 11 09:29:47 2013