Gets the load data and places it into return arguments and returns 0 for success or an error.
Role: Modifies dpt, ipt, base_pt, gain.
Looks for a spring load in the entire patch hierarchy. When the tag specifies a
spring load, this function fills all the output arguments appropriately and
returns 0. Changes the active deformable model to the one containing the load.
Else returns DM_TAG_OBJECT_NOT_FOUND and leaves output arguments unmodified.
When domain_flag is set to 1, dpt is given in the unit range and mapped to the
pfunc's actual domain range by this function. When domain_flag is set to 0, dpt
is given in the dmod's original domain range. When domain_flag is set to 2, dpt
is given in the dmod's pfunc's internal domain range.
Errors:
DM_NULL_INPUT_PTR
The deformable model cannot be NULL on entry.
DM_NULL_OUTPUT_PTR
The domain point and the image point are 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.
Effect: Changes model
Parameters:
rtn_err
out: 0=success or negative err code.
dmod
in: member of target dmod hierarchy to search.
tag
in: load identifier.
domain_flag
in: 0=domain_pts in orig_dmod_space, 1=dpt in unit_space. 2=dpt in internal_pfunc_space.
dpt
out: domain_pt loc of surf spring end sized:[Domain_dim].
free_pt
out: image_pt loc of free spring end sized:[image_dim].
base_pt
out: image_pt loc of attached spring end sized:[image_dim].
gain
out: magnitude of load gain.
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.