COLLADA 1.4 DOM: domChannel Class Reference

COLLADA

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

domChannel Class Reference

#include <domChannel.h>

Inheritance diagram for domChannel:

Inheritance graph
[legend]
Collaboration diagram for domChannel:

Collaboration graph
[legend]
List of all members.

Detailed Description

The channel element declares an output channel of an animation.

As an animation transforms value over time, those values are directed out to channels. The animation channels describe where to store the transformed values from the animation engine. The channels target the data structures that receive the animated values.

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.
xsAnyURI & getSource ()
 Gets the source attribute.
const xsAnyURI & getSource () const
 Gets the source attribute.
void setSource (const xsAnyURI &atSource)
 Sets the source attribute.
xsToken getTarget () const
 Gets the target attribute.
void setTarget (xsToken atTarget)
 Sets the target attribute.

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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the channel element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsAnyURI attrSource
 The source attribute indicates the location of the sampler using a URL expression.
xsToken attrTarget
 The target attribute indicates the location of the element bound to the output of the sampler.

Member Function Documentation

daeElementRef domChannel::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 domChannel::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domChannel::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const xsAnyURI& domChannel::getSource (   )  const [inline]
 

Gets the source attribute.

Returns:
Returns a constant xsAnyURI reference of the source attribute.

xsAnyURI& domChannel::getSource (   )  [inline]
 

Gets the source attribute.

Returns:
Returns a xsAnyURI reference of the source attribute.

xsToken domChannel::getTarget (   )  const [inline]
 

Gets the target attribute.

Returns:
Returns a xsToken of the target attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domChannel::setSource (  const xsAnyURI &  atSource  )  [inline]
 

Sets the source attribute.

Parameters:
atSource The new value for the source attribute.

void domChannel::setTarget (  xsToken  atTarget  )  [inline]
 

Sets the target attribute.

Parameters:
atTarget The new value for the target attribute.

Member Data Documentation

xsID domChannel::attrId [protected]
 

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

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

xsNCName domChannel::attrName [protected]
 

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

Optional attribute.

xsAnyURI domChannel::attrSource [protected]
 

The source attribute indicates the location of the sampler using a URL expression.

Required attribute.

xsToken domChannel::attrTarget [protected]
 

The target attribute indicates the location of the element bound to the output of the sampler.

This text string is a path-name following a simple syntax described in Address Syntax section of the COLLADA specification. Required attribute.

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

previous page start next page