COLLADA 1.4 DOM: domSkin Class Reference

COLLADA

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

domSkin Class Reference

#include <domSkin.h>

Inheritance diagram for domSkin:

Inheritance graph
[legend]
Collaboration diagram for domSkin:

Collaboration graph
[legend]
List of all members.

Detailed Description

The skin element contains vertex and primitive information sufficient to describe blend-weight skinning.

The skinning information is stored outside of the affected geometry, under the skin element. This decoupling allows skeletons to 'skin' multiple geometries and different instances of a geometry element to be modified by different skeletons. * Bind-shape: represented with a source, the same way as mesh vertex positions. * Influences / joints: a combiner represents the variable-length influence lists for each vertex. * Bind-pose: to avoid inverting matrices on import, COLLADA stores the inverse of the bind-matrices. The matrices are per-node (they are the same for each vertex that is influenced by a certain node). This is represented by two matching arrays (one for the nodes and one for the matrices) and combined by the joints element. Note that any node can be an influence, not only joints. The name of the joints element was chosen for familiarity reasons. There must be a one-to-one correspondence between the vertices in skin and the mesh vertices. Naturally, if a mesh is exported in its bind-shape (the skeleton was not moved after binding), the bindshape positions in the skin will be the same as the vertex positions under the targeted mesh. Also, the skeleton's transforms will result in matrices that, after inverting, will match the inverse-bind matrices in the skin.

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_Array & getSource_array ()
 Gets the source element array.
const domSource_Array & getSource_array () const
 Gets the source element array.
const domVerticesRef getVertices () const
 Gets the vertices 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

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

Protected Attributes

xsID attrId
 The id attribute is a text string containing the unique identifier of the skin element.
xsNCName attrName
 The name attribute is the text string name of this element.
domSource_Array elemSource_array
 The source element must occur one or more times.
domVerticesRef elemVertices
 The vertices element must occur exactly one time.

Member Function Documentation

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

Gets the id attribute.

Returns:
Returns a xsID of the id attribute.

xsNCName domSkin::getName (   )  const [inline]
 

Gets the name attribute.

Returns:
Returns a xsNCName of the name attribute.

const domSource_Array& domSkin::getSource_array (   )  const [inline]
 

Gets the source element array.

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

domSource_Array& domSkin::getSource_array (   )  [inline]
 

Gets the source element array.

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

const domVerticesRef domSkin::getVertices (   )  const [inline]
 

Gets the vertices element.

Returns:
a daeSmartRef to the vertices element.

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

Sets the id attribute.

Parameters:
atId The new value for the id attribute.

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

Sets the name attribute.

Parameters:
atName The new value for the name attribute.

Member Data Documentation

xsID domSkin::attrId [protected]
 

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

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

xsNCName domSkin::attrName [protected]
 

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

Optional attribute.

domSource_Array domSkin::elemSource_array [protected]
 

The source element must occur one or more times.

The source elements provide the bulk of the skin's vertex data.

See also:
domSource

domVerticesRef domSkin::elemVertices [protected]
 

The vertices element must occur exactly one time.

The vertices element describes the skin vertices that are formed from the vertex data.

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

previous page start next page