View2dOrientBuilder Class¶
-
class
NXOpen.Drawings.View2dOrientBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents the View 2D Orientation (Drawings.
View2dOrientBuilder)
New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| CustomOrientationMethod | Returns or sets the custom orientation method |
| CustomXAngle | Returns or sets the orientation angle around the X axis |
| CustomYAngle | Returns or sets the orientation angle around the Y axis |
| CustomZAngle | Returns or sets the orientation angle around the Z axis |
| OrientationType | Returns or sets the orientation type |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetCustomNormalX | Returns the X component of the custom view-normal vector |
| GetCustomNormalY | Returns the Y component of the custom view-normal vector |
| GetCustomNormalZ | Returns the Z component of the custom view-normal vector |
| GetCustomPrimaryX | Returns the X component of the custom view-primary vector |
| GetCustomPrimaryY | Returns the Y component of the custom view-primary vector |
| GetCustomPrimaryZ | Returns the Z component of the custom view-primary vector |
| GetInferredPrimary | Returns the option to infer the direction view X vector in 3D space |
| SetCustomNormalX | Sets the X component of the custom view-normal vector |
| SetCustomNormalY | Sets the Y component of the custom view-normal vector |
| SetCustomNormalZ | Sets the Z component of the custom view-normal vector |
| SetCustomPrimaryX | Sets the X component of the custom view-primary vector |
| SetCustomPrimaryY | Sets the Y component of the custom view-primary vector |
| SetCustomPrimaryZ | Sets the Z component of the custom view-primary vector |
| SetInferredPrimary | Sets the option to infer the direction view X vector in 3D space |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| View2dOrientBuilderCustomMethod Enumeration | The custom orientation method |
| View2dOrientBuilderType Enumeration | The view orientation type |
Property Detail¶
CustomOrientationMethod¶
-
View2dOrientBuilder.CustomOrientationMethod¶ Returns or sets the custom orientation method
-------------------------------------Getter Method
Signature
CustomOrientationMethodReturns: returns the custom orientation method. Return type: NXOpen.Drawings.View2dOrientBuilderCustomMethodNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CustomOrientationMethodParameters: methd ( NXOpen.Drawings.View2dOrientBuilderCustomMethod) – sets the custom orientation method.New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
CustomXAngle¶
-
View2dOrientBuilder.CustomXAngle¶ Returns or sets the orientation angle around the X axis
-------------------------------------Getter Method
Signature
CustomXAngleReturns: returns angle around X axis Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CustomXAngleParameters: angle (float) – sets the angle around X axis New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
CustomYAngle¶
-
View2dOrientBuilder.CustomYAngle¶ Returns or sets the orientation angle around the Y axis
-------------------------------------Getter Method
Signature
CustomYAngleReturns: returns angle around Y axis Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CustomYAngleParameters: angle (float) – sets the angle around Y axis New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
CustomZAngle¶
-
View2dOrientBuilder.CustomZAngle¶ Returns or sets the orientation angle around the Z axis
-------------------------------------Getter Method
Signature
CustomZAngleReturns: returns angle around Z axis Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CustomZAngleParameters: angle (float) – sets the angle around Z axis New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
OrientationType¶
-
View2dOrientBuilder.OrientationType¶ Returns or sets the orientation type
-------------------------------------Getter Method
Signature
OrientationTypeReturns: returns the orientation type. Return type: NXOpen.Drawings.View2dOrientBuilderTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OrientationTypeParameters: type ( NXOpen.Drawings.View2dOrientBuilderType) – sets the orientation type.New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetCustomNormalX¶
-
View2dOrientBuilder.GetCustomNormalX¶ Returns the X component of the custom view-normal vector
Signature
GetCustomNormalX()Returns: returns the X component of view normal in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetCustomNormalY¶
-
View2dOrientBuilder.GetCustomNormalY¶ Returns the Y component of the custom view-normal vector
Signature
GetCustomNormalY()Returns: returns the Y component of view normal in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetCustomNormalZ¶
-
View2dOrientBuilder.GetCustomNormalZ¶ Returns the Z component of the custom view-normal vector
Signature
GetCustomNormalZ()Returns: returns the Z component of view normal in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetCustomPrimaryX¶
-
View2dOrientBuilder.GetCustomPrimaryX¶ Returns the X component of the custom view-primary vector
Signature
GetCustomPrimaryX()Returns: returns the X component of view primary vector in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetCustomPrimaryY¶
-
View2dOrientBuilder.GetCustomPrimaryY¶ Returns the Y component of the custom view-primary vector
Signature
GetCustomPrimaryY()Returns: returns the Y component of view primary vector in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetCustomPrimaryZ¶
-
View2dOrientBuilder.GetCustomPrimaryZ¶ Returns the Z component of the custom view-primary vector
Signature
GetCustomPrimaryZ()Returns: returns the Z component of view primary vector in global CS Return type: float New in version NX6.0.0.
License requirements: None.
GetInferredPrimary¶
-
View2dOrientBuilder.GetInferredPrimary¶ Returns the option to infer the direction view X vector in 3D space
Signature
GetInferredPrimary()Returns: returns the inferred option Return type: bool New in version NX6.0.0.
License requirements: None.
SetCustomNormalX¶
-
View2dOrientBuilder.SetCustomNormalX¶ Sets the X component of the custom view-normal vector
Signature
SetCustomNormalX(component)Parameters: component (float) – sets the the X component of view normal in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomNormalY¶
-
View2dOrientBuilder.SetCustomNormalY¶ Sets the Y component of the custom view-normal vector
Signature
SetCustomNormalY(component)Parameters: component (float) – sets the the Y component of view normal in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomNormalZ¶
-
View2dOrientBuilder.SetCustomNormalZ¶ Sets the Z component of the custom view-normal vector
Signature
SetCustomNormalZ(component)Parameters: component (float) – sets the the Z component of view normal in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomPrimaryX¶
-
View2dOrientBuilder.SetCustomPrimaryX¶ Sets the X component of the custom view-primary vector
Signature
SetCustomPrimaryX(component)Parameters: component (float) – sets the the X component of view primary vector in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomPrimaryY¶
-
View2dOrientBuilder.SetCustomPrimaryY¶ Sets the Y component of the custom view-primary vector
Signature
SetCustomPrimaryY(component)Parameters: component (float) – sets the the Y component of view primary vector in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetCustomPrimaryZ¶
-
View2dOrientBuilder.SetCustomPrimaryZ¶ Sets the Z component of the custom view-primary vector
Signature
SetCustomPrimaryZ(component)Parameters: component (float) – sets the the Z component of view primary vector in global CS New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetInferredPrimary¶
-
View2dOrientBuilder.SetInferredPrimary¶ Sets the option to infer the direction view X vector in 3D space
Signature
SetInferredPrimary(inferred)Parameters: inferred (bool) – sets the inferred option New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
View2dOrientBuilder.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.