API Documentation > Classes > Interface IpfcViewOwner
Interface IpfcViewOwner
Description
This is a base class for an object that has views associated with it (such as model).
Direct Parent Classes:
Direct Known Subclasses:
User Guide References:
Method Summary
Sub
CurrentViewRotate (Axis as IpfcCoordAxis, Angle as Double)
Rotate the object in current view with respect to X, Y or Z axes.
Function
Returns a view object representing the current orientation of the model.
Function
Retrieves the transformation for a model in the current view. The transformation is from the object's coordinate system to logical screen coordinates.
Function
GetView (Name as String) as IpfcView [optional]
Returns the specified view, given its name.
Function
ListViews () as IpfcViews [optional]
Retrieves the views associated with the object
Function
RetrieveView (Name as String) as IpfcView [optional]
Sets the current view to the orientation previously saved with a specified name.
Function
SaveView (Name as String) as IpfcView
This method saves the view with a specified name.
Sub
Sets the transformation of a model in the current view. This is the transformation between model coordinates and screen coordinates.
Method Detail
Sub
CurrentViewRotate
(Axis as IpfcCoordAxis, Angle as Double)
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
User Guide References:
Function
GetCurrentView
() as IpfcView
Returns a view object representing the current orientation of the model.
This method is deprecated.
Returns:
The current View object.
User Guide References:
Function
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):
IpfcXToolkitInvalidMatrix - The transformation is invalid.
Returns:
The transformation object.
User Guide References:
Function
GetView
(Name as String) as IpfcView [optional]
Returns the specified view, given its name.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - A view was not found for the specified name.
IpfcXToolkitInvalidItem - The specified view is not retrievable; e.g. the model is sheet metal at a certain stage of bending or unbending.
See Also:
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
User Guide References:
Function
ListViews
() as IpfcViews [optional]
Retrieves the views associated with the object
Returns:
The list of views, or null, if there are no views associated with thisobject.
User Guide References:
Function
RetrieveView
(Name as String) as IpfcView [optional]
Sets the current view to the orientation previously saved with a specified name.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - 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.
User Guide References:
Function
SaveView
(Name as String) as IpfcView
This method saves the view with a specified name.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - No view names were found for the specified model.
Parameters:
Name
The name used to store the view.
Returns:
The saved view.
User Guide References:
Sub
SetCurrentViewTransform
(TrForm as IpfcTransform3D)
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):
IpfcXToolkitInvalidMatrix - The transformation is invalid.
Parameters:
TrForm
The transformation object.
User Guide References:
Was this helpful?