COLLADA 1.4 DOM: domMesh Class Reference

COLLADA

domMesh Class Reference

#include <domMesh.h>

Inheritance diagram for domMesh:

Inheritance graph
[legend]
Collaboration diagram for domMesh:

Collaboration graph
[legend]
List of all members.

Detailed Description

The mesh element contains vertex and primitive information sufficient to describe basic geometric meshes.

Meshes embody a general form of geometric description that primarily includes vertex and primitive information. Vertex information is the set of attributes associated with a point on the surface of the mesh. Each vertex includes data for attributes such as: * Vertex position * Vertex color * Vertex normal * Vertex texture coordinate The mesh also includes a description of how the vertices are organized to form the geometric shape of the mesh. The mesh vertices are collated into geometric primitives such as polygons, triangles, or lines.

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.
domSource_ArraygetSource_array ()
 Gets the source element array.
const domSource_ArraygetSource_array () const
 Gets the source element array.
const domVerticesRef getVertices () const
 Gets the vertices element.
domLines_ArraygetLines_array ()
 Gets the lines element array.
const domLines_ArraygetLines_array () const
 Gets the lines element array.
domLinestrips_ArraygetLinestrips_array ()
 Gets the linestrips element array.
const domLinestrips_ArraygetLinestrips_array () const
 Gets the linestrips element array.
domPolygons_ArraygetPolygons_array ()
 Gets the polygons element array.
const domPolygons_ArraygetPolygons_array () const
 Gets the polygons element array.
domTriangles_ArraygetTriangles_array ()
 Gets the triangles element array.
const domTriangles_ArraygetTriangles_array () const
 Gets the triangles element array.
domTrifans_ArraygetTrifans_array ()
 Gets the trifans element array.
const domTrifans_ArraygetTrifans_array () const
 Gets the trifans element array.
domTristrips_ArraygetTristrips_array ()
 Gets the tristrips element array.
const domTristrips_ArraygetTristrips_array () const
 Gets the tristrips element array.
daeElementRefArraygetContents ()
 Gets the _contents array.
const daeElementRefArraygetContents () 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 daeMetaElementregisterElement ()
 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the mesh element.
xsNCName attrName
 The name attribute is a text string containing the name of the mesh element.
domSource_Array elemSource_array
 The source element must occur one or more times as the first elements of mesh.
domVerticesRef elemVertices
 The vertices element must occur exactly one time.
domLines_Array elemLines_array
 The lines element contains line primitives.
domLinestrips_Array elemLinestrips_array
 The linestrips element contains line-strip primitives.
domPolygons_Array elemPolygons_array
 The polygons element contains polygon primitives.
domTriangles_Array elemTriangles_array
 The triangles element contains triangle primitives.
domTrifans_Array elemTrifans_array
 The trifans element contains triangle-fan primitives.
domTristrips_Array elemTristrips_array
 The tristrips element contains triangle-strip primitives.
daeElementRefArray _contents
 Used to preserve order in elements that do not specify strict sequencing of sub-elements.

Member Function Documentation

daeElementRef domMesh::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 daeElementRefArray& domMesh::getContents  )  const [inline]
 

Gets the _contents array.

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

daeElementRefArray& domMesh::getContents  )  [inline]
 

Gets the _contents array.

Returns:
Returns a reference to the _contents element array.

xsID domMesh::getId  )  const [inline]
 

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

const domLines_Array& domMesh::getLines_array  )  const [inline]
 

Gets the lines element array.

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

domLines_Array& domMesh::getLines_array  )  [inline]
 

Gets the lines element array.

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

const domLinestrips_Array& domMesh::getLinestrips_array  )  const [inline]
 

Gets the linestrips element array.

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

domLinestrips_Array& domMesh::getLinestrips_array  )  [inline]
 

Gets the linestrips element array.

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

xsNCName domMesh::getName  )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domPolygons_Array& domMesh::getPolygons_array  )  const [inline]
 

Gets the polygons element array.

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

domPolygons_Array& domMesh::getPolygons_array  )  [inline]
 

Gets the polygons element array.

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

const domSource_Array& domMesh::getSource_array  )  const [inline]
 

Gets the source element array.

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

domSource_Array& domMesh::getSource_array  )  [inline]
 

Gets the source element array.

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

const domTriangles_Array& domMesh::getTriangles_array  )  const [inline]
 

Gets the triangles element array.

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

domTriangles_Array& domMesh::getTriangles_array  )  [inline]
 

Gets the triangles element array.

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

const domTrifans_Array& domMesh::getTrifans_array  )  const [inline]
 

Gets the trifans element array.

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

domTrifans_Array& domMesh::getTrifans_array  )  [inline]
 

Gets the trifans element array.

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

const domTristrips_Array& domMesh::getTristrips_array  )  const [inline]
 

Gets the tristrips element array.

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

domTristrips_Array& domMesh::getTristrips_array  )  [inline]
 

Gets the tristrips element array.

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

const domVerticesRef domMesh::getVertices  )  const [inline]
 

Gets the vertices element.

Returns:
a daeSmartRef to the vertices element.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

void domMesh::setName xsNCName  atName  )  [inline]
 

Sets the name attribute.

Parameters:
atName The new value for the name attribute.


Member Data Documentation

xsID domMesh::attrId [protected]
 

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

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

xsNCName domMesh::attrName [protected]
 

The name attribute is a text string containing the name of the mesh element.

Optional attribute.

domLines_Array domMesh::elemLines_array [protected]
 

The lines element contains line primitives.

See also:
domLines

domLinestrips_Array domMesh::elemLinestrips_array [protected]
 

The linestrips element contains line-strip primitives.

See also:
domLinestrips

domPolygons_Array domMesh::elemPolygons_array [protected]
 

The polygons element contains polygon primitives.

See also:
domPolygons

domSource_Array domMesh::elemSource_array [protected]
 

The source element must occur one or more times as the first elements of mesh.

The source element may also occur 0 or more times after the vertices element but before the primitive elements. The source elements provide the bulk of the mesh's vertex data.

See also:
domSource

domTriangles_Array domMesh::elemTriangles_array [protected]
 

The triangles element contains triangle primitives.

See also:
domTriangles

domTrifans_Array domMesh::elemTrifans_array [protected]
 

The trifans element contains triangle-fan primitives.

See also:
domTrifans

domTristrips_Array domMesh::elemTristrips_array [protected]
 

The tristrips element contains triangle-strip primitives.

See also:
domTristrips

domVerticesRef domMesh::elemVertices [protected]
 

The vertices element must occur exactly one time.

The vertices element describes the meshvertex attributes and establishes their topological identity.

See also:
domVertices


The documentation for this class was generated from the following files:
  • C:/SVN_wf/COLLADA_DOM/include/1.3/dom/domMesh.h
  • C:/SVN_wf/COLLADA_DOM/src/1.3/dom/domMesh.cpp

©2005 Sony Computer Entertainment Inc.. All Rights Reserved.
Generated on Fri Feb 10 16:49:07 2006 for COLLADA 1.4 DOM by doxygen 1.4.3