HatchStyleBuilder Class¶
-
class
NXOpen.Annotations.
HatchStyleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.HatchStyleBuilder
.This class queries and sets crosshatching and area fill preferences when creating and editing crosshatching and area fill drafting annotations.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AreaFillAngle | Returns or sets the area fill angle |
AreaFillMaterial | Returns or sets the area fill material |
AreaFillScale | Returns or sets the area fill scale |
AutoTextIsland | Returns or sets the automatic text island creation flag. |
Color | Returns or sets the color of crosshatch or area fill lines or area fill solid fill color |
FindApparentIntersections | Returns or sets the Find Apparent Intersections creation flag. |
HatchAngle | Returns or sets the angle of the crosshatching lines |
HatchDistance | Returns or sets the distance between crosshatch lines |
HatchFile | Returns or sets the crosshatch definition file |
HatchMaterial | Returns or sets the crosshatch material |
IslandMargin | Returns or sets the Island margin |
LineWidth | Returns or sets the line width for crosshatch lines |
Tag | Returns the Tag for this object. |
Tolerance | Returns or sets the crosshatch and area fill tolerance |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AreaFillAngle¶
-
HatchStyleBuilder.
AreaFillAngle
¶ Returns or sets the area fill angle
-------------------------------------
Getter Method
Signature
AreaFillAngle
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AreaFillAngle
Parameters: areaFillAngle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AreaFillMaterial¶
-
HatchStyleBuilder.
AreaFillMaterial
¶ Returns or sets the area fill material
-------------------------------------
Getter Method
Signature
AreaFillMaterial
Returns: Return type: NXOpen.Annotations.AreaFillMaterial
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AreaFillMaterial
Parameters: areaFillMaterial ( NXOpen.Annotations.AreaFillMaterial
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AreaFillScale¶
-
HatchStyleBuilder.
AreaFillScale
¶ Returns or sets the area fill scale
-------------------------------------
Getter Method
Signature
AreaFillScale
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AreaFillScale
Parameters: areaFillScale (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AutoTextIsland¶
-
HatchStyleBuilder.
AutoTextIsland
¶ Returns or sets the automatic text island creation flag.
A value of True means a text island will be created when the crosshatch or area fill is created
-------------------------------------
Getter Method
Signature
AutoTextIsland
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutoTextIsland
Parameters: autoTextIsland (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Color¶
-
HatchStyleBuilder.
Color
¶ Returns or sets the color of crosshatch or area fill lines or area fill solid fill color
-------------------------------------
Getter Method
Signature
Color
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Color
Parameters: color (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
FindApparentIntersections¶
-
HatchStyleBuilder.
FindApparentIntersections
¶ Returns or sets the Find Apparent Intersections creation flag.
-------------------------------------
Getter Method
Signature
FindApparentIntersections
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FindApparentIntersections
Parameters: findApparentIntersections (bool) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
HatchAngle¶
-
HatchStyleBuilder.
HatchAngle
¶ Returns or sets the angle of the crosshatching lines
-------------------------------------
Getter Method
Signature
HatchAngle
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HatchAngle
Parameters: angle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
HatchDistance¶
-
HatchStyleBuilder.
HatchDistance
¶ Returns or sets the distance between crosshatch lines
-------------------------------------
Getter Method
Signature
HatchDistance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HatchDistance
Parameters: distance (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
HatchFile¶
-
HatchStyleBuilder.
HatchFile
¶ Returns or sets the crosshatch definition file
-------------------------------------
Getter Method
Signature
HatchFile
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HatchFile
Parameters: file (str) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
HatchMaterial¶
-
HatchStyleBuilder.
HatchMaterial
¶ Returns or sets the crosshatch material
-------------------------------------
Getter Method
Signature
HatchMaterial
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HatchMaterial
Parameters: material (str) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
IslandMargin¶
-
HatchStyleBuilder.
IslandMargin
¶ Returns or sets the Island margin
-------------------------------------
Getter Method
Signature
IslandMargin
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IslandMargin
Parameters: islandMargin (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
LineWidth¶
-
HatchStyleBuilder.
LineWidth
¶ Returns or sets the line width for crosshatch lines
-------------------------------------
Getter Method
Signature
LineWidth
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LineWidth
Parameters: lineWidth ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Tolerance¶
-
HatchStyleBuilder.
Tolerance
¶ Returns or sets the crosshatch and area fill tolerance
-------------------------------------
Getter Method
Signature
Tolerance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance
Parameters: tolerance (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
HatchStyleBuilder.
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.