GpiCallSegmentMatrix

This function calls a segment and applies an instance transform to it.

Syntax

GpiCallSegmentMatrix(hps, lSegment, lCount, pmatlfArray, lOptions)

Parameters

hps (HPS) - input

Presentation-space handle.

lSegment (LONG) - input

Identifier of segment to be called.

This must be greater than 0.

The segment must not be a chained segment.

lCount (LONG) - input

Number of elements.

The number of elements of pmatlfArray to be examined, starting from the beginning of the structure. If lCount is less or equal than 9, the remaining elements default to the corresponding elements of the identity matrix. If lCount = 0, the identity matrix is used.

pmatlfArray (PMATRIXLF) - input

Instance transform matrix.

The third, sixth, and ninth elements, when specified, must be 0, 0, and 1, respectively.

lOptions (LONG) - input

Transformation options.

Specify how the transform defined by the pmatlfArray parameter should be used to modify the existing current model transform for the duration of the function. The existing transform is the concatenation, in the current function context, of the instance, segment, and model transforms, from the root segment downwards.

TRANSFORM_REPLACE The previous model transform is discarded and replaced by the specified transform.

TRANSFORM_ADD The specified transform is combined with the existing model transform. The existing transform precedes the new transform. This option is most useful for incremental updates to transforms.

TRANSFORM_PREEMPT The specified transform is combined with the existing model transform. The new transform precedes the existing transform.

lHits (LONG) - returns

Correlation and error indicators.

GPI_OK Successful

GPI_HITS Correlate hits

GPI_ERROR Error