DraftAnalysisBuilder Class¶
-
class
NXOpen.GeometricAnalysis.
DraftAnalysisBuilder
¶ Bases:
NXOpen.Builder
Represents a Draft Analysis builder
To create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateDraftAnalysisBuilder()
Default values.
Property Value CoupleLimit 1 CreateCSYS 0 DrawOption Orientation JoinIsocline 0 LimitAngleNegative -5 LimitAnglePositive 5 OutputOption AnalysisObject Resolution.AngleTolerance 15.0 Resolution.EdgeTolerance 0.005 Resolution.FaceTolerance 0.005 Resolution.Resolution Standard Resolution.WidthTolerance 0.3 ShowIsoclineNegative 0 ShowIsoclinePositive 0 ShowPartingLine 0 TranslucencyInsideNegative 0 TranslucencyInsidePositive 0 TranslucencyOutsideNegative 0 TranslucencyOutsidePositive 0 New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
CoupleLimit | Returns or sets the coupling limit |
CreateCSYS | Returns or sets the datum CSYS creation |
DrawOption | Returns or sets the draw option |
DrawOrientation | Returns or sets the draw orientation |
DrawOrigin | Returns or sets the draw origin |
DrawVector | Returns or sets the draw vector |
DynamicLabel | Returns the constraint manager |
JoinIsocline | Returns or sets the joining isocline |
LimitAngleNegative | Returns or sets the negative limit angle |
LimitAnglePositive | Returns or sets the positive limit angle |
OutputOption | Returns or sets the output option |
Resolution | Returns the display resolution |
ReverseIndividual | Returns the individual face normal |
SelectObject | Returns the faces or facet bodies |
ShowIsoclineNegative | Returns or sets the negative isocline |
ShowIsoclinePositive | Returns or sets the positive isocline |
ShowPartingLine | Returns or sets the show parting line |
Tag | Returns the Tag for this object. |
TranslucencyInsideNegative | Returns or sets the negative inside translucency |
TranslucencyInsidePositive | Returns or sets the positive inside translucency |
TranslucencyOutsideNegative | Returns or sets the negative outside tanslucency |
TranslucencyOutsidePositive | Returns or sets the positive outside translucenty |
Methods¶
Method | Description |
---|---|
AddDynamicPoints | Adds dynamic points to the draft analysis object |
Commit | Commits any edits that have been applied to the builder. |
DeleteDynamicLabels | Deletes dynamic labels whose corresponding positions are set to true in the array |
DeselectFaces | Deselects faces |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetColorInsideNegative | Returns the negative inside color |
GetColorInsidePositive | Returns the positive inside color |
GetColorOutsideNegative | Returns the negative outside color |
GetColorOutsidePositive | Returns the positive outside color |
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. |
RemoveLabelParents | Removes dynamic label parents |
ReverseAllNormals | Reverses all normals |
ReverseNormal | Reverses individual face normal |
SetColorInsideNegative | Sets the negative inside color |
SetColorInsidePositive | Sets the positive inside color |
SetColorOutsideNegative | Sets the negative outside color |
SetColorOutsidePositive | Sets the positive outside color |
SetDynamicNormal | Sets dynamic normal |
SetDynamicParent | Sets dynamic parent |
SetTotalDynamicNormals | Sets number of dynamic normals |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateReverseMap | Updates reverse map |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
DraftAnalysisBuilderDrawDirection Enumeration | define draw direction items |
DraftAnalysisBuilderSelectOutput Enumeration | define output options |
Property Detail¶
CoupleLimit¶
-
DraftAnalysisBuilder.
CoupleLimit
¶ Returns or sets the coupling limit
-------------------------------------
Getter Method
Signature
CoupleLimit
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoupleLimit
Parameters: coupleLimit (bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CreateCSYS¶
-
DraftAnalysisBuilder.
CreateCSYS
¶ Returns or sets the datum CSYS creation
-------------------------------------
Getter Method
Signature
CreateCSYS
Returns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateCSYS
Parameters: createCSYS (bool) – New in version NX8.0.1.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DrawOption¶
-
DraftAnalysisBuilder.
DrawOption
¶ Returns or sets the draw option
-------------------------------------
Getter Method
Signature
DrawOption
Returns: Return type: NXOpen.GeometricAnalysis.DraftAnalysisBuilderDrawDirection
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawOption
Parameters: drawOption ( NXOpen.GeometricAnalysis.DraftAnalysisBuilderDrawDirection
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DrawOrientation¶
-
DraftAnalysisBuilder.
DrawOrientation
¶ Returns or sets the draw orientation
-------------------------------------
Getter Method
Signature
DrawOrientation
Returns: Return type: NXOpen.Matrix3x3
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawOrientation
Parameters: drawOrientation ( NXOpen.Matrix3x3
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DrawOrigin¶
-
DraftAnalysisBuilder.
DrawOrigin
¶ Returns or sets the draw origin
-------------------------------------
Getter Method
Signature
DrawOrigin
Returns: Return type: NXOpen.Point3d
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawOrigin
Parameters: drawOrigin ( NXOpen.Point3d
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DrawVector¶
-
DraftAnalysisBuilder.
DrawVector
¶ Returns or sets the draw vector
-------------------------------------
Getter Method
Signature
DrawVector
Returns: Return type: NXOpen.Direction
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawVector
Parameters: drawVector ( NXOpen.Direction
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DynamicLabel¶
-
DraftAnalysisBuilder.
DynamicLabel
¶ Returns the constraint manager
-------------------------------------
Getter Method
Signature
DynamicLabel
Returns: Return type: NXOpen.Features.GeometricConstraintDataManager
New in version NX8.0.0.
License requirements: None.
JoinIsocline¶
-
DraftAnalysisBuilder.
JoinIsocline
¶ Returns or sets the joining isocline
-------------------------------------
Getter Method
Signature
JoinIsocline
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
JoinIsocline
Parameters: joinIsocline (bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
LimitAngleNegative¶
-
DraftAnalysisBuilder.
LimitAngleNegative
¶ Returns or sets the negative limit angle
-------------------------------------
Getter Method
Signature
LimitAngleNegative
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LimitAngleNegative
Parameters: limitAngleNeg (float) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
LimitAnglePositive¶
-
DraftAnalysisBuilder.
LimitAnglePositive
¶ Returns or sets the positive limit angle
-------------------------------------
Getter Method
Signature
LimitAnglePositive
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LimitAnglePositive
Parameters: limitAnglePos (float) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
OutputOption¶
-
DraftAnalysisBuilder.
OutputOption
¶ Returns or sets the output option
-------------------------------------
Getter Method
Signature
OutputOption
Returns: Return type: NXOpen.GeometricAnalysis.DraftAnalysisBuilderSelectOutput
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputOption
Parameters: outputOption ( NXOpen.GeometricAnalysis.DraftAnalysisBuilderSelectOutput
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Resolution¶
-
DraftAnalysisBuilder.
Resolution
¶ Returns the display resolution
-------------------------------------
Getter Method
Signature
Resolution
Returns: Return type: NXOpen.GeometricUtilities.DisplayResolutionBuilder
New in version NX8.0.0.
License requirements: None.
ReverseIndividual¶
-
DraftAnalysisBuilder.
ReverseIndividual
¶ Returns the individual face normal
-------------------------------------
Getter Method
Signature
ReverseIndividual
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX8.0.0.
License requirements: None.
SelectObject¶
-
DraftAnalysisBuilder.
SelectObject
¶ Returns the faces or facet bodies
-------------------------------------
Getter Method
Signature
SelectObject
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.0.0.
License requirements: None.
ShowIsoclineNegative¶
-
DraftAnalysisBuilder.
ShowIsoclineNegative
¶ Returns or sets the negative isocline
-------------------------------------
Getter Method
Signature
ShowIsoclineNegative
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowIsoclineNegative
Parameters: showIsoclineNeg (bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ShowIsoclinePositive¶
-
DraftAnalysisBuilder.
ShowIsoclinePositive
¶ Returns or sets the positive isocline
-------------------------------------
Getter Method
Signature
ShowIsoclinePositive
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowIsoclinePositive
Parameters: showIsoclinePos (bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ShowPartingLine¶
-
DraftAnalysisBuilder.
ShowPartingLine
¶ Returns or sets the show parting line
-------------------------------------
Getter Method
Signature
ShowPartingLine
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowPartingLine
Parameters: showPartingLine (bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
TranslucencyInsideNegative¶
-
DraftAnalysisBuilder.
TranslucencyInsideNegative
¶ Returns or sets the negative inside translucency
-------------------------------------
Getter Method
Signature
TranslucencyInsideNegative
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslucencyInsideNegative
Parameters: translucencyInsideNeg (int) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
TranslucencyInsidePositive¶
-
DraftAnalysisBuilder.
TranslucencyInsidePositive
¶ Returns or sets the positive inside translucency
-------------------------------------
Getter Method
Signature
TranslucencyInsidePositive
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslucencyInsidePositive
Parameters: translucencyInsidePos (int) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
TranslucencyOutsideNegative¶
-
DraftAnalysisBuilder.
TranslucencyOutsideNegative
¶ Returns or sets the negative outside tanslucency
-------------------------------------
Getter Method
Signature
TranslucencyOutsideNegative
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslucencyOutsideNegative
Parameters: translucencyOutsideNeg (int) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
TranslucencyOutsidePositive¶
-
DraftAnalysisBuilder.
TranslucencyOutsidePositive
¶ Returns or sets the positive outside translucenty
-------------------------------------
Getter Method
Signature
TranslucencyOutsidePositive
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslucencyOutsidePositive
Parameters: translucencyOutsidePos (int) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
AddDynamicPoints¶
-
DraftAnalysisBuilder.
AddDynamicPoints
¶ Adds dynamic points to the draft analysis object
Signature
AddDynamicPoints()
New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DeleteDynamicLabels¶
-
DraftAnalysisBuilder.
DeleteDynamicLabels
¶ Deletes dynamic labels whose corresponding positions are set to true in the array
Signature
DeleteDynamicLabels(deletedLabels)
Parameters: deletedLabels (list of bool) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
DeselectFaces¶
-
DraftAnalysisBuilder.
DeselectFaces
¶ Deselects faces
Signature
DeselectFaces(faces)
Parameters: faces (list of NXOpen.DisplayableObject
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
GetColorInsideNegative¶
-
DraftAnalysisBuilder.
GetColorInsideNegative
¶ Returns the negative inside color
Signature
GetColorInsideNegative()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX8.0.0.
License requirements: None.
GetColorInsidePositive¶
-
DraftAnalysisBuilder.
GetColorInsidePositive
¶ Returns the positive inside color
Signature
GetColorInsidePositive()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX8.0.0.
License requirements: None.
GetColorOutsideNegative¶
-
DraftAnalysisBuilder.
GetColorOutsideNegative
¶ Returns the negative outside color
Signature
GetColorOutsideNegative()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX8.0.0.
License requirements: None.
GetColorOutsidePositive¶
-
DraftAnalysisBuilder.
GetColorOutsidePositive
¶ Returns the positive outside color
Signature
GetColorOutsidePositive()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX8.0.0.
License requirements: None.
RemoveLabelParents¶
-
DraftAnalysisBuilder.
RemoveLabelParents
¶ Removes dynamic label parents
Signature
RemoveLabelParents(parents)
Parameters: parents (list of NXOpen.DisplayableObject
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ReverseAllNormals¶
-
DraftAnalysisBuilder.
ReverseAllNormals
¶ Reverses all normals
Signature
ReverseAllNormals()
New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ReverseNormal¶
-
DraftAnalysisBuilder.
ReverseNormal
¶ Reverses individual face normal
Signature
ReverseNormal(face)
Parameters: face ( NXOpen.DisplayableObject
) –New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetColorInsideNegative¶
-
DraftAnalysisBuilder.
SetColorInsideNegative
¶ Sets the negative inside color
Signature
SetColorInsideNegative(colorInsideNeg)
Parameters: colorInsideNeg (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetColorInsidePositive¶
-
DraftAnalysisBuilder.
SetColorInsidePositive
¶ Sets the positive inside color
Signature
SetColorInsidePositive(colorInsidePos)
Parameters: colorInsidePos (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetColorOutsideNegative¶
-
DraftAnalysisBuilder.
SetColorOutsideNegative
¶ Sets the negative outside color
Signature
SetColorOutsideNegative(colorOutsideNeg)
Parameters: colorOutsideNeg (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetColorOutsidePositive¶
-
DraftAnalysisBuilder.
SetColorOutsidePositive
¶ Sets the positive outside color
Signature
SetColorOutsidePositive(colorOutsidePos)
Parameters: colorOutsidePos (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetDynamicNormal¶
-
DraftAnalysisBuilder.
SetDynamicNormal
¶ Sets dynamic normal
Signature
SetDynamicNormal(index, normal)
Parameters: - index (int) –
- normal (
NXOpen.Vector3d
) –
New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetDynamicParent¶
-
DraftAnalysisBuilder.
SetDynamicParent
¶ Sets dynamic parent
Signature
SetDynamicParent(index, parent)
Parameters: - index (int) –
- parent (
NXOpen.DisplayableObject
) –
New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SetTotalDynamicNormals¶
-
DraftAnalysisBuilder.
SetTotalDynamicNormals
¶ Sets number of dynamic normals
Signature
SetTotalDynamicNormals(total)
Parameters: total (int) – New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
UpdateReverseMap¶
-
DraftAnalysisBuilder.
UpdateReverseMap
¶ Updates reverse map
Signature
UpdateReverseMap()
New in version NX8.0.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Validate¶
-
DraftAnalysisBuilder.
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.