PerspectiveOptionsBuilder Class¶
-
class
NXOpen.Display.PerspectiveOptionsBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.PerspectiveOptionsBuilderCameras are not supported in KF.
New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| CameraDistance | Returns or sets the camera distance: The distance from the camera’s position to the target position in the work view view when it is a perspective view. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| ApplyLastDistanceChange | Sets the work view to have the camera distance, which is the distance from the camera’s position to the target position in the work view which was specified in the last use of NXOpen.Display.PerspectiveOptionsBuilder.CameraDistance() The camera distance has no meaning for an orthographic view, so this method does nothing if the work view is an orthographic view. |
| Cancel | Cancels the Perspective Options Builder. |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
CameraDistance¶
-
PerspectiveOptionsBuilder.CameraDistance¶ Returns or sets the camera distance: The distance from the camera’s position to the target position in the work view view when it is a perspective view.
The camera distance has no meaning for an orthographic view, so this property is not applicable if the work view is an orthographic view.
-------------------------------------Getter Method
Signature
CameraDistanceReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CameraDistanceParameters: cameraDistance (float) – New in version NX8.0.0.
License requirements: None.
Method Detail¶
ApplyLastDistanceChange¶
-
PerspectiveOptionsBuilder.ApplyLastDistanceChange¶ Sets the work view to have the camera distance, which is the distance from the camera’s position to the target position in the work view which was specified in the last use of
NXOpen.Display.PerspectiveOptionsBuilder.CameraDistance()The camera distance has no meaning for an orthographic view, so this method does nothing if the work view is an orthographic view.Signature
ApplyLastDistanceChange()New in version NX11.0.0.
License requirements: None.
Cancel¶
-
PerspectiveOptionsBuilder.Cancel¶ Cancels the Perspective Options Builder.
The camera distance of the work view is restored to the value it had when the builder was created. The camera distance has no meaning for an orthographic view, so this method does nothing if the work view is an orthographic view.
Signature
Cancel()New in version NX11.0.0.
License requirements: None.
Validate¶
-
PerspectiveOptionsBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.