COLLADA 1.4 DOM: domShader Class Reference

COLLADA

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

domShader Class Reference

#include <domShader.h>

Inheritance diagram for domShader:

Inheritance graph
[legend]
Collaboration diagram for domShader:

Collaboration graph
[legend]
List of all members.

Detailed Description

Shaders describe the process of rendering the appearance of a geometric object.

The shader element declares the rendering techniques used to produce the appearance of a material. The shader element contains declarations of parameters and techniques.

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.
domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param element array.
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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the shader element.
xsNCName attrName
 The name attribute is the text string name of this element.
domParam_Array elemParam_array
 The param element may occur zero or more times.
domTechnique_Array elemTechnique_array
 Each technique element specified corresponds to a (platform) profile.

Classes

class  domTechnique
 Each technique element specified corresponds to a (platform) profile. More...

Member Function Documentation

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

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domShader::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

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

Gets the param element array.

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

domParam_Array& domShader::getParam_array (   )  [inline]
 

Gets the param element array.

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

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

Gets the technique element array.

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

domTechnique_Array& domShader::getTechnique_array (   )  [inline]
 

Gets the technique element array.

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

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domShader::attrId [protected]
 

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

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

xsNCName domShader::attrName [protected]
 

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

Optional attribute.

domParam_Array domShader::elemParam_array [protected]
 

The param element may occur zero or more times.

A param element specified as a child of the shader element is in the scope of all the shader's techniques. This implies that the parameter is invariant across all the techniques as well.

See also:
domParam

domTechnique_Array domShader::elemTechnique_array [protected]
 

Each technique element specified corresponds to a (platform) profile.

This implies that the set of techniques are mutually exclusive. However, an application may choose to apply information from multiple techniques. The technique element must occur one or more times.

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

previous page start next page