All Frameworks  Class Hierarchy  This Framework  Indexes

SPAds Global Function DM_get_cstrn_src_pfuncs


void DM_get_cstrn_src_pfuncs(int& rtn_err,
DS_dmod* dmod,
int tag,
int tgt,
DS_pfunc*& src_W_pfunc,
DS_pfunc*& src_Wn_pfunc,
DS_pfunc*& src_Wnn_pfunc,
SDM_options* sdmo=NULL)
Returns pointers to a curve or link constraint's source DS_pfunc objects,which define the shape of the constraint.

Role: This function returns pointers to the stored source DS_pfunc objects which can be used to specify the shape of a curve or link constraint. These functions are not required when constructing those constraints, in which case the pointers will be set to NULL. Refer to the functions, DM_add_crv_cstrn() and DM_add_link_cstrn(). These pointer values can be modified with the call DM_set_cstrn_src_pfuncs().

The tgt value specifies which set of src_pfunc values to return when the input tag value identifies a link_cstrn; either the src_pfuncs associated with the first or second of the link's DS_dmond objects.

All output values will be set to NULL when calling this function on a point or area constraint.

Errors:
DM_NULL_INPUT_PTR
The deformable model cannot be NULL on entry.
DM_TAG_OBJECT_NOT_FOUND
The input tag cannot identify a deformable model, a load, a spring, a spring set, an attractor object, or a constraint in the model hierarchy.
DM_NOT_A_CRV_LINK_CSTRN
The input tag did not identify a curve or link constraint.
DM_BAD_SRC_DATA_TGT_VALUE
The input tgt value must be 1 or 2.

Effect: Read-only

Parameters:
rtn_err
out: 0=success or neg err code.
dmod
in: member of dmod hierarchy to search.
tag
cstrn identifier.
tgt
for link_cstrns, tgt = 1 or 2.
src_W_pfunc
out: cstrn pos shape, [nested].
src_Wn_pfunc
out: cross tang shape, [nested].
src_Wnn_pfunc
out: curvature shape, [nested].
sdmo
in:SDM_options pointer note: sets active dmod.

This object is included in the file: dmapi.hxx

Copyright (c) 1989-2007 by Spatial Corp. All rights reserved.