Library | File

Class pfcViewOwner

# include <pfcView.h>

class pfcViewOwner
 : public virtual pfcParent
{
    xaideclare(pfcViewOwner)
    ...
};



Description

This is a base class for an object that has views associated with it (such as model).
Manual References:
Windows and Views: Getting a View Object
Direct Known Subclasses:
pfcModel



Method Summary

voidCurrentViewRotate (pfcCoordAxis Axis, xreal Angle)
Rotate the object in current view with respect to X, Y or Z axes.
pfcView_ptrGetCurrentView ()
Returns a view object representing the current orientation of the model.
pfcTransform3D_ptrGetCurrentViewTransform ()
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_ptrGetView (xrstring Name)
Returns the specified view, given its name.
optional pfcViews_ptrListViews ()
Retrieves the views associated with the object
optional pfcView_ptrRetrieveView (xrstring Name)
Sets the current view to the orientation previously saved with a specified name.
pfcView_ptrSaveView (xrstring Name)
This method saves the view with a specified name.
voidSetCurrentViewTransform (pfcTransform3D_ptr TrForm)
Sets the transformation of a model in the current view. This is the transformation between model coordinates and screen coordinates.


Methods Inherited from Class pfcParent:

GetChild



Method Detail

optional pfcView_ptrRetrieveView (xrstring 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.


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.



optional pfcView_ptrGetView (xrstring 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(xrstring)
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



pfcView_ptrSaveView (xrstring 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.


Manual References:
Windows and Views: View Operations
Parameters:
Name
The name used to store the view.
Returns:
The saved view.



pfcTransform3D_ptrGetCurrentViewTransform ()

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.


Manual References:
Windows and Views: Transformations, Windows and Views: Transformations
Returns:
The transformation object.



voidSetCurrentViewTransform (pfcTransform3D_ptr 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.


Manual References:
Windows and Views: Transformations, Windows and Views: Transformations
Parameters:
TrForm
The transformation object.
Returns:



voidCurrentViewRotate (pfcCoordAxis Axis, xreal 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:



optional pfcViews_ptrListViews ()

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.



pfcView_ptrGetCurrentView ()

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.