domAnimation_clip Class Reference

#include <domAnimation_clip.h>

Inheritance diagram for domAnimation_clip:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const domAssetRef getAsset () const
const domAssetRef getAsset () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
virtual COLLADA_TYPE::TypeEnum getElementType () const
domFloat getEnd () const
xsDouble getEnd () const
const domExtra_ArraygetExtra_array () const
domExtra_ArraygetExtra_array ()
const domExtra_ArraygetExtra_array () const
domExtra_ArraygetExtra_array ()
xsID getId () const
xsID getId () const
const
domInstance_with_extra_Array
getInstance_animation_array () const
domInstance_with_extra_ArraygetInstance_animation_array ()
const domInstanceWithExtra_ArraygetInstance_animation_array () const
domInstanceWithExtra_ArraygetInstance_animation_array ()
const domInstance_formula_ArraygetInstance_formula_array () const
domInstance_formula_ArraygetInstance_formula_array ()
xsToken getName () const
xsNCName getName () const
domFloat getStart () const
xsDouble getStart () const
void setEnd (domFloat atEnd)
void setEnd (xsDouble atEnd)
void setId (xsID atId)
void setId (xsID atId)
void setName (xsToken atName)
void setName (xsNCName atName)
void setStart (domFloat atStart)
void setStart (xsDouble atStart)
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 daeMetaElementregisterElement (DAE &dae)
static DLLSPEC daeMetaElementregisterElement (DAE &dae)

Protected Member Functions

 domAnimation_clip (DAE &dae)
 domAnimation_clip (DAE &dae)
virtual domAnimation_clipoperator= (const domAnimation_clip &cpy)
virtual domAnimation_clipoperator= (const domAnimation_clip &cpy)
virtual ~domAnimation_clip ()
virtual ~domAnimation_clip ()

Protected Attributes

domFloat attrEnd
xsDouble attrEnd
xsID attrId
xsToken attrName
xsNCName attrName
domFloat attrStart
xsDouble attrStart
domAssetRef elemAsset
domExtra_Array elemExtra_array
domInstance_with_extra_Array elemInstance_animation_array
domInstanceWithExtra_Array elemInstance_animation_array
domInstance_formula_Array elemInstance_formula_array

Detailed Description

The animation_clip element defines a section of the animation curves to be used together as an animation clip.

Definition at line 25 of file 1.4/dom/domAnimation_clip.h.


Constructor & Destructor Documentation

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

Constructor

Definition at line 149 of file 1.4/dom/domAnimation_clip.h.

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

Destructor

Definition at line 153 of file 1.4/dom/domAnimation_clip.h.

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

Constructor

Definition at line 153 of file dom/domAnimation_clip.h.

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

Destructor

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


Member Function Documentation

static DLLSPEC daeElementRef domAnimation_clip::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_clip::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 domAssetRef domAnimation_clip::getAsset (  )  const [inline]

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 118 of file dom/domAnimation_clip.h.

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

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

Definition at line 124 of file 1.4/dom/domAnimation_clip.h.

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

Reimplemented from daeElement.

Definition at line 21 of file dom/domAnimation_clip.h.

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

Reimplemented from daeElement.

Definition at line 28 of file 1.4/dom/domAnimation_clip.h.

domFloat domAnimation_clip::getEnd (  )  const [inline]

Gets the end attribute.

Returns:
Returns a domFloat of the end attribute.

Definition at line 107 of file dom/domAnimation_clip.h.

xsDouble domAnimation_clip::getEnd (  )  const [inline]

Gets the end attribute.

Returns:
Returns a xsDouble of the end attribute.

Definition at line 113 of file 1.4/dom/domAnimation_clip.h.

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

Gets the extra element array.

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

Definition at line 148 of file dom/domAnimation_clip.h.

domExtra_Array& domAnimation_clip::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 143 of file dom/domAnimation_clip.h.

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

Gets the extra element array.

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

Definition at line 144 of file 1.4/dom/domAnimation_clip.h.

domExtra_Array& domAnimation_clip::getExtra_array (  )  [inline]

Gets the extra element array.

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

Definition at line 139 of file 1.4/dom/domAnimation_clip.h.

xsID domAnimation_clip::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 72 of file dom/domAnimation_clip.h.

xsID domAnimation_clip::getId (  )  const [inline]

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

Definition at line 78 of file 1.4/dom/domAnimation_clip.h.

const domInstance_with_extra_Array& domAnimation_clip::getInstance_animation_array (  )  const [inline]

Gets the instance_animation element array.

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

Definition at line 128 of file dom/domAnimation_clip.h.

domInstance_with_extra_Array& domAnimation_clip::getInstance_animation_array (  )  [inline]

Gets the instance_animation element array.

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

Definition at line 123 of file dom/domAnimation_clip.h.

