FLDget_xform


Synopsis

get/set the transformation matrix (xform) associated with a Field


int FLDget_xform (
OMobj_id field,
float *xform);

int FLDset_xform (
OMobj_id field,
float *xform);

Description

These routines get/set the transformation matrix (DefaultXform xform) associated with a field.

You use this routine whenever it is important to establish the orientation of the field in space. Thus, it is generally used in modules that use probing objects to sample a field (for both the probe and the field), or in orthoslice where it is important that the output 2D slice is oriented along the X, Y, or Z axis that was extracted.

Parameters

OMobj_id field

The OMobj_id of a field containing an xform.

float *xform

In FLDget_xform, xform is the address of a float array, sized [4][4] or [16], in which the transformation matrix is returned.

In FLDset_xform, xform is the address of a float array from which the transformation matrix is copied.

Example

modules/orthoslc.c
modules/glyph.c
modules/pln_crop.c (and others)

Related routines

Not applicable.