DetectPrimitivesBuilder Class¶
-
class
NXOpen.Facet.
DetectPrimitivesBuilder
¶ Bases:
NXOpen.Builder
This class manages the primitive shape detection for a facet body.
To create a new instance of this class, use
NXOpen.Facet.FacetModelingCollection.CreateDetectPrimitivesBuilder
Default values.
Property Value CurvatureSensitivity 20 New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
BlendFactor | Returns the blend factor |
CurvatureSensitivity | Returns or sets the curvature sensitivity |
FacetSelection | Returns the facet selection |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AdjustShapeBoundary | Adjust shape detection result with selectivity angle |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetBlendColor | Returns the blend color @return Array of 3 RGB values, each between 0 and 1 |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetConeColor | Returns the cone color @return Array of 3 RGB values, each between 0 and 1 |
GetCylinderColor | Returns the cylinder color @return Array of 3 RGB values, each between 0 and 1 |
GetObject | Returns the object currently being edited by this builder. |
GetOtherColor | Returns Other type of color. |
GetPlaneColor | Returns the plane color @return Array of 3 RGB values, each between 0 and 1 |
GetSphereColor | Returns the sphere color @return Array of 3 RGB values, each between 0 and 1 |
SetBlendColor | Sets the blend color |
SetConeColor | Sets the cone color |
SetCylinderColor | Sets the cylinder color |
SetOtherColor | Sets the other color |
SetPlaneColor | Sets the plane color |
SetSphereColor | Sets the sphere color |
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. |
Property Detail¶
BlendFactor¶
-
DetectPrimitivesBuilder.
BlendFactor
¶ Returns the blend factor
-------------------------------------
Getter Method
Signature
BlendFactor()
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
CurvatureSensitivity¶
-
DetectPrimitivesBuilder.
CurvatureSensitivity
¶ Returns or sets the curvature sensitivity
-------------------------------------
Getter Method
Signature
CurvatureSensitivity()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurvatureSensitivity(curvatureSensitivity)
Parameters: curvatureSensitivity (int) – New in version NX10.0.0.
License requirements: None.
FacetSelection¶
-
DetectPrimitivesBuilder.
FacetSelection
¶ Returns the facet selection
-------------------------------------
Getter Method
Signature
FacetSelection()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX10.0.0.
License requirements: None.
Method Detail¶
AdjustShapeBoundary¶
-
DetectPrimitivesBuilder.
AdjustShapeBoundary
¶ Adjust shape detection result with selectivity angle
Signature
AdjustShapeBoundary()
New in version NX10.0.0.
License requirements: None.
GetBlendColor¶
-
DetectPrimitivesBuilder.
GetBlendColor
¶ Returns the blend color
Signature
GetBlendColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
GetConeColor¶
-
DetectPrimitivesBuilder.
GetConeColor
¶ Returns the cone color
Signature
GetConeColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
GetCylinderColor¶
-
DetectPrimitivesBuilder.
GetCylinderColor
¶ Returns the cylinder color
Signature
GetCylinderColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
GetOtherColor¶
-
DetectPrimitivesBuilder.
GetOtherColor
¶ Returns Other type of color.
All non-primitive shapes are classfied as Other type
Signature
GetOtherColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
GetPlaneColor¶
-
DetectPrimitivesBuilder.
GetPlaneColor
¶ Returns the plane color
Signature
GetPlaneColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
GetSphereColor¶
-
DetectPrimitivesBuilder.
GetSphereColor
¶ Returns the sphere color
Signature
GetSphereColor()
Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.0.
License requirements: None.
SetBlendColor¶
-
DetectPrimitivesBuilder.
SetBlendColor
¶ Sets the blend color
Signature
SetBlendColor(blendColor)
Parameters: blendColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetConeColor¶
-
DetectPrimitivesBuilder.
SetConeColor
¶ Sets the cone color
Signature
SetConeColor(coneColor)
Parameters: coneColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetCylinderColor¶
-
DetectPrimitivesBuilder.
SetCylinderColor
¶ Sets the cylinder color
Signature
SetCylinderColor(cylinderColor)
Parameters: cylinderColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetOtherColor¶
-
DetectPrimitivesBuilder.
SetOtherColor
¶ Sets the other color
Signature
SetOtherColor(otherColor)
Parameters: otherColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetPlaneColor¶
-
DetectPrimitivesBuilder.
SetPlaneColor
¶ Sets the plane color
Signature
SetPlaneColor(planeColor)
Parameters: planeColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetSphereColor¶
-
DetectPrimitivesBuilder.
SetSphereColor
¶ Sets the sphere color
Signature
SetSphereColor(sphereColor)
Parameters: sphereColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
Validate¶
-
DetectPrimitivesBuilder.
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.