COLLADA 1.4 DOM: domSampler Class Reference

COLLADA

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

domSampler Class Reference

#include <domSampler.h>

Inheritance diagram for domSampler:

Inheritance graph
[legend]
Collaboration diagram for domSampler:

Collaboration graph
[legend]
List of all members.

Detailed Description

The sampler element declares an N-dimensional function.

Animation function curves are represented by 1-D sampler elements in COLLADA. The sampler defines sampling points and how to interpolate between them. When used to compute values for an animation channel, the sampling points are the animation key-frames. Sampling points (key-frames) are input data sources to the sampler. Animation channels direct the output data values of the sampler to their targets. COLLADA recognizes the following interpolation types: LINEAR, BEZIER, CARDINAL, HERMITE, BSPLINE.

Public Types

typedef daeSmartRef< domInput > domInputRef
typedef daeTArray< domInputRef > domInput_Array

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.
domInput_Array & getInput_array ()
 Gets the input element array.
const domInput_Array & getInput_array () const
 Gets the input 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the sampler element.
xsNCName attrName
 The name attribute is the text string name of this element.
domInput_Array elemInput_array
 The input element must appear one or more times.

Classes

class  domInput
 The input element must appear one or more times. More...

Member Function Documentation

daeElementRef domSampler::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.

xsID domSampler::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

const domInput_Array& domSampler::getInput_array (   )  const [inline]
 

Gets the input element array.

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

domInput_Array& domSampler::getInput_array (   )  [inline]
 

Gets the input element array.

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

xsNCName domSampler::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

daeMetaElement * domSampler::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 domSampler::setId (  xsID  atId  )  [inline]
 

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domSampler::attrId [protected]
 

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

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

xsNCName domSampler::attrName [protected]
 

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

Optional attribute.

domInput_Array domSampler::elemInput_array [protected]
 

The input element must appear one or more times.

Sampling points are described by the input elements that refer to source elements. The semantic attribute of the input element can be one of: INPUT, INTERPOLATION, IN_TANGENT, OUT_TANGENT, and OUTPUT.

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

previous page start next page