domHyperbola Class Reference

#include <domHyperbola.h>

Inheritance diagram for domHyperbola:
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

 domHyperbola (DAE &dae)
virtual domHyperbolaoperator= (const domHyperbola &cpy)
virtual ~domHyperbola ()

Protected Attributes

domExtra_Array elemExtra_array
domRadiusRef elemRadius

Detailed Description

Describes a branch of a hyperbola in 3D space. A hyperbola 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 hyperbola, - 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 hyperbola. The coordinate system is the local coordinate system of the hyperbola. The branch of the hyperbola described is the one located on the positive side of the major axis. The "main Direction" of the local coordinate system is a vector normal to the plane of the hyperbola. 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 hyperbola. The "main Direction" of the local coordinate system gives an explicit orientation to the hyperbola, determining the direction in which the parameter increases along the hyperbola. The Geom_Hyperbola hyperbola is parameterized as follows: P(U) = O + MajRad*Cosh(U)*XDir + MinRad*Sinh(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, - MajRad and MinRad are the major and minor radii of the hyperbola. The "X Axis" of the local coordinate system therefore defines the origin of the parameter of the hyperbola. The parameter range is ] -infinite, +infinite [.

Definition at line 36 of file domHyperbola.h.


Member Typedef Documentation

Definition at line 46 of file domHyperbola.h.

Definition at line 43 of file domHyperbola.h.


Constructor & Destructor Documentation

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

Constructor

Definition at line 127 of file domHyperbola.h.

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

Destructor

Definition at line 131 of file domHyperbola.h.


Member Function Documentation

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

Reimplemented from daeElement.

Definition at line 39 of file domHyperbola.h.

const domExtra_Array& domHyperbola::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 domHyperbola.h.

domExtra_Array& domHyperbola::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 117 of file domHyperbola.h.

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

Gets the radius element.

Returns:
a daeSmartRef to the radius element.

Definition at line 112 of file domHyperbola.h.

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

Definition at line 40 of file domHyperbola.h.

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

Overloaded assignment operator

Definition at line 135 of file domHyperbola.h.

static DLLSPEC daeMetaElement* domHyperbola::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 domHyperbola::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 domHyperbola.h.


Member Data Documentation

Definition at line 105 of file domHyperbola.h.

Definition at line 104 of file domHyperbola.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:31:24 2013