XYZPlaneBuilder Class¶
-
class
NXOpen.GeometricAnalysis.SectionAnalysis.
XYZPlaneBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents the XYZ Plane specification for a
GeometricAnalysis.SectionAnalysis.SectionAnalysisExBuilder
.New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
AnchorOrigin | Returns or sets the anchor position |
AnchorXAxis | Returns or sets the anchor X axis |
AnchorYAxis | Returns or sets the anchor Y axis |
IsNumberEnabled | Returns or sets a value indicating whether the number is used |
IsSpacingEnabled | Returns or sets a value indicating whether the spacing is applied |
IsXEnabled | Returns or sets a value indicating whether X is enabled |
IsYEnabled | Returns or sets a value indicating whether Y is enabled |
IsZEnabled | Returns or sets a value indicating whether Z is enabled |
Number | Returns or sets a value indicating how many sections should be created |
Spacing | Returns or sets a value indicating the space between sections |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AnchorOrigin¶
-
XYZPlaneBuilder.
AnchorOrigin
¶ Returns or sets the anchor position
-------------------------------------
Getter Method
Signature
AnchorOrigin
Returns: Return type: NXOpen.Point3d
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnchorOrigin
Parameters: anchorOrigin ( NXOpen.Point3d
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
AnchorXAxis¶
-
XYZPlaneBuilder.
AnchorXAxis
¶ Returns or sets the anchor X axis
-------------------------------------
Getter Method
Signature
AnchorXAxis
Returns: Return type: NXOpen.Vector3d
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnchorXAxis
Parameters: anchorXAxis ( NXOpen.Vector3d
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
AnchorYAxis¶
-
XYZPlaneBuilder.
AnchorYAxis
¶ Returns or sets the anchor Y axis
-------------------------------------
Getter Method
Signature
AnchorYAxis
Returns: Return type: NXOpen.Vector3d
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnchorYAxis
Parameters: anchorYAxis ( NXOpen.Vector3d
) –New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
IsNumberEnabled¶
-
XYZPlaneBuilder.
IsNumberEnabled
¶ Returns or sets a value indicating whether the number is used
-------------------------------------
Getter Method
Signature
IsNumberEnabled
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsNumberEnabled
Parameters: isNumberEnabled (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
IsSpacingEnabled¶
-
XYZPlaneBuilder.
IsSpacingEnabled
¶ Returns or sets a value indicating whether the spacing is applied
-------------------------------------
Getter Method
Signature
IsSpacingEnabled
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsSpacingEnabled
Parameters: isSpacingEnabled (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
IsXEnabled¶
-
XYZPlaneBuilder.
IsXEnabled
¶ Returns or sets a value indicating whether X is enabled
-------------------------------------
Getter Method
Signature
IsXEnabled
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsXEnabled
Parameters: isXEnabled (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
IsYEnabled¶
-
XYZPlaneBuilder.
IsYEnabled
¶ Returns or sets a value indicating whether Y is enabled
-------------------------------------
Getter Method
Signature
IsYEnabled
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsYEnabled
Parameters: isYEnabled (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
IsZEnabled¶
-
XYZPlaneBuilder.
IsZEnabled
¶ Returns or sets a value indicating whether Z is enabled
-------------------------------------
Getter Method
Signature
IsZEnabled
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsZEnabled
Parameters: isZEnabled (bool) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Number¶
-
XYZPlaneBuilder.
Number
¶ Returns or sets a value indicating how many sections should be created
-------------------------------------
Getter Method
Signature
Number
Returns: Return type: int New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Number
Parameters: number (int) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Spacing¶
-
XYZPlaneBuilder.
Spacing
¶ Returns or sets a value indicating the space between sections
-------------------------------------
Getter Method
Signature
Spacing
Returns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Spacing
Parameters: spacing (float) – New in version NX7.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
Validate¶
-
XYZPlaneBuilder.
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.