COLLADA 1.4 DOM: domMaterial Class Reference

COLLADA

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

domMaterial Class Reference

#include <domMaterial.h>

Inheritance diagram for domMaterial:

Inheritance graph
[legend]
Collaboration diagram for domMaterial:

Collaboration graph
[legend]
List of all members.

Detailed Description

Materials describe the visual appearance of a geometric object.

The material element categorizes the declaration of rendering appearance information. The material element contains declarations of shaders, parameters, techniques, and vertex and pixel programs. A material element is the base container for all rendering and shading information. The visual appearance of a geometric object is described by its material properties.

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.
const domAssetRef getAsset () const
 Gets the asset element.
domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param element array.
domShader_Array & getShader_array ()
 Gets the shader element array.
const domShader_Array & getShader_array () const
 Gets the shader 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the material element.
xsNCName attrName
 The name attribute is the text string name of this element.
domAssetRef elemAsset
 The material element may contain zero or one asset elements.
domParam_Array elemParam_array
 The material element may contain zero or more param elements.
domShader_Array elemShader_array
 The material element must contain one or more shader elements.

Member Function Documentation

daeElementRef domMaterial::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 domAssetRef domMaterial::getAsset (   )  const [inline]
 

Gets the asset element.

Returns:
a daeSmartRef to the asset element.

xsID domMaterial::getId (   )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domMaterial::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

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

Gets the param element array.

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

domParam_Array& domMaterial::getParam_array (   )  [inline]
 

Gets the param element array.

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

const domShader_Array& domMaterial::getShader_array (   )  const [inline]
 

Gets the shader element array.

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

domShader_Array& domMaterial::getShader_array (   )  [inline]
 

Gets the shader element array.

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

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domMaterial::attrId [protected]
 

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

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

xsNCName domMaterial::attrName [protected]
 

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

Optional attribute.

domAssetRef domMaterial::elemAsset [protected]
 

The material element may contain zero or one asset elements.

See also:
domAsset

domParam_Array domMaterial::elemParam_array [protected]
 

The material element may contain zero or more param elements.

See also:
domParam

domShader_Array domMaterial::elemShader_array [protected]
 

The material element must contain one or more shader elements.

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

previous page start next page