COLLADA 1.4 DOM: domExtra Class Reference

COLLADA

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

domExtra Class Reference

#include <domExtra.h>

Inheritance diagram for domExtra:

Inheritance graph
[legend]
Collaboration diagram for domExtra:

Collaboration graph
[legend]
List of all members.

Detailed Description

The extra element declares additional information regarding its parent element.

An extensible schema requires a means for users to specify arbitrary information. This extra information can represent additional real data or semantic (meta) data to the application. COLLADA represents extra information as techniques containing an arbitrary number of param elements.

Public Types

typedef daeSmartRef< domTechnique > domTechniqueRef
typedef daeTArray< domTechniqueRef > domTechnique_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.
xsNMTOKEN getType () const
 Gets the type attribute.
void setType (xsNMTOKEN atType)
 Sets the type attribute.
domTechnique_Array & getTechnique_array ()
 Gets the technique element array.
const domTechnique_Array & getTechnique_array () const
 Gets the technique 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the extra element.
xsNCName attrName
 The name attribute is the text string name of this element.
xsNMTOKEN attrType
 The type attribute indicates the type of the value data.
domTechnique_Array elemTechnique_array
 The technique element may occur zero or more times.

Classes

class  domTechnique
 The technique element may occur zero or more times. More...

Member Function Documentation

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

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domExtra::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domTechnique_Array& domExtra::getTechnique_array (   )  const [inline]
 

Gets the technique element array.

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

domTechnique_Array& domExtra::getTechnique_array (   )  [inline]
 

Gets the technique element array.

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

xsNMTOKEN domExtra::getType (   )  const [inline]
 

Gets the type attribute.

Returns:
Returns a xsNMTOKEN of the type attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domExtra::setType (  xsNMTOKEN  atType  )  [inline]
 

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

Member Data Documentation

xsID domExtra::attrId [protected]
 

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

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

xsNCName domExtra::attrName [protected]
 

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

Optional attribute.

xsNMTOKEN domExtra::attrType [protected]
 

The type attribute indicates the type of the value data.

This text string must be understood by the application. Optional attribute.

domTechnique_Array domExtra::elemTechnique_array [protected]
 

The technique element may occur zero or more times.

The extra element restricts the permissible child elements of the technique element to the asset and param elements.

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

previous page start next page