CIP JavaScript documentation for class " pfcTransform3D"

Class pfcTransform3D

Description

This class provides information about a coordinate system transformation.

Property Summary


`pfcMatrix3D`	`Matrix`
	The transformation matrix

Method Summary


`static pfcTransform3D`	`Create ( /* optional */ pfcMatrix3D Matrix)`
	Creates a Transform3D object.

`pfcPoint3D`	`GetOrigin ()`
	Retrieves the point that represents the origin of the coordinate system.

`pfcVector3D`	`GetXAxis ()`
	Retrieves the vector that represents the X-axis.

`pfcVector3D`	`GetYAxis ()`
	Retrieves the vector that represents the Y-axis.

`pfcVector3D`	`GetZAxis ()`
	Retrieves the vector that represents the Z-axis.

`void`	`Invert ()`
	Inverts the 4 x 4 matrix contained in the transform object.

`void`	`SetOrigin (pfcPoint3D Input)`
	This method specifies the point that represents the origin of the coordinate system.

`void`	`SetXAxis (pfcVector3D Input)`
	This method returns a vector that representing the X-axis of the coordinate system.

`void`	`SetYAxis (pfcVector3D Input)`
	This method specifies a vector that represents the Y-axis of the coordinate system.

`void`	`SetZAxis (pfcVector3D Input)`
	Specifies the vector that represents the Z-axis of the coordinate system.

`pfcPoint3D`	`TransformPoint (pfcPoint3D Input)`
	Transforms the specified point using the transformation matrix (both shift and rotation).

`pfcVector3D`	`TransformVector (pfcVector3D Input)`
	Transforms the specified vector by the given transformation matrix (rotation only).

Property Detail

pfcMatrix3D Matrix

The transformation matrix

See Also:: <reference 4 to unknown entity wfcSession::CreateMatrix3D (Object Toolkit only).>

Method Detail

static pfcTransform3D Create ( /* optional */ pfcMatrix3D Matrix)

Creates a Transform3D object.

Parameters:

Matrix: The transformation matrix

Returns:: The new Transform3D

pfcPoint3D GetOrigin ()

Retrieves the point that represents the origin of the coordinate system.

Returns:: The origin

pfcVector3D GetXAxis ()

Retrieves the vector that represents the X-axis.

Returns:: The X-axis

pfcVector3D GetYAxis ()

Retrieves the vector that represents the Y-axis.

Returns:: The Y-axis

pfcVector3D GetZAxis ()

Retrieves the vector that represents the Z-axis.

Returns:: The Z-axis

void Invert ()

Inverts the 4 x 4 matrix contained in the transform object.

void SetOrigin (pfcPoint3D Input)

This method specifies the point that represents the origin of the coordinate system.

Parameters:

Input: The three-dimensional point that represents the origin

void SetXAxis (pfcVector3D Input)

This method returns a vector that representing the X-axis of the coordinate system.

Parameters:

Input: The X-axis

void SetYAxis (pfcVector3D Input)

This method specifies a vector that represents the Y-axis of the coordinate system.

Parameters:

Input: The Y-axis

void SetZAxis (pfcVector3D Input)

Specifies the vector that represents the Z-axis of the coordinate system.

Parameters:

Input: The Z-axis

pfcPoint3D TransformPoint (pfcPoint3D Input)

Transforms the specified point using the transformation matrix (both shift and rotation).

Parameters:

Input: The point to transform

Returns:: The resulting point. Note that this can be the same as theInput point.

pfcVector3D TransformVector (pfcVector3D Input)

Transforms the specified vector by the given transformation matrix (rotation only).

Parameters:

Input: The vector to transform

Returns:: The resulting vector. Note that this can be the same as theInput vector.