domAnimation Class Reference

#include <domAnimation.h>

Inheritance diagram for domAnimation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const domAnimation_Array & getAnimation_array () const
domAnimation_Array & getAnimation_array ()
const domAnimation_Array & getAnimation_array () const
domAnimation_Array & getAnimation_array ()
const domAssetRef getAsset () const
const domAssetRef getAsset () const
const domChannel_Array & getChannel_array () const
domChannel_Array & getChannel_array ()
const domChannel_Array & getChannel_array () const
domChannel_Array & getChannel_array ()
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
const daeElementRefArray & getContents () const
daeElementRefArray & getContents ()
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
const domExtra_Array & getExtra_array () const
domExtra_Array & getExtra_array ()
xsID getId () const
xsID getId () const
xsToken getName () const
xsNCName getName () const
const domSampler_Array & getSampler_array () const
domSampler_Array & getSampler_array ()
const domSampler_Array & getSampler_array () const
domSampler_Array & getSampler_array ()
const domSource_Array & getSource_array () const
domSource_Array & getSource_array ()
const domSource_Array & getSource_array () const
domSource_Array & getSource_array ()
void setId (xsID atId)
void setId (xsID atId)
void setName (xsToken atName)
void setName (xsNCName atName)
virtual daeInt typeID () const
virtual daeInt typeID () const

Static Public Member Functions

static DLLSPEC daeElementRef create (DAE &dae)
static DLLSPEC daeElementRef create (DAE &dae)
static daeInt ID ()
static daeInt ID ()
static DLLSPEC daeMetaElement * registerElement (DAE &dae)
static DLLSPEC daeMetaElement * registerElement (DAE &dae)

Protected Member Functions

 domAnimation (DAE &dae)
 domAnimation (DAE &dae)
virtual domAnimation & operator= (const domAnimation &cpy)
virtual domAnimation & operator= (const domAnimation &cpy)
virtual ~domAnimation ()
virtual ~domAnimation ()

Protected Attributes

daeTArray< daeCharArray * > _CMData
daeElementRefArray _contents
daeUIntArray _contentsOrder
xsID attrId
xsToken attrName
xsNCName attrName
domAnimation_Array elemAnimation_array
domAssetRef elemAsset
domChannel_Array elemChannel_array
domExtra_Array elemExtra_array
domSampler_Array elemSampler_array
domSource_Array elemSource_array

Detailed Description

The animation element categorizes the declaration of animation information. The animation hierarchy contains elements that describe the animation’s key-frame data and sampler functions, ordered in such a way to group together animations that should be executed together.

The animation element categorizes the declaration of animation information. The animation hierarchy contains elements that describe the animation's key-frame data and sampler functions, ordered in such a way to group together animations that should be executed together.

Definition at line 30 of file 1.4/dom/domAnimation.h.

Constructor & Destructor Documentation

domAnimation::domAnimation ( DAE &  dae  )  [inline, protected]

Constructor

Definition at line 187 of file 1.4/dom/domAnimation.h.

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

Destructor

Definition at line 191 of file 1.4/dom/domAnimation.h.

domAnimation::domAnimation ( DAE &  dae  )  [inline, protected]

Constructor

Definition at line 178 of file dom/domAnimation.h.

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

Destructor

Definition at line 182 of file dom/domAnimation.h.

Member Function Documentation

static DLLSPEC daeElementRef domAnimation::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.
static DLLSPEC daeElementRef domAnimation::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.
const domAnimation_Array& domAnimation::getAnimation_array (  )  const [inline]

Gets the animation element array.

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

Definition at line 152 of file dom/domAnimation.h.

domAnimation_Array& domAnimation::getAnimation_array (  )  [inline]

Gets the animation element array.

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

Definition at line 147 of file dom/domAnimation.h.

const domAnimation_Array& domAnimation::getAnimation_array (  )  const [inline]

Gets the animation element array.

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

Definition at line 161 of file 1.4/dom/domAnimation.h.

domAnimation_Array& domAnimation::getAnimation_array (  )  [inline]

Gets the animation element array.

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

Definition at line 156 of file 1.4/dom/domAnimation.h.

const domAssetRef domAnimation::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 112 of file dom/domAnimation.h.

const domAssetRef domAnimation::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 121 of file 1.4/dom/domAnimation.h.

const domChannel_Array& domAnimation::getChannel_array (  )  const [inline]

Gets the channel element array.

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

Definition at line 142 of file dom/domAnimation.h.

domChannel_Array& domAnimation::getChannel_array (  )  [inline]

Gets the channel element array.

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

Definition at line 137 of file dom/domAnimation.h.

const domChannel_Array& domAnimation::getChannel_array (  )  const [inline]

Gets the channel element array.

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

Definition at line 151 of file 1.4/dom/domAnimation.h.

domChannel_Array& domAnimation::getChannel_array (  )  [inline]

Gets the channel element array.

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

Definition at line 146 of file 1.4/dom/domAnimation.h.

const daeElementRefArray& domAnimation::getContents (  )  const [inline]

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

Definition at line 172 of file dom/domAnimation.h.

daeElementRefArray& domAnimation::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 167 of file dom/domAnimation.h.

const daeElementRefArray& domAnimation::getContents (  )  const [inline]

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

Definition at line 181 of file 1.4/dom/domAnimation.h.

daeElementRefArray& domAnimation::getContents (  )  [inline]

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

Definition at line 176 of file 1.4/dom/domAnimation.h.

virtual COLLADA_TYPE::TypeEnum domAnimation::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 25 of file dom/domAnimation.h.

