SurfaceIntersectionBuilder Class¶
-
class
NXOpen.GeometricAnalysis.
SurfaceIntersectionBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.GeometricAnalysis.SurfaceIntersection
builderTo create a new instance of this class, use
NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateSurfaceIntersectionBuilder()
Default values.
Property Value CalculationMethod Curvature DynamicProjection 1 NeedleDirection Outside ProjectionNormalFace FaceSet1 ProjectionOption None ProjectionXYZ X ScalingMethod Linear New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CalculationMethod | Returns or sets the calculation method |
CombOptions | Returns the comb display block options |
DynamicProjection | Returns or sets the dynamic projection |
FirstFaceSet | Returns the first selected face set |
NeedleDirection | Returns or sets the needle direction |
ProjectionNormalFace | Returns or sets the face normal projection |
ProjectionOption | Returns or sets the projection option |
ProjectionXYZ | Returns or sets the xyz projection |
ScalingMethod | Returns or sets the scaling method |
SecondFaceSet | Returns the second selected face set |
Tag | Returns the Tag for this object. |
Vector | Returns or sets the vector |
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. |
UpdateWorkView | Update work view with a given view matrix |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SurfaceIntersectionBuilderCalculationTypes Enumeration | Enumeration for needle calculation method |
SurfaceIntersectionBuilderDirectionTypes Enumeration | Enumeration for needle direction type |
SurfaceIntersectionBuilderLabelValues Enumeration | Enumeration for label computation method |
SurfaceIntersectionBuilderNormalTypes Enumeration | Enumeration for face normal |
SurfaceIntersectionBuilderProjectionTypes Enumeration | Projection types |
SurfaceIntersectionBuilderScalingTypes Enumeration | Enumeration for needle display type |
SurfaceIntersectionBuilderXyzTypes Enumeration | Enumeration for X, Y or Z projection plane |
Property Detail¶
CalculationMethod¶
-
SurfaceIntersectionBuilder.
CalculationMethod
¶ Returns or sets the calculation method
-------------------------------------
Getter Method
Signature
CalculationMethod()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderCalculationTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalculationMethod(calculationMethod)
Parameters: calculationMethod ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderCalculationTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
CombOptions¶
-
SurfaceIntersectionBuilder.
CombOptions
¶ Returns the comb display block options
-------------------------------------
Getter Method
Signature
CombOptions()
Returns: Return type: NXOpen.GeometricUtilities.CombOptionsBuilder
New in version NX7.5.0.
License requirements: None.
DynamicProjection¶
-
SurfaceIntersectionBuilder.
DynamicProjection
¶ Returns or sets the dynamic projection
-------------------------------------
Getter Method
Signature
DynamicProjection()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DynamicProjection(dynamicProjection)
Parameters: dynamicProjection (bool) – New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
FirstFaceSet¶
-
SurfaceIntersectionBuilder.
FirstFaceSet
¶ Returns the first selected face set
-------------------------------------
Getter Method
Signature
FirstFaceSet()
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
NeedleDirection¶
-
SurfaceIntersectionBuilder.
NeedleDirection
¶ Returns or sets the needle direction
-------------------------------------
Getter Method
Signature
NeedleDirection()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderDirectionTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedleDirection(needleDirection)
Parameters: needleDirection ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderDirectionTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ProjectionNormalFace¶
-
SurfaceIntersectionBuilder.
ProjectionNormalFace
¶ Returns or sets the face normal projection
-------------------------------------
Getter Method
Signature
ProjectionNormalFace()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderNormalTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectionNormalFace(normalFace)
Parameters: normalFace ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderNormalTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ProjectionOption¶
-
SurfaceIntersectionBuilder.
ProjectionOption
¶ Returns or sets the projection option
-------------------------------------
Getter Method
Signature
ProjectionOption()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderProjectionTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectionOption(projectionOption)
Parameters: projectionOption ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderProjectionTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ProjectionXYZ¶
-
SurfaceIntersectionBuilder.
ProjectionXYZ
¶ Returns or sets the xyz projection
-------------------------------------
Getter Method
Signature
ProjectionXYZ()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderXyzTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectionXYZ(projectionXYZ)
Parameters: projectionXYZ ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderXyzTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
ScalingMethod¶
-
SurfaceIntersectionBuilder.
ScalingMethod
¶ Returns or sets the scaling method
-------------------------------------
Getter Method
Signature
ScalingMethod()
Returns: Return type: NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderScalingTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScalingMethod(scalingMethod)
Parameters: scalingMethod ( NXOpen.GeometricAnalysis.SurfaceIntersectionBuilderScalingTypes
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
SecondFaceSet¶
-
SurfaceIntersectionBuilder.
SecondFaceSet
¶ Returns the second selected face set
-------------------------------------
Getter Method
Signature
SecondFaceSet()
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
Vector¶
-
SurfaceIntersectionBuilder.
Vector
¶ Returns or sets the vector
-------------------------------------
Getter Method
Signature
Vector()
Returns: Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Vector(vector)
Parameters: vector ( NXOpen.Direction
) –New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Method Detail¶
UpdateWorkView¶
-
SurfaceIntersectionBuilder.
UpdateWorkView
¶ Update work view with a given view matrix
Signature
UpdateWorkView()
New in version NX7.5.0.
License requirements: studio_analyze (“STUDIO ANALYZE”)
Validate¶
-
SurfaceIntersectionBuilder.
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.