CIP JAVA documentation for class "com.ptc.pfc.pfcView.ViewOwner"

Interface ViewOwner

package com.ptc.pfc.pfcView; public interface ViewOwner extends com.ptc.pfc.pfcObject.Parent

Description

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

Direct Known Subclasses:: Model

Method Summary
`void`	`CurrentViewRotate (CoordAxis Axis, double Angle)` Rotate the object in current view with respect to X, Y or Z axes.
`View`	`GetCurrentView ()` Returns a view object representing the current orientation of the model.
`Transform3D`	`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/ View`	`GetView (String Name)` Returns the specified view, given its name.
`/optional/ Views`	`ListViews ()` Retrieves the views associated with the object
`/optional/ View`	`RetrieveView (String Name)` Sets the current view to the orientation previously saved with a specified name.
`View`	`SaveView (String Name)` This method saves the view with a specified name.
`void`	`SetCurrentViewTransform (Transform3D TrForm)` Sets the transformation of a model in the current view. This is the transformation between model coordinates and screen coordinates.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Method Detail

RetrieveView

/*optional*/ View RetrieveView (String Name)

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

Exceptions thrown (but not limited to):

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

Manual References:: Windows and Views: Getting a View Object, Windows and Views: Getting a View Object

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.

GetView

/*optional*/ View GetView (String Name)

Returns the specified view, given its name.

Exceptions thrown (but not limited to):

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

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

See Also:: ViewOwner.RetrieveView(String)

Manual References:: Windows and Views: Getting a View Object, Windows and Views: Getting a View Object

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

SaveView

View SaveView (String Name)

This method saves the view with a specified name.

Exceptions thrown (but not limited to):

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

Manual References:: Windows and Views: View Operations

Parameters:

Name: The name used to store the view.

Returns:: The saved view.

GetCurrentViewTransform

Transform3D 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):

XToolkitInvalidMatrix - The transformation is invalid.

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

Returns:: The transformation object.

SetCurrentViewTransform

void SetCurrentViewTransform (Transform3D 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):

XToolkitInvalidMatrix - The transformation is invalid.

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

Parameters:

TrForm: The transformation object.

Returns:

CurrentViewRotate

void CurrentViewRotate (CoordAxis Axis, double Angle)

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

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

Parameters:

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

Returns:

ListViews

/*optional*/ Views ListViews ()

Retrieves the views associated with the object

Manual References:: Windows and Views: Getting a View Object, Windows and Views: Getting a View Object

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

GetCurrentView

View GetCurrentView ()

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

This method is deprecated.

Manual References:: Windows and Views: Getting a View Object

Returns:: The current View object.