ColorCodedRegionBuilder Class

class NXOpen.GeometricUtilities.ColorCodedRegionBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.GeometricUtilities.ColorCodedRegionBuilder.

The Color Coded Region block allows the user to select color coded regions of facet bodies . .. versionadded:: NX10.0.0

Properties

Property Description
AllSameColor Returns or sets the option to select all regions of the same color
Tag Returns the Tag for this object.

Methods

Method Description
BuildBodyColoredRegion Build Colored Region.
BuildColoredRegion Build Colored Region.
DeselectColoredRegion Deselect Colored Region
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AllSameColor

ColorCodedRegionBuilder.AllSameColor

Returns or sets the option to select all regions of the same color

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

Getter Method

Signature AllSameColor

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature AllSameColor

Parameters:allSameColor (bool) –

New in version NX10.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

Method Detail

BuildBodyColoredRegion

ColorCodedRegionBuilder.BuildBodyColoredRegion

Build Colored Region.

Inputs to this command can be convergent objects.

Signature BuildBodyColoredRegion(body, facetId, localVertexId)

Parameters:
  • body (NXOpen.DisplayableObject) – target body
  • facetId (int) – picked facet ID
  • localVertexId (int) – loccal vertex id of the triangle

New in version NX11.0.0.

License requirements: None.

BuildColoredRegion

ColorCodedRegionBuilder.BuildColoredRegion

Build Colored Region.

Signature BuildColoredRegion(facetBody, facetId, localVertexId)

Parameters:
  • facetBody (NXOpen.Facet.FacetedBody) – target facet body
  • facetId (int) – picked facet ID
  • localVertexId (int) – loccal vertex id of the triangle

New in version NX10.0.0.

Deprecated since version NX11.0.0: Use NXOpen.GeometricUtilities.ColorCodedRegionBuilder.BuildBodyColoredRegion() instead.

License requirements: None.

DeselectColoredRegion

ColorCodedRegionBuilder.DeselectColoredRegion

Deselect Colored Region

Signature DeselectColoredRegion(objIndex)

Parameters:objIndex (int) – colored object to be deselected

New in version NX10.0.0.

License requirements: None.

Validate

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