RegionBuilder Class¶
-
class
NXOpen.Annotations.
RegionBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Annotations.RegionBuilder
builderTo create a new instance of this class, use
NXOpen.Annotations.PmiRegionCollection.CreateRegionBuilder
Default values.
Property Value ConformToSurface 0 New in version NX6.0.0.
Properties¶
Methods¶
Method | Description |
---|---|
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. |
Enumerations¶
RegionBuilderAlignmentPosition Enumeration | Specifies the anchor location of the region |
RegionBuilderCrosshatchPatterns Enumeration | Specifies the crosshatch pattern |
RegionBuilderTypes Enumeration | Specifies the region type |
Property Detail¶
Anchor¶
-
RegionBuilder.
Anchor
¶ Returns or sets the anchor Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
,NXOpen.Annotations.RegionBuilderTypes.CircularRegion
,NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
Anchor()
Returns: Return type: NXOpen.Annotations.RegionBuilderAlignmentPosition
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Anchor(anchor)
Parameters: anchor ( NXOpen.Annotations.RegionBuilderAlignmentPosition
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
ArbitraryAreaList¶
-
RegionBuilder.
ArbitraryAreaList
¶ Returns the arbitrary area list Only available when the region type is
NXOpen.Annotations.RegionBuilderTypes.ArbitraryRegion
-------------------------------------
Getter Method
Signature
ArbitraryAreaList()
Returns: Return type: NXOpen.Annotations.ArbitraryAreaSeedBuilderList
New in version NX6.0.0.
License requirements: None.
ConformToSurface¶
-
RegionBuilder.
ConformToSurface
¶ Returns or sets the conform to surface toggle Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
,NXOpen.Annotations.RegionBuilderTypes.CircularRegion
,NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
ConformToSurface()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConformToSurface(conformToSurfaceToggle)
Parameters: conformToSurfaceToggle (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
CrosshatchAngle¶
-
RegionBuilder.
CrosshatchAngle
¶ Returns the crosshatch angle.
Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.-------------------------------------
Getter Method
Signature
CrosshatchAngle()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.License requirements: None.
CrosshatchColor¶
-
RegionBuilder.
CrosshatchColor
¶ Returns or sets the crosshatch color
-------------------------------------
Getter Method
Signature
CrosshatchColor()
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CrosshatchColor(crosshatchColor)
Parameters: crosshatchColor (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
CrosshatchDistance¶
-
RegionBuilder.
CrosshatchDistance
¶ Returns the crosshatch distance.
Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.-------------------------------------
Getter Method
Signature
CrosshatchDistance()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.License requirements: None.
CrosshatchPattern¶
-
RegionBuilder.
CrosshatchPattern
¶ Returns or sets the crosshatch pattern enum.
Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.-------------------------------------
Getter Method
Signature
CrosshatchPattern()
Returns: Return type: NXOpen.Annotations.RegionBuilderCrosshatchPatterns
New in version NX6.0.0.
Deprecated since version NX8.5.0: Use
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CrosshatchPattern(crosshatchPattern)
Parameters: crosshatchPattern ( NXOpen.Annotations.RegionBuilderCrosshatchPatterns
) –New in version NX6.0.0.
Deprecated since version NX8.5.0: Use the sublock of
NXOpen.Annotations.RegionBuilder.CrosshatchSettings
called Pattern instead.License requirements: geometric_tol (“GDT”)
CrosshatchSettings¶
-
RegionBuilder.
CrosshatchSettings
¶ Returns the crosshatch settings block
-------------------------------------
Getter Method
Signature
CrosshatchSettings()
Returns: Return type: NXOpen.Annotations.HatchFillSettingsBuilder
New in version NX8.5.0.
License requirements: None.
DisplayCrosshatch¶
-
RegionBuilder.
DisplayCrosshatch
¶ Returns or sets the display crosshatch toggle
-------------------------------------
Getter Method
Signature
DisplayCrosshatch()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayCrosshatch(displayCrosshatch)
Parameters: displayCrosshatch (bool) – New in version NX8.5.0.
License requirements: geometric_tol (“GDT”)
EndPoint¶
-
RegionBuilder.
EndPoint
¶ Returns or sets the end point Only available when the region type is
NXOpen.Annotations.RegionBuilderTypes.CylindricalRegion
-------------------------------------
Getter Method
Signature
EndPoint()
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndPoint(endPoint)
Parameters: endPoint ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
Height¶
-
RegionBuilder.
Height
¶ Returns the height Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
InnerDiameter¶
-
RegionBuilder.
InnerDiameter
¶ Returns the inner diameter Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
InnerDiameter()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Origin¶
-
RegionBuilder.
Origin
¶ Returns or sets the origin Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
,NXOpen.Annotations.RegionBuilderTypes.CircularRegion
,NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Origin(origin)
Parameters: origin ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
OuterDiameter¶
-
RegionBuilder.
OuterDiameter
¶ Returns the outer diameter Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.CircularRegion
,NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
OuterDiameter()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Plane¶
-
RegionBuilder.
Plane
¶ Returns the plane
-------------------------------------
Getter Method
Signature
Plane()
Returns: Return type: NXOpen.Annotations.PlaneBuilder
New in version NX6.0.0.
License requirements: None.
SelectCylindricalFace¶
-
RegionBuilder.
SelectCylindricalFace
¶ Returns the select cylindrical face Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.CylindricalRegion
-------------------------------------
Getter Method
Signature
SelectCylindricalFace()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
SelectFace¶
-
RegionBuilder.
SelectFace
¶ Returns the select face Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
,NXOpen.Annotations.RegionBuilderTypes.CircularRegion
,NXOpen.Annotations.RegionBuilderTypes.AnnularRegion
-------------------------------------
Getter Method
Signature
SelectFace()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
StartPoint¶
-
RegionBuilder.
StartPoint
¶ Returns or sets the start point Only available when the region type is
NXOpen.Annotations.RegionBuilderTypes.CylindricalRegion
-------------------------------------
Getter Method
Signature
StartPoint()
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartPoint(startPoint)
Parameters: startPoint ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
Type¶
-
RegionBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Annotations.RegionBuilderTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Annotations.RegionBuilderTypes
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
Width¶
-
RegionBuilder.
Width
¶ Returns the width Only available when region type is
NXOpen.Annotations.RegionBuilderTypes.RectangularRegion
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RegionBuilder.
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.