SAA_ctrlVertexGetEnvelopeWeights
[ Home ] [ Sales ] [ Products ] [ Services ] [ Support ] [ Downloads ]

SAA_ctrlVertexGetEnvelopeWeights

SAA_ctrlVertexSetEnvelopeWeights

Sets and retrieves the weight values of envelope control vertices.

Each control vertex in an envelope is weighted relative to the different elements (joints) in a skeleton. For example, a control vertex assigned to a single joint has a weight value of 100% relative to that joint. A control vertex assigned to two joints may have relative weights of 40% and 60%, 50% and 50%, or any other combination of weight values that adds up to 100%.

set scn [SAA_AllocScene]

set el_skl [SAA_AllocElem]

set el_env [SAA_AllocElem]

set ctrlVertices [ SAA_AllocSubElem $nbCtrlVertices]

.

.

.


set weights [SAA_AllocFloat $nbCtrlVertices]

SAA_ctrlVertexGetEnvelopeWeights  $scn $el_skl $el_env $nbCtrlVertices $ctrlVertices $weights 

SAA_ctrlVertexSetEnvelopeWeights $scn $el_skl $el_env $nbCtrlVertices $ctrlVertices $weights 

el_skl

An element in a skeleton hierarchy.

el_env

Envelope whose control vertex weight values are set and retrieved.

nbCtrlVertices

Number of control vertices in the ctrlVertices[] array. To get the number of control vertices assigned to an envelope, use SAA_envelopeGetNbCtrlVertices.

ctrlVertices

Array of control vertices. To get the control vertices assigned to an envelope, use SAA_envelopeGetCtrlVertices.

weights

An array containing the weights assigned to each vertex in ctrlVertices[] for the skeleton element el_skl.

When retrieving weight values, the calling function is responsible for allocating this array. The required size is given by nbCtrlVertices.

Return Value

Return correct usage if incorrect parameters are passed
"SI_ERR_INVALID_SELEM" if one or more (but not all) control vertices caused an error. Use SAA_subelementGetError to determine which control vertices caused the errors.

"SI_ERR_SUBELEM_TOTAL_FAILURE" if every control vertex caused an error.

[ SAA Index ] [ Examples SAA calls index ]

copyright Video-Collage Inc.