COLLADA 1.4 DOM: domPass Class Reference

COLLADA

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

domPass Class Reference

#include <domPass.h>

Inheritance diagram for domPass:

Inheritance graph
[legend]
Collaboration diagram for domPass:

Collaboration graph
[legend]
List of all members.

Detailed Description

A pass describes an algorithm that is executed during a single iteration of the rendering engine.

The pass element declares the information required to execute a rendering pass.

Public Types

typedef daeSmartRef< domInput > domInputRef
typedef daeTArray< domInputRef > domInput_Array

Public Member Functions

domParam_Array & getParam_array ()
 Gets the param element array.
const domParam_Array & getParam_array () const
 Gets the param element array.
domInput_Array & getInput_array ()
 Gets the input element array.
const domInput_Array & getInput_array () const
 Gets the input element array.
const domProgramRef getProgram () const
 Gets the program element.

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

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

Protected Attributes

domParam_Array elemParam_array
 The param element may occur zero or more times.
domInput_Array elemInput_array
 The input element may occur zero or more times.
domProgramRef elemProgram
 The program element may occur zero or one time.

Classes

class  domInput
 The input element may occur zero or more times. More...

Member Function Documentation

daeElementRef domPass::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 domInput_Array& domPass::getInput_array (   )  const [inline]
 

Gets the input element array.

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

domInput_Array& domPass::getInput_array (   )  [inline]
 

Gets the input element array.

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

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

Gets the param element array.

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

domParam_Array& domPass::getParam_array (   )  [inline]
 

Gets the param element array.

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

const domProgramRef domPass::getProgram (   )  const [inline]
 

Gets the program element.

Returns:
a daeSmartRef to the program element.

daeMetaElement * domPass::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.

Member Data Documentation

domInput_Array domPass::elemInput_array [protected]
 

The input element may occur zero or more times.

The input element must not have the idx attribute when it is the child of a pass element.

See also:
domInput

domParam_Array domPass::elemParam_array [protected]
 

The param element may occur zero or more times.

A param element specified as a child of the pass element is in the scope of only that pass.

See also:
domParam

domProgramRef domPass::elemProgram [protected]
 

The program element may occur zero or one time.

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

previous page start next page