virtual COLLADA_TYPE::TypeEnum domAnimation::getElementType (  )  const [inline, virtual]

Reimplemented from daeElement.

Definition at line 33 of file 1.4/dom/domAnimation.h.

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

Gets the extra element array.

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

Definition at line 162 of file dom/domAnimation.h.

domExtra_Array& domAnimation::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 157 of file dom/domAnimation.h.

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

Gets the extra element array.

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

Definition at line 171 of file 1.4/dom/domAnimation.h.

domExtra_Array& domAnimation::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 166 of file 1.4/dom/domAnimation.h.

xsID domAnimation::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 88 of file dom/domAnimation.h.

xsID domAnimation::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 97 of file 1.4/dom/domAnimation.h.

xsToken domAnimation::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 101 of file dom/domAnimation.h.

xsNCName domAnimation::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 110 of file 1.4/dom/domAnimation.h.

const domSampler_Array& domAnimation::getSampler_array (  )  const [inline]

Gets the sampler element array.

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

Definition at line 132 of file dom/domAnimation.h.

domSampler_Array& domAnimation::getSampler_array (  )  [inline]

Gets the sampler element array.

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

Definition at line 127 of file dom/domAnimation.h.

const domSampler_Array& domAnimation::getSampler_array (  )  const [inline]

Gets the sampler element array.

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

Definition at line 141 of file 1.4/dom/domAnimation.h.

domSampler_Array& domAnimation::getSampler_array (  )  [inline]

Gets the sampler element array.

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

Definition at line 136 of file 1.4/dom/domAnimation.h.

const domSource_Array& domAnimation::getSource_array (  )  const [inline]

Gets the source element array.

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

Definition at line 122 of file dom/domAnimation.h.

domSource_Array& domAnimation::getSource_array (  )  [inline]

Gets the source element array.

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

Definition at line 117 of file dom/domAnimation.h.

const domSource_Array& domAnimation::getSource_array (  )  const [inline]

Gets the source element array.

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

Definition at line 131 of file 1.4/dom/domAnimation.h.

domSource_Array& domAnimation::getSource_array (  )  [inline]

Gets the source element array.

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

Definition at line 126 of file 1.4/dom/domAnimation.h.

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

Definition at line 26 of file dom/domAnimation.h.

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

Definition at line 34 of file 1.4/dom/domAnimation.h.

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

Overloaded assignment operator

Definition at line 186 of file dom/domAnimation.h.

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

Overloaded assignment operator

Definition at line 195 of file 1.4/dom/domAnimation.h.

static DLLSPEC daeMetaElement* domAnimation::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.
static DLLSPEC daeMetaElement* domAnimation::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.
void domAnimation::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 93 of file dom/domAnimation.h.

void domAnimation::setId ( xsID  atId  )  [inline]

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 102 of file 1.4/dom/domAnimation.h.

void domAnimation::setName ( xsToken  atName  )  [inline]

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 106 of file dom/domAnimation.h.

void domAnimation::setName ( xsNCName  atName  )  [inline]

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 115 of file 1.4/dom/domAnimation.h.

virtual daeInt domAnimation::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 27 of file dom/domAnimation.h.

virtual daeInt domAnimation::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 35 of file 1.4/dom/domAnimation.h.

Member Data Documentation

daeTArray< daeCharArray * > domAnimation::_CMData [protected]

Used to store information needed for some content model objects.

Definition at line 89 of file 1.4/dom/domAnimation.h.

daeElementRefArray domAnimation::_contents [protected]

Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Definition at line 80 of file 1.4/dom/domAnimation.h.

daeUIntArray domAnimation::_contentsOrder [protected]

Used to preserve order in elements that have a complex content model.

Definition at line 84 of file 1.4/dom/domAnimation.h.

xsID domAnimation::attrId [protected]

The id attribute is a text string containing the unique identifier of this element. This value must be unique within the instance document. Optional attribute.

Definition at line 42 of file 1.4/dom/domAnimation.h.

xsToken domAnimation::attrName [protected]

The name attribute is the text string name of this element. Optional attribute.

Definition at line 38 of file dom/domAnimation.h.

xsNCName domAnimation::attrName [protected]

The name attribute is the text string name of this element. Optional attribute.

Definition at line 46 of file 1.4/dom/domAnimation.h.

domAnimation_Array domAnimation::elemAnimation_array [protected]

The animation may be hierarchical and may contain any number of other animation elements.

See also:
domAnimation

Definition at line 72 of file 1.4/dom/domAnimation.h.

domAssetRef domAnimation::elemAsset [protected]

The animation element may contain an asset element.

See also:
domAsset

Definition at line 52 of file 1.4/dom/domAnimation.h.

domChannel_Array domAnimation::elemChannel_array [protected]

The animation element may contain any number of channel elements.

See also:
domChannel

Definition at line 67 of file 1.4/dom/domAnimation.h.

domExtra_Array domAnimation::elemExtra_array [protected]

The extra element may appear any number of times.

See also:
domExtra

Definition at line 76 of file 1.4/dom/domAnimation.h.

domSampler_Array domAnimation::elemSampler_array [protected]

The animation element may contain any number of sampler elements.

See also:
domSampler

Definition at line 62 of file 1.4/dom/domAnimation.h.

domSource_Array domAnimation::elemSource_array [protected]

The animation element may contain any number of source elements.

See also:
domSource

Definition at line 57 of file 1.4/dom/domAnimation.h.

The documentation for this class was generated from the following files:
 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:17 2013