alignFrames Method

Summary

Finds the closest match to

frameToAlign** from the cell
cell**.

Syntax

JavaScript Syntax

alignFrames = function( 
   frameToAlign, 
   referencePoint1, 
   cell, 
   referencePoint2 
)

TypeScript Syntax

static alignFrames( 
   frameToAlign: Frame, 
   referencePoint1: LeadPoint3D, 
   cell: Cell, 
   referencePoint2: LeadPoint3D 
): number;

frameToAlign

The reference frame.

referencePoint1

The source point.

cell

The cell that contains the frames on which to search for a closest match to frameToAlign.

referencePoint2

The destination point.

Value that represents the index of the closest match frame in cell to frameToAlign.

Remarks

The closest match is based on the frames position and orientation of the frame.

If no match was found, due to extreme difference in orientation, then this method will return -1.

Requirements

Help Version 19.0.2017.10.27

Leadtools.Controls.Medical Assembly