const domInstanceWithExtra_Array& domAnimation_clip::getInstance_animation_array (  )  const [inline]

Gets the instance_animation element array.

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

Definition at line 134 of file 1.4/dom/domAnimation_clip.h.

domInstanceWithExtra_Array& domAnimation_clip::getInstance_animation_array (  )  [inline]

Gets the instance_animation element array.

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

Definition at line 129 of file 1.4/dom/domAnimation_clip.h.

const domInstance_formula_Array& domAnimation_clip::getInstance_formula_array (  )  const [inline]

Gets the instance_formula element array.

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

Definition at line 138 of file dom/domAnimation_clip.h.

domInstance_formula_Array& domAnimation_clip::getInstance_formula_array (  )  [inline]

Gets the instance_formula element array.

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

Definition at line 133 of file dom/domAnimation_clip.h.

xsToken domAnimation_clip::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsToken of the name attribute.

Definition at line 85 of file dom/domAnimation_clip.h.

xsNCName domAnimation_clip::getName (  )  const [inline]

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

Definition at line 91 of file 1.4/dom/domAnimation_clip.h.

domFloat domAnimation_clip::getStart (  )  const [inline]

Gets the start attribute.

Returns:
Returns a domFloat of the start attribute.

Definition at line 96 of file dom/domAnimation_clip.h.

xsDouble domAnimation_clip::getStart (  )  const [inline]

Gets the start attribute.

Returns:
Returns a xsDouble of the start attribute.

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

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

Definition at line 22 of file dom/domAnimation_clip.h.

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

Definition at line 29 of file 1.4/dom/domAnimation_clip.h.

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

Overloaded assignment operator

Definition at line 161 of file dom/domAnimation_clip.h.

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

Overloaded assignment operator

Definition at line 157 of file 1.4/dom/domAnimation_clip.h.

static DLLSPEC daeMetaElement* domAnimation_clip::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_clip::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_clip::setEnd ( domFloat  atEnd  )  [inline]

Sets the end attribute.

Parameters:
atEnd The new value for the end attribute.

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

void domAnimation_clip::setEnd ( xsDouble  atEnd  )  [inline]

Sets the end attribute.

Parameters:
atEnd The new value for the end attribute.

Definition at line 118 of file 1.4/dom/domAnimation_clip.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 77 of file dom/domAnimation_clip.h.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

Definition at line 83 of file 1.4/dom/domAnimation_clip.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 90 of file dom/domAnimation_clip.h.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Definition at line 96 of file 1.4/dom/domAnimation_clip.h.

void domAnimation_clip::setStart ( domFloat  atStart  )  [inline]

Sets the start attribute.

Parameters:
atStart The new value for the start attribute.

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

void domAnimation_clip::setStart ( xsDouble  atStart  )  [inline]

Sets the start attribute.

Parameters:
atStart The new value for the start attribute.

Definition at line 107 of file 1.4/dom/domAnimation_clip.h.

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

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


Member Data Documentation

The end attribute is the time in seconds of the end of the clip. This is used in the same way as the start time. If end is not specified, the value is taken to be the end time of the longest animation. Optional attribute.

Definition at line 50 of file dom/domAnimation_clip.h.

The end attribute is the time in seconds of the end of the clip. This is used in the same way as the start time. If end is not specified, the value is taken to be the end time of the longest animation. Optional attribute.

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

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 37 of file 1.4/dom/domAnimation_clip.h.

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

Definition at line 34 of file dom/domAnimation_clip.h.

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

Definition at line 41 of file 1.4/dom/domAnimation_clip.h.

The start attribute is the time in seconds of the beginning of the clip. This time is the same as that used in the key-frame data and is used to determine which set of key-frames will be included in the clip. The start time does not specify when the clip will be played. If the time falls between two keyframes of a referenced animation, an interpolated value should be used. The default value is 0.0. Optional attribute.

Definition at line 43 of file dom/domAnimation_clip.h.

The start attribute is the time in seconds of the beginning of the clip. This time is the same as that used in the key-frame data and is used to determine which set of key-frames will be included in the clip. The start time does not specify when the clip will be played. If the time falls between two keyframes of a referenced animation, an interpolated value should be used. The default value is 0.0. Optional attribute.

Definition at line 50 of file 1.4/dom/domAnimation_clip.h.

The animation_clip element may contain an asset element.

See also:
domAsset

Definition at line 63 of file 1.4/dom/domAnimation_clip.h.

The extra element may appear any number of times.

See also:
domExtra

Definition at line 71 of file 1.4/dom/domAnimation_clip.h.

The animation_clip must instance at least one animation element.

See also:
domInstance_animation

Definition at line 60 of file dom/domAnimation_clip.h.

The animation_clip must instance at least one animation element.

See also:
domInstance_animation

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

Definition at line 61 of file dom/domAnimation_clip.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