|
Action:
|
Gets the vector load data and places it into return arguments. returns 0 for success or an error.
|
|
|
Prototype:
|
void DM_get_vector_load (
|
|
|
int& rtn_err,
|
// out: 0=success
|
|
|
|
|
// or negative err code
|
|
|
DS_dmod* dmod,
|
// in: member of target
|
|
|
|
|
// dmod hierarchy to
|
|
|
|
|
// search
|
|
|
int tag,
|
// in: load identifier
|
|
|
double* image_vec,
|
// out: image_vec for
|
|
|
|
|
// vector_load direction
|
|
|
|
|
// sized:[image_dim]
|
|
|
double& gain,
|
// out: magnitude of
|
|
|
|
|
// load gain
|
|
|
SDM_options* sdmo
|
// in:SDM_options pointer
|
|
|
|
= NULL
|
// note: sets active dmod
|
|
|
);
|
|
|
Includes:
|
#include "kernel/acis.hxx"
|
|
#include "dshusk/dskernel/dmapi.hxx"
|
|
#include "dshusk/dskernel/dsdmod.hxx"
|
|
#include "dshusk/dskernel/sdm_options.hxx"
|
|
|
Description:
|
Modifies
image_vec, and
gain.
|
|
|
Looks for a vector load identified by tag in the entire patch hierarchy. When the tag specifies a
DS_vector_load, fills all the output arguments appropriately and returns 0. Changes the active deformable model to the one containing the load. Otherwise, returns the error
DM_TAG_OBJECT_NOT_FOUND and leaves output arguments unmodified.
|
|
|
Errors:
|
DM_NULL_INPUT_PTR
|
|
The deformable model cannot be
NULL on entry.
|
|
|
|
DM_NULL_OUTPUT_PTR
|
|
The image vector is
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.
|
|
|
Library:
|
dshusk
|
|
|
Filename:
|
ds/dshusk/dskernel/dmapi.hxx
|
|
|
Effect:
|
Changes model
|