COLLADA 1.4 DOM: domLibrary Class Reference

COLLADA

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

domLibrary Class Reference

#include <domLibrary.h>

Inheritance diagram for domLibrary:

Inheritance graph
[legend]
Collaboration diagram for domLibrary:

Collaboration graph
[legend]
List of all members.

Detailed Description

The library element declares a module of elements of a single category.

As data sets become larger and more complex they become harder to manipulate within a single container. One approach to manage this complexity is to divide the data into smaller pieces organized by some criteria. These modular pieces can then be stored in separate resources as libraries. The library element can have zero or more child elements that conform to the category of its type attribute. A library whose type attribute is 'MATERIAL' must contain only material elements, for example.

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.
domLibraryType getType () const
 Gets the type attribute.
void setType (domLibraryType atType)
 Sets the type attribute.
domAnimation_Array & getAnimation_array ()
 Gets the animation element array.
const domAnimation_Array & getAnimation_array () const
 Gets the animation element array.
domCamera_Array & getCamera_array ()
 Gets the camera element array.
const domCamera_Array & getCamera_array () const
 Gets the camera element array.
domCode_Array & getCode_array ()
 Gets the code element array.
const domCode_Array & getCode_array () const
 Gets the code element array.
domController_Array & getController_array ()
 Gets the controller element array.
const domController_Array & getController_array () const
 Gets the controller element array.
domGeometry_Array & getGeometry_array ()
 Gets the geometry element array.
const domGeometry_Array & getGeometry_array () const
 Gets the geometry element array.
domImage_Array & getImage_array ()
 Gets the image element array.
const domImage_Array & getImage_array () const
 Gets the image element array.
domLight_Array & getLight_array ()
 Gets the light element array.
const domLight_Array & getLight_array () const
 Gets the light element array.
domMaterial_Array & getMaterial_array ()
 Gets the material element array.
const domMaterial_Array & getMaterial_array () const
 Gets the material element array.
domProgram_Array & getProgram_array ()
 Gets the program element array.
const domProgram_Array & getProgram_array () const
 Gets the program element array.
domTexture_Array & getTexture_array ()
 Gets the texture element array.
const domTexture_Array & getTexture_array () const
 Gets the texture element array.
daeElementRefArray & getContents ()
 Gets the _contents array.
const daeElementRefArray & getContents () const
 Gets the _contents 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the library element.
xsNCName attrName
 The name attribute is the text string name of the element.
domLibraryType attrType
 The type attribute indicates the category of child elements contained.
domAnimation_Array elemAnimation_array
domCamera_Array elemCamera_array
domCode_Array elemCode_array
domController_Array elemController_array
domGeometry_Array elemGeometry_array
domImage_Array elemImage_array
domLight_Array elemLight_array
domMaterial_Array elemMaterial_array
domProgram_Array elemProgram_array
domTexture_Array elemTexture_array
daeElementRefArray _contents
 Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Member Function Documentation

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

const domAnimation_Array& domLibrary::getAnimation_array (   )  const [inline]
 

Gets the animation element array.

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

domAnimation_Array& domLibrary::getAnimation_array (   )  [inline]
 

Gets the animation element array.

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

const domCamera_Array& domLibrary::getCamera_array (   )  const [inline]
 

Gets the camera element array.

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

domCamera_Array& domLibrary::getCamera_array (   )  [inline]
 

Gets the camera element array.

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

const domCode_Array& domLibrary::getCode_array (   )  const [inline]
 

Gets the code element array.

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

domCode_Array& domLibrary::getCode_array (   )  [inline]
 

Gets the code element array.

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

const daeElementRefArray& domLibrary::getContents (   )  const [inline]
 

Gets the _contents array.

Returns:
Returns a constant reference to the _contents element array.

daeElementRefArray& domLibrary::getContents (   )  [inline]
 

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

const domController_Array& domLibrary::getController_array (   )  const [inline]
 

Gets the controller element array.

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

domController_Array& domLibrary::getController_array (   )  [inline]
 

Gets the controller element array.

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

const domGeometry_Array& domLibrary::getGeometry_array (   )  const [inline]
 

Gets the geometry element array.

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

domGeometry_Array& domLibrary::getGeometry_array (   )  [inline]
 

Gets the geometry element array.

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

xsID domLibrary::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

const domImage_Array& domLibrary::getImage_array (   )  const [inline]
 

Gets the image element array.

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

domImage_Array& domLibrary::getImage_array (   )  [inline]
 

Gets the image element array.

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

const domLight_Array& domLibrary::getLight_array (   )  const [inline]
 

Gets the light element array.

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

domLight_Array& domLibrary::getLight_array (   )  [inline]
 

Gets the light element array.

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

const domMaterial_Array& domLibrary::getMaterial_array (   )  const [inline]
 

Gets the material element array.

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

domMaterial_Array& domLibrary::getMaterial_array (   )  [inline]
 

Gets the material element array.

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

xsNCName domLibrary::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domProgram_Array& domLibrary::getProgram_array (   )  const [inline]
 

Gets the program element array.

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

domProgram_Array& domLibrary::getProgram_array (   )  [inline]
 

Gets the program element array.

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

const domTexture_Array& domLibrary::getTexture_array (   )  const [inline]
 

Gets the texture element array.

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

domTexture_Array& domLibrary::getTexture_array (   )  [inline]
 

Gets the texture element array.

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

domLibraryType domLibrary::getType (   )  const [inline]
 

Gets the type attribute.

Returns:
Returns a domLibraryType of the type attribute.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

void domLibrary::setType (  domLibraryType  atType  )  [inline]
 

Sets the type attribute.

Parameters:
atType The new value for the type attribute.

Member Data Documentation

xsID domLibrary::attrId [protected]
 

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

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

xsNCName domLibrary::attrName [protected]
 

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

Optional attribute.

domLibraryType domLibrary::attrType [protected]
 

The type attribute indicates the category of child elements contained.

Required attribute.

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

previous page start next page