PaintBrushBuilder Class¶
-
class
NXOpen.Facet.
PaintBrushBuilder
¶ Bases:
NXOpen.Builder
This class manages the paint brush utility for a facet body.
To create a new instance of this class, use
NXOpen.Facet.FacetModelingCollection.CreatePaintFacetBodyBuilder
New in version NX10.0.0.
Methods¶
Method | Description |
---|---|
ClearThePaintPath | Clears the paint path |
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. |
GetPaintBrushColor | Returns the paint brush color @return Array of 3 RGB values, each between 0 and 1 |
PaintVertexColor | Paints facet body vertex color |
SetFacetBeingPainted | Sets facet body being painted |
SetPaintBrushColor | Sets the paint brush color |
SetTemporaryFacetDisplay | Flag to use temporary facet display |
SetupPaintFacetBody | Setup the paint facet body |
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. |
Method Detail¶
ClearThePaintPath¶
-
PaintBrushBuilder.
ClearThePaintPath
¶ Clears the paint path
Signature
ClearThePaintPath()
New in version NX10.0.0.
License requirements: None.
GetPaintBrushColor¶
-
PaintBrushBuilder.
GetPaintBrushColor
¶ Returns the paint brush color
Signature
GetPaintBrushColor()
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.
PaintVertexColor¶
-
PaintBrushBuilder.
PaintVertexColor
¶ Paints facet body vertex color
Signature
PaintVertexColor(position)
Parameters: position ( NXOpen.Point3d
) – Vertex positionNew in version NX10.0.0.
License requirements: None.
SetFacetBeingPainted¶
-
PaintBrushBuilder.
SetFacetBeingPainted
¶ Sets facet body being painted
Signature
SetFacetBeingPainted(facet)
Parameters: facet ( NXOpen.Facet.FacetedBody
) – Facet body being painted.New in version NX10.0.0.
License requirements: None.
SetPaintBrushColor¶
-
PaintBrushBuilder.
SetPaintBrushColor
¶ Sets the paint brush color
Signature
SetPaintBrushColor(paintBrushColor)
Parameters: paintBrushColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.0.
License requirements: None.
SetTemporaryFacetDisplay¶
-
PaintBrushBuilder.
SetTemporaryFacetDisplay
¶ Flag to use temporary facet display
Signature
SetTemporaryFacetDisplay(tempDisplay)
Parameters: tempDisplay (bool) – Temporary display flag New in version NX10.0.0.
License requirements: None.
SetupPaintFacetBody¶
-
PaintBrushBuilder.
SetupPaintFacetBody
¶ Setup the paint facet body
Signature
SetupPaintFacetBody()
New in version NX10.0.0.
License requirements: None.
Validate¶
-
PaintBrushBuilder.
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.