CIP C++ documentation for class "pfcTransform3D"

Class pfcTransform3D

# include <pfcBase.h> class pfcTransform3D : public virtual xobject { xdeclare(pfcTransform3D) ... }; This is a COMPACT class.

Description

This class provides information about a coordinate system transformation.

Manual References:: Geometry Evaluation: Evaluation of ModelItems

Method Summary


`static pfcTransform3D_ptr`	`Create (optional pfcMatrix3D_ptr Matrix)`
	Creates a Transform3D object.

`pfcMatrix3D_ptr`	`GetMatrix ()`
`void`	`SetMatrix (pfcMatrix3D_ptr value)`
	The transformation matrix

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

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

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

`pfcVector3D_ptr`	`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_ptr Input)`
	This method specifies the point that represents the origin of the coordinate system.

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

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

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

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

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

Method Detail

`pfcMatrix3D_ptr`	`GetMatrix`	`()`
`void`	`SetMatrix`	`(pfcMatrix3D_ptr value)`

The transformation matrix

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

Manual References:: Windows and Views: Transformations, Windows and Views: Transformations

pfcVector3D_ptr GetXAxis ()

Retrieves the vector that represents the X-axis.

Manual References:: Windows and Views: Transformations

Returns:: The X-axis

void SetXAxis (pfcVector3D_ptr Input)

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

Parameters:

Input: The X-axis

Returns:

pfcVector3D_ptr GetYAxis ()

Retrieves the vector that represents the Y-axis.

Manual References:: Windows and Views: Transformations

Returns:: The Y-axis

void SetYAxis (pfcVector3D_ptr Input)

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

Parameters:

Input: The Y-axis

Returns:

pfcVector3D_ptr GetZAxis ()

Retrieves the vector that represents the Z-axis.

Manual References:: Windows and Views: Transformations

Returns:: The Z-axis

void SetZAxis (pfcVector3D_ptr Input)

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

Parameters:

Input: The Z-axis

Returns:

pfcPoint3D_ptr GetOrigin ()

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

Manual References:: Windows and Views: Transformations

Returns:: The origin

void SetOrigin (pfcPoint3D_ptr Input)

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

Manual References:: Drawings: Creating Drawing Views

Parameters:

Input: The three-dimensional point that represents the origin

Returns:

pfcVector3D_ptr TransformVector (pfcVector3D_ptr Input)

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

Manual References:: Windows and Views: Transformations, Windows and Views: Transformations

Parameters:

Input: The vector to transform

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

pfcPoint3D_ptr TransformPoint (pfcPoint3D_ptr Input)

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

Manual References:: Windows and Views: Transformations, Windows and Views: Transformations

Parameters:

Input: The point to transform

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

void Invert ()

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

Manual References:: Windows and Views: Transformations, Windows and Views: Transformations, Windows and Views: Transformations

Returns:

static pfcTransform3D_ptr Create (optional pfcMatrix3D_ptr Matrix)

Creates a Transform3D object.

Parameters:

Matrix: The transformation matrix

Returns:: The new Transform3D