COLLADA 1.4 DOM: domCombiner Class Reference

COLLADA

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

domCombiner Class Reference

#include <domCombiner.h>

Inheritance diagram for domCombiner:

Inheritance graph
[legend]
Collaboration diagram for domCombiner:

Collaboration graph
[legend]
List of all members.

Detailed Description

The combiner element declares the aggregation of input streams.

The combiner element aggregates input data streams into arrays of data structures. The resulting data structures provide a logical organization of the input streams for higher-level elements. A combiner element contains a sequence of v elements, where 'v' stands for value. Each v element describes the values for an arbitrary number of data structures. Each v element contains indices that reference into the input elements. These indices are position dependent and reference the accessor elements according to the order of the input elements. Here is an example of this: The first index references the first unique input element; the second index references the second unique input element, and so on. This is a simple form of compression that reduces the number of indices required in each v element. The input elements are uniquely identified by their idx attribute values. A complete sampling of an aggregate value is completed by gathering one value from each input using the associated index in the v element.

Public Types

typedef daeSmartRef< domV > domVRef
typedef daeTArray< domVRef > domV_Array

Public Member Functions

xsNonNegativeInteger getCount () const
 Gets the count attribute.
void setCount (xsNonNegativeInteger atCount)
 Sets the count attribute.
domInput_Array & getInput_array ()
 Gets the input element array.
const domInput_Array & getInput_array () const
 Gets the input element array.
domV_Array & getV_array ()
 Gets the v element array.
const domV_Array & getV_array () const
 Gets the v 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

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

Protected Attributes

xsNonNegativeInteger attrCount
 The count attribute indicates the number of value elements.
domInput_Array elemInput_array
 The input element must occur two or more times.
domV_Array elemV_array
 Variable length value element.

Classes

class  domV
 Variable length value element. More...

Member Function Documentation

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

xsNonNegativeInteger domCombiner::getCount (   )  const [inline]
 

Gets the count attribute.

Returns:
Returns a xsNonNegativeInteger of the count attribute.

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

Gets the input element array.

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

domInput_Array& domCombiner::getInput_array (   )  [inline]
 

Gets the input element array.

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

const domV_Array& domCombiner::getV_array (   )  const [inline]
 

Gets the v element array.

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

domV_Array& domCombiner::getV_array (   )  [inline]
 

Gets the v element array.

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

daeMetaElement * domCombiner::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 domCombiner::setCount (  xsNonNegativeInteger  atCount  )  [inline]
 

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

Member Data Documentation

xsNonNegativeInteger domCombiner::attrCount [protected]
 

The count attribute indicates the number of value elements.

Required attribute.

domInput_Array domCombiner::elemInput_array [protected]
 

The input element must occur two or more times.

There must be at least two things to combine.

See also:
domInput

domV_Array domCombiner::elemV_array [protected]
 

Variable length value element.

The indices form the source's output aggregated by the number of inputs. The v element must occur one or more times.

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

previous page start next page