COLLADA 1.4 DOM: domPolygons Class Reference

COLLADA

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

domPolygons Class Reference

#include <domPolygons.h>

Inheritance diagram for domPolygons:

Inheritance graph
[legend]
Collaboration diagram for domPolygons:

Collaboration graph
[legend]
List of all members.

Detailed Description

The polygons element declares the binding of geometric primitives and vertex attributes for a mesh element.

The polygons element provides the information needed to bind vertex attributes together and then organize those vertices into individual polygons. (A polygon is a closed plane figure bounded by straight lines or a closed figure on a sphere bounded by arcs of great circles per Merriam-Webster's 10th edition Dictionary). The vertex array information is supplied in distinct attribute arrays of the mesh element that are then indexed by the polygons element. The polygons described can contain arbitrary numbers of vertices. Ideally, they would describe convex shapes, but they may be concave as well. The polygons may also contain holes. The winding order of vertices produced is counter-clockwise and describe the front side of each polygon. If the primitives are assembled without vertex normals then the application may generate per-primitive normals to enable lighting. A polygons element contains a sequence of p elements, where 'p' stands for primitive. Each p element describes the vertex attributes for an individual polygon.

Public Types

typedef daeSmartRef< domP > domPRef
typedef daeTArray< domPRef > domP_Array

Public Member Functions

xsNonNegativeInteger getCount () const
 Gets the count attribute.
void setCount (xsNonNegativeInteger atCount)
 Sets the count attribute.
xsAnyURI & getMaterial ()
 Gets the material attribute.
const xsAnyURI & getMaterial () const
 Gets the material attribute.
void setMaterial (const xsAnyURI &atMaterial)
 Sets the material attribute.
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.
domP_Array & getP_array ()
 Gets the p element array.
const domP_Array & getP_array () const
 Gets the p 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

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

Protected Attributes

xsNonNegativeInteger attrCount
 The count attribute indicates the number of polygon primitives.
xsAnyURI attrMaterial
 The material attribute refers to the name of a material element, using a URL expression, bound to the polygons.
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.
domP_Array elemP_array
 Primitive element.All the indices form a polygon.

Classes

class  domP
 Primitive element.All the indices form a polygon. More...

Member Function Documentation

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

xsNonNegativeInteger domPolygons::getCount (   )  const [inline]
 

Gets the count attribute.

Returns:
Returns a xsNonNegativeInteger of the count attribute.

const domInput_Array& domPolygons::getInput_array (   )  const [inline]
 

Gets the input element array.

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

domInput_Array& domPolygons::getInput_array (   )  [inline]
 

Gets the input element array.

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

const xsAnyURI& domPolygons::getMaterial (   )  const [inline]
 

Gets the material attribute.

Returns:
Returns a constant xsAnyURI reference of the material attribute.

xsAnyURI& domPolygons::getMaterial (   )  [inline]
 

Gets the material attribute.

Returns:
Returns a xsAnyURI reference of the material attribute.

const domP_Array& domPolygons::getP_array (   )  const [inline]
 

Gets the p element array.

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

domP_Array& domPolygons::getP_array (   )  [inline]
 

Gets the p element array.

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

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

Gets the param element array.

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

domParam_Array& domPolygons::getParam_array (   )  [inline]
 

Gets the param element array.

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

daeMetaElement * domPolygons::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 domPolygons::setCount (  xsNonNegativeInteger  atCount  )  [inline]
 

Sets the count attribute.

Parameters:
atCount The new value for the count attribute.

void domPolygons::setMaterial (  const xsAnyURI &  atMaterial  )  [inline]
 

Sets the material attribute.

Parameters:
atMaterial The new value for the material attribute.

Member Data Documentation

xsNonNegativeInteger domPolygons::attrCount [protected]
 

The count attribute indicates the number of polygon primitives.

Required attribute.

xsAnyURI domPolygons::attrMaterial [protected]
 

The material attribute refers to the name of a material element, using a URL expression, bound to the polygons.

If the material attribute is not specified then the lighting and shading results are application defined. Optional attribute.

domInput_Array domPolygons::elemInput_array [protected]
 

The input element may occur zero or more times.

See also:
domInput

domP_Array domPolygons::elemP_array [protected]
 

Primitive element.All the indices form a polygon.

Each p element contains indices that reference into the source elements. These indices are position dependent and reference the contents of the source elements according to the order of the input elements. Here is an example of this: The first index references the first unique input element; the second index references the second unique input element, and so on. This is a simple form of compression that reduces the number of indices required in each p element. The input elements are uniquely identified by their idx attribute values. A complete sampling of a single vertex is completed by gathering one value from each input using the associated index in the p element.

See also:
domP

domParam_Array domPolygons::elemParam_array [protected]
 

The param element may occur zero or more times.

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

previous page start next page