CIP JavaScript documentation for class " pfcViewOwner"

Class pfcViewOwner

Description

This is a base class for an object that has views associated with it (such as model).

Direct Parent Classes:: pfcParent

Direct Known Subclasses:: pfcModel

Method Summary


`void`	`CurrentViewRotate (pfcCoordAxis Axis, number Angle)`
	Rotate the object in current view with respect to X, Y or Z axes.

`pfcView`	`GetCurrentView ()`
	Returns a view object representing the current orientation of the model.

`pfcTransform3D`	`GetCurrentViewTransform ()`
	Retrieves the transformation for a model in the current view. The transformation is from the object's coordinate system to logical screen coordinates.

`/* optional */ pfcView`	`GetView (string Name)`
	Returns the specified view, given its name.

`/* optional */ pfcViews`	`ListViews ()`
	Retrieves the views associated with the object

`/* optional */ pfcView`	`RetrieveView (string Name)`
	Sets the current view to the orientation previously saved with a specified name.

`pfcView`	`SaveView (string Name)`
	This method saves the view with a specified name.

`void`	`SetCurrentViewTransform (pfcTransform3D TrForm)`
	Sets the transformation of a model in the current view. This is the transformation between model coordinates and screen coordinates.

Method Detail

void CurrentViewRotate (pfcCoordAxis Axis, number Angle)

Rotate the object in current view with respect to X, Y or Z axes.

Parameters:

Axis: The rotation axis
Angle: The rotation angle, in degrees

pfcView GetCurrentView ()

Returns a view object representing the current orientation of the model.

This method is deprecated.

Returns:: The current View object.

pfcTransform3D GetCurrentViewTransform ()

Retrieves the transformation for a model in the current view. The transformation is from the object's coordinate system to logical screen coordinates.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix - The transformation is invalid.

Returns:: The transformation object.

/* optional */ pfcView GetView (string Name)

Returns the specified view, given its name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - A view was not found for the specified name.

pfcXToolkitInvalidItem - The specified view is not retrievable; e.g. the model is sheet metal at a certain stage of bending or unbending.

See Also:: pfcViewOwner.RetrieveView()

Parameters:

Name: The name of the view to get

Returns:: The named view, or null, if a view with the specified name has not been found

/* optional */ pfcViews ListViews ()

Retrieves the views associated with the object

Returns:: The list of views, or null, if there are no views associated with thisobject.

/* optional */ pfcView RetrieveView (string Name)

Sets the current view to the orientation previously saved with a specified name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The function was unable to retrieve a view with the specified name.

Parameters:

Name: The name of the view to retrieve

Returns:: The retrieved view or null, if a view with the specified name has not been found.

pfcView SaveView (string Name)

This method saves the view with a specified name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No view names were found for the specified model.

Parameters:

Name: The name used to store the view.

Returns:: The saved view.

void SetCurrentViewTransform (pfcTransform3D TrForm)

Sets the transformation of a model in the current view. This is the transformation between model coordinates and screen coordinates.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidMatrix - The transformation is invalid.

Parameters:

TrForm: The transformation object.