HatchBuilder Class¶
-
class
NXOpen.Annotations.
HatchBuilder
¶ Bases:
NXOpen.Builder
This class is used to construct the crosshatching that lies within a boundary.
To create a new instance of this class, use
NXOpen.Annotations.HatchCollection.CreateHatchBuilder
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Angle | Returns or sets the angle. |
AnnotationToExclude | Returns the select annotation to exclude |
AnnotationType | Returns or sets the type of hatch object |
AreafillAngle | Returns or sets the areafill angle. |
AutomaticallyExcludeText | Returns or sets the exclude text. |
Boundary | Returns the boundary |
Color | Returns or sets the color. |
CrosshatchFile | Returns or sets the crosshatch file. |
Distance | Returns or sets the distance. |
HatchFillSettings | Returns the HatchFillSetting |
Material | Returns or sets the area fill material. |
Pattern | Returns or sets the pattern. |
Scale | Returns or sets the scale. |
Tag | Returns the Tag for this object. |
Tolerance | Returns or sets the tolerance. |
Width | Returns or sets the width. |
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. |
GetMarginPercent | Get margin percent of a annotation @return |
GetObject | Returns the object currently being edited by this builder. |
SetCurveDirection | Set direction of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation |
SetMarginPercent | Set margin percent to a annotation |
SetNumCurrentDirectionMapElements | Set number of direction map elements to the annotation |
SetSectionCurveDirections | Set directions of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation |
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¶
HatchBuilderAnnotationTypes Enumeration | Represents types of hatch objects. |
Property Detail¶
Angle¶
-
HatchBuilder.
Angle
¶ Returns or sets the angle.
-------------------------------------
Getter Method
Signature
Angle()
Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Angle(angle)
Parameters: angle (float) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
AnnotationToExclude¶
-
HatchBuilder.
AnnotationToExclude
¶ Returns the select annotation to exclude
-------------------------------------
Getter Method
Signature
AnnotationToExclude()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
AnnotationType¶
-
HatchBuilder.
AnnotationType
¶ Returns or sets the type of hatch object
-------------------------------------
Getter Method
Signature
AnnotationType()
Returns: Return type: NXOpen.Annotations.HatchBuilderAnnotationTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnotationType(type)
Parameters: type ( NXOpen.Annotations.HatchBuilderAnnotationTypes
) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AreafillAngle¶
-
HatchBuilder.
AreafillAngle
¶ Returns or sets the areafill angle.
-------------------------------------
Getter Method
Signature
AreafillAngle()
Returns: Return type: float New in version NX6.0.1.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
AreafillAngle(angle)
Parameters: angle (float) – New in version NX6.0.1.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
AutomaticallyExcludeText¶
-
HatchBuilder.
AutomaticallyExcludeText
¶ Returns or sets the exclude text.
This is not used if
Annotations.BoundaryBuilderSelectionMethod.Curves
is set.-------------------------------------
Getter Method
Signature
AutomaticallyExcludeText()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticallyExcludeText(excludeText)
Parameters: excludeText (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Boundary¶
-
HatchBuilder.
Boundary
¶ Returns the boundary
-------------------------------------
Getter Method
Signature
Boundary()
Returns: Return type: NXOpen.Annotations.BoundaryBuilder
New in version NX6.0.0.
License requirements: None.
Color¶
-
HatchBuilder.
Color
¶ Returns or sets the color.
-------------------------------------
Getter Method
Signature
Color()
Returns: Return type: Id New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Color(color)
Parameters: color (Id) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
CrosshatchFile¶
-
HatchBuilder.
CrosshatchFile
¶ Returns or sets the crosshatch file.
-------------------------------------
Getter Method
Signature
CrosshatchFile()
Returns: Return type: str New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CrosshatchFile(filename)
Parameters: filename (str) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Distance¶
-
HatchBuilder.
Distance
¶ Returns or sets the distance.
-------------------------------------
Getter Method
Signature
Distance()
Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Distance(distance)
Parameters: distance (float) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
HatchFillSettings¶
-
HatchBuilder.
HatchFillSettings
¶ Returns the HatchFillSetting
-------------------------------------
Getter Method
Signature
HatchFillSettings()
Returns: Return type: NXOpen.Annotations.HatchFillSettingsBuilder
New in version NX7.5.0.
License requirements: None.
Material¶
-
HatchBuilder.
Material
¶ Returns or sets the area fill material.
-------------------------------------
Getter Method
Signature
Material()
Returns: Return type: NXOpen.Annotations.AreaFillMaterial
New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Material(areaFillMaterial)
Parameters: areaFillMaterial ( NXOpen.Annotations.AreaFillMaterial
) –New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Pattern¶
-
HatchBuilder.
Pattern
¶ Returns or sets the pattern.
-------------------------------------
Getter Method
Signature
Pattern()
Returns: Return type: str New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Pattern(identifier)
Parameters: identifier (str) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Scale¶
-
HatchBuilder.
Scale
¶ Returns or sets the scale.
-------------------------------------
Getter Method
Signature
Scale()
Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Scale(scale)
Parameters: scale (float) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Tolerance¶
-
HatchBuilder.
Tolerance
¶ Returns or sets the tolerance.
-------------------------------------
Getter Method
Signature
Tolerance()
Returns: Return type: float New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance(tolerance)
Parameters: tolerance (float) – New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Width¶
-
HatchBuilder.
Width
¶ Returns or sets the width.
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Width(width)
Parameters: width ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
Deprecated since version NX7.5.0: Use
NXOpen.Annotations.HatchFillSettingsBuilder
instead.License requirements: drafting (“DRAFTING”)
Method Detail¶
GetMarginPercent¶
-
HatchBuilder.
GetMarginPercent
¶ Get margin percent of a annotation
Signature
GetMarginPercent(annotation)
Parameters: annotation ( NXOpen.NXObject
) – annotation or DraftingCombinedInstanceReturns: Return type: float New in version NX7.5.0.
License requirements: None.
SetCurveDirection¶
-
HatchBuilder.
SetCurveDirection
¶ Set direction of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation
Signature
SetCurveDirection(curveTag, curveDirection)
Parameters: - curveTag (
NXOpen.NXObject
) – - curveDirection (int) –
New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
- curveTag (
SetMarginPercent¶
-
HatchBuilder.
SetMarginPercent
¶ Set margin percent to a annotation
Signature
SetMarginPercent(annotation, marginpercent)
Parameters: - annotation (
NXOpen.NXObject
) – annotation or DraftingCombinedInstance - marginpercent (float) – text islands value
New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
- annotation (
SetNumCurrentDirectionMapElements¶
-
HatchBuilder.
SetNumCurrentDirectionMapElements
¶ Set number of direction map elements to the annotation
Signature
SetNumCurrentDirectionMapElements(numCurrentDirectionMapElement)
Parameters: numCurrentDirectionMapElement (int) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
SetSectionCurveDirections¶
-
HatchBuilder.
SetSectionCurveDirections
¶ Set directions of a curve to the annotation The number of diection map elements need to specify before to the direction of the curve elements to the annotation
Signature
SetSectionCurveDirections(section, curve, curveDirections)
Parameters: - section (
NXOpen.NXObject
) – - curve (
NXOpen.NXObject
) – - curveDirections (list of int) – array of directions for the curve
New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
- section (
Validate¶
-
HatchBuilder.
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.