COLLADA 1.4 DOM: domAnimation Class Reference

COLLADA

previous page next page
Main Page | Class Hierarchy | Class List | Directories | Class Members | Related Pages

domAnimation Class Reference

#include <domAnimation.h>

Inheritance diagram for domAnimation:

Inheritance graph
[legend]
Collaboration diagram for domAnimation:

Collaboration graph
[legend]
List of all members.

Detailed Description

The animation element categorizes the declaration of animation information.

The animation contains elements that describe the animation's key-frame data and sampler functions. Animation describes the transformation of an object or value over time. A common use of animation is to give the illusion of motion. A common animation technique is called key-frame animation. A key-frame is a sampling of data at a known point in time. Using a set of key-frames and an interpolation algorithm, intermediate values are computed for times in between the key-frames, producing a smooth set of output values over the interval between the key-frames. A key-frame animation engine performs these computations on the key-frame data. An animation element contains the elements that describe animation data. The actual type and complexity of the data is left to the child elements to represent in detail.

Public Member Functions

xsID getId () const
 Gets the id attribute.
void setId (xsID atId)
 Sets the id attribute.
xsNCName getName () const
 Gets the name attribute.
void setName (xsNCName atName)
 Sets the name attribute.
domSource_Array & getSource_array ()
 Gets the source element array.
const domSource_Array & getSource_array () const
 Gets the source element array.
domSampler_Array & getSampler_array ()
 Gets the sampler element array.
const domSampler_Array & getSampler_array () const
 Gets the sampler element array.
domChannel_Array & getChannel_array ()
 Gets the channel element array.
const domChannel_Array & getChannel_array () const
 Gets the channel element array.

Static Public Member Functions

static daeElementRef create (daeInt bytes)
 Creates an instance of this class and returns a daeElementRef referencing it.
static daeMetaElement * registerElement ()
 Creates a daeMetaElement object that describes this element in the meta object reflection framework.

Static Public Attributes

static daeMetaElement * _Meta = NULL
 The daeMetaElement that describes this element in the meta object reflection framework.

Protected Member Functions

 domAnimation ()
 Constructor.
virtual ~domAnimation ()
 Destructor.
 domAnimation (const domAnimation &cpy)
 Copy Constructor.
virtual domAnimation & operator= (const domAnimation &cpy)
 Overloaded assignment operator.

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the animation element.
xsNCName attrName
 The name attribute is the text string name of this element.
domSource_Array elemSource_array
 The animation element must contain one or more source elements.
domSampler_Array elemSampler_array
 The animation element must contain one or more sampler elements.
domChannel_Array elemChannel_array
 The animation element must contain one or more channel elements.

Member Function Documentation

daeElementRef domAnimation::create (  daeInt  bytes  )  [static]
 

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

Parameters:
bytes The size allocated for this instance.
Returns:
a daeElementRef referencing an instance of this object.

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

Gets the channel element array.

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

domChannel_Array& domAnimation::getChannel_array (   )  [inline]
 

Gets the channel element array.

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

xsID domAnimation::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domAnimation::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

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

Gets the sampler element array.

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

domSampler_Array& domAnimation::getSampler_array (   )  [inline]
 

Gets the sampler element array.

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

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

Gets the source element array.

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

domSource_Array& domAnimation::getSource_array (   )  [inline]
 

Gets the source element array.

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

daeMetaElement * domAnimation::registerElement (   )  [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.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domAnimation::attrId [protected]
 

The id attribute is a text string containing the unique identifier of the animation element.

This value must be unique within the instance document. Optional attribute.

xsNCName domAnimation::attrName [protected]
 

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

Optional attribute.

domChannel_Array domAnimation::elemChannel_array [protected]
 

The animation element must contain one or more channel elements.

See also:
domChannel

domSampler_Array domAnimation::elemSampler_array [protected]
 

The animation element must contain one or more sampler elements.

See also:
domSampler

domSource_Array domAnimation::elemSource_array [protected]
 

The animation element must contain one or more source elements.

See also:
domSource
The documentation for this class was generated from the following files:
  • C:/SVN_wf/COLLADA_DOM/include/1.3/dom/domAnimation.h
  • C:/SVN_wf/COLLADA_DOM/src/1.3/dom/domAnimation.cpp
©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:47:11 2006 for COLLADA 1.4 DOM by doxygen 1.4.3

previous page start next page