PaintFacetBodyBuilder Class

class NXOpen.Facet.PaintFacetBodyBuilder

Bases: NXOpen.Builder

This class manages the color painting on a facet body.

To create a new instance of this class, use NXOpen.Facet.FacetModelingCollection.CreatePaintFacetBodyBuilder()

Default values.

Property	Value
PaintBrushSize.Value (deprecated)	20.0 (millimeters part), 1.0 (inches part)

New in version NX10.0.0.

Properties

Property	Description
FacetCollector	Returns a collector of facets on the facet bodies to be to be tested.
InheritBodyColorPick	Returns the inherit color pick.
InheritColorPick	Returns the inherit color pick
PaintBrush	Returns the paint brush
PaintBrushSize	Returns the paint brush size
Tag	Returns the Tag for this object.

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.
GetPaintBrushColor	Returns the paint brush color
PaintBodiesBackgroundColor	Paints facets background color.
PaintFacetsBackGroundColor	Paints facets background color
PaintSelectedFacets	Paints selected facets.
SetPaintBrushColor	Sets the paint brush color
SetupBodyColorData	Setup color data.
SetupColorData	Setup color data
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

FacetCollector

PaintFacetBodyBuilder.FacetCollector

Returns a collector of facets on the facet bodies to be to be tested.

-------------------------------------

Getter Method

Signature FacetCollector

Returns: Return type:NXOpen.FacetCollector

New in version NX12.0.0.

License requirements: None.

InheritBodyColorPick

PaintFacetBodyBuilder.InheritBodyColorPick

Returns the inherit color pick.

Inputs to this command can be convergent objects.

-------------------------------------

Getter Method

Signature InheritBodyColorPick

Returns: Return type:NXOpen.SelectDisplayableObject

New in version NX11.0.0.

License requirements: None.

InheritColorPick

PaintFacetBodyBuilder.InheritColorPick

Returns the inherit color pick

-------------------------------------

Getter Method

Signature InheritColorPick

Returns: Return type:NXOpen.Facet.SelectFacetedBody

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Facet.PaintFacetBodyBuilder.InheritBodyColorPick() instead.

License requirements: None.

PaintBrush

PaintFacetBodyBuilder.PaintBrush

Returns the paint brush

-------------------------------------

Getter Method

Signature PaintBrush

Returns: Return type:NXOpen.Facet.PaintBrushBuilder

New in version NX10.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Facet.PaintFacetBodyBuilder.FacetCollector() instead.

License requirements: None.

PaintBrushSize

PaintFacetBodyBuilder.PaintBrushSize

Returns the paint brush size

-------------------------------------

Getter Method

Signature PaintBrushSize

Returns: Return type:NXOpen.Expression

New in version NX10.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Facet.PaintFacetBodyBuilder.FacetCollector() instead.

License requirements: None.

Method Detail

GetPaintBrushColor

PaintFacetBodyBuilder.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.

PaintBodiesBackgroundColor

PaintFacetBodyBuilder.PaintBodiesBackgroundColor

Paints facets background color.

Inputs to this command can be convergent objects.

Signature PaintBodiesBackgroundColor(bodies)

Parameters:bodies (list of NXOpen.DisplayableObject) – Bodies to be painted with background color

New in version NX11.0.0.

License requirements: None.

PaintFacetsBackGroundColor

PaintFacetBodyBuilder.PaintFacetsBackGroundColor

Paints facets background color

Signature PaintFacetsBackGroundColor(facets)

Parameters:facets (list of NXOpen.Facet.FacetedBody) – Facets to be painted with background color

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Facet.PaintFacetBodyBuilder.PaintBodiesBackgroundColor() instead.

License requirements: None.

PaintSelectedFacets

PaintFacetBodyBuilder.PaintSelectedFacets

Paints selected facets.

Signature PaintSelectedFacets()

New in version NX12.0.0.

License requirements: None.

SetPaintBrushColor

PaintFacetBodyBuilder.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.

SetupBodyColorData

PaintFacetBodyBuilder.SetupBodyColorData

Setup color data.

Inputs to this command can be convergent objects.

Signature SetupBodyColorData(bodies)

Parameters:bodies (list of NXOpen.DisplayableObject) – Bodies that need color data for edit

New in version NX11.0.0.

License requirements: None.

SetupColorData

PaintFacetBodyBuilder.SetupColorData

Setup color data

Signature SetupColorData(facets)

Parameters:facets (list of NXOpen.Facet.FacetedBody) – Facets that need color data for edit

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Facet.PaintFacetBodyBuilder.SetupBodyColorData() instead.

License requirements: None.

Validate

PaintFacetBodyBuilder.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.