COLLADA 1.4 DOM: domAccessor Class Reference

COLLADA

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

domAccessor Class Reference

#include <domAccessor.h>

Inheritance diagram for domAccessor:

Inheritance graph
[legend]
Collaboration diagram for domAccessor:

Collaboration graph
[legend]
List of all members.

Detailed Description

The accessor element declares an access pattern to one of the array elements: float_array, int_array, Name_array, bool_array, and the generic array element.

The accessor element describes access to arrays that are organized in either an interleaved or noninterleaved manner according to the permutations of the offset and stride attributes.

Public Member Functions

xsID getId () const
 Gets the id attribute.
void setId (xsID atId)
 Sets the id attribute.
xsNonNegativeInteger getCount () const
 Gets the count attribute.
void setCount (xsNonNegativeInteger atCount)
 Sets the count attribute.
xsNonNegativeInteger getOffset () const
 Gets the offset attribute.
void setOffset (xsNonNegativeInteger atOffset)
 Sets the offset attribute.
xsAnyURI & getSource ()
 Gets the source attribute.
const xsAnyURI & getSource () const
 Gets the source attribute.
void setSource (const xsAnyURI &atSource)
 Sets the source attribute.
xsNonNegativeInteger getStride () const
 Gets the stride attribute.
void setStride (xsNonNegativeInteger atStride)
 Sets the stride attribute.
domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the accessor element.
xsNonNegativeInteger attrCount
 The count attribute indicates the number of times the array is accessed.
xsNonNegativeInteger attrOffset
 The offset attribute indicates the index of the first value in the array that is accessed.
xsAnyURI attrSource
 The source attribute indicates the location of the array to access using a URL expression.
xsNonNegativeInteger attrStride
 The stride attribute indicates the number of values to access per count iteration according to the type of data in the source array.
domParam_Array elemParam_array
 The param element describes the output of the accessor element sufficiently to bind that output to consumers of the data stream.

Member Function Documentation

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

Gets the count attribute.

Returns:
Returns a xsNonNegativeInteger of the count attribute.

xsID domAccessor::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNonNegativeInteger domAccessor::getOffset (   )  const [inline]
 

Gets the offset attribute.

Returns:
Returns a xsNonNegativeInteger of the offset attribute.

const domParam_Array& domAccessor::getParam_array (   )  const [inline]
 

Gets the param element array.

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

domParam_Array& domAccessor::getParam_array (   )  [inline]
 

Gets the param element array.

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

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

Gets the source attribute.

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

xsAnyURI& domAccessor::getSource (   )  [inline]
 

Gets the source attribute.

Returns:
Returns a xsAnyURI reference of the source attribute.

xsNonNegativeInteger domAccessor::getStride (   )  const [inline]
 

Gets the stride attribute.

Returns:
Returns a xsNonNegativeInteger of the stride attribute.

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

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

void domAccessor::setOffset (  xsNonNegativeInteger  atOffset  )  [inline]
 

Sets the offset attribute.

Parameters:
atOffset The new value for the offset attribute.

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

Sets the source attribute.

Parameters:
atSource The new value for the source attribute.

void domAccessor::setStride (  xsNonNegativeInteger  atStride  )  [inline]
 

Sets the stride attribute.

Parameters:
atStride The new value for the stride attribute.

Member Data Documentation

xsNonNegativeInteger domAccessor::attrCount [protected]
 

The count attribute indicates the number of times the array is accessed.

Required attribute.

xsID domAccessor::attrId [protected]
 

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

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

xsNonNegativeInteger domAccessor::attrOffset [protected]
 

The offset attribute indicates the index of the first value in the array that is accessed.

The default value is 0. Optional attribute.

xsAnyURI domAccessor::attrSource [protected]
 

The source attribute indicates the location of the array to access using a URL expression.

Required attribute.

xsNonNegativeInteger domAccessor::attrStride [protected]
 

The stride attribute indicates the number of values to access per count iteration according to the type of data in the source array.

The default value is 1, indicating that a single value is accessed. Optional attribute. The stride attribute must have a value equal to or greater then the number of param elements. If there are fewer param elements then indicated by the stride value, the unbound array data source values are skipped.

domParam_Array domAccessor::elemParam_array [protected]
 

The param element describes the output of the accessor element sufficiently to bind that output to consumers of the data stream.

The param element may occur zero or more times. The number and order of param elements define the output of the accessor element. Parameters are bound to values in the order they are specified. Parameter ordering is irrelevant to the array data source of the accessor element. This means that no swizzling of the data occurs. The type attribute of the param element, when it is a child of the accessor element, is restricted to the set of array types: int, float, Name, bool, and token. A param element without a name attribute is unbound. This is an indication that the value is not passed to the consumer.

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

previous page start next page