CleanupFacetBodyBuilder Class

class NXOpen.Facet.CleanupFacetBodyBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Facet.CleanupFacetBodyBuilder builder.

It removes defects that are present in the surfaces of the bodies selected.

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

Default values.

Property	Value
FoldedEdges	Analyze
InconsistentNormals	Analyze
LaminarSlits	Analyze
LongFacets	Analyze
MaxRatioLongFacets	10
MinAngleFoldedFacets	15
OriginalBodyOption	Delete
SelfIntersections	Analyze
ShowInfo	0
ThinFacets	Analyze

New in version NX10.0.0.

Properties

Property	Description
DistanceTolerance	Returns or sets the tolerance value use to detect the faults in facet body and fix the same
FoldedEdges	Returns or sets the option to identify or repair facets having an angle with adjacent facets less than a specified minimum value
InconsistentNormals	Returns or sets the option to identify or repair normals of neighboring facets or vertices that do not have the right orientation
InputBodies	Returns the input facet bodies to be analyzed or repaired
LaminarSlits	Returns or sets the option to identify or repair thin holes or slits in the mesh caused by facets not being aligned
LongFacets	Returns or sets the option to identify or repair facets with a ratio of longest to shortest side exceeding a specified value
MaxRatioLongFacets	Returns or sets the specified value used to define long facets
MinAngleFoldedFacets	Returns or sets the minimum angle between adjacent facets to define folded facets
OriginalBodyOption	Returns or sets the option for handling the input facet bodies
SelfIntersections	Returns or sets the option to identify or repair facets of the same mesh intersecting each other
ShowInfo	Returns or sets the option to display numbers of various type of defects identified or repaired in the NXOpen.ListingWindow.
Tag	Returns the Tag for this object.
ThinFacets	Returns or sets the option to identify or repair facets with with one long edge and two edges with more or the less the same length and a ratio of length to width exceeding a specified value

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.
DisplayCleanupReportInListWindow	Displays the NXOpen.ListingWindow with numbers of various type of defects identified or repaired.
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.
SetAllOptionsToAnalyze	Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.Analyze, which means to identify the defects only for the input bodies
SetAllOptionsToNone	Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.None, which means to do nothing
SetAllOptionsToRepair	Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.Repair, which means to identify as well as repair the defects for the input bodies
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.

Enumerations

CleanupFacetBodyBuilderCleanupOptions Enumeration	These represent the options for each facet defect
CleanupFacetBodyBuilderOriginalBodyOptions Enumeration	These represent the options for handling the input bodies

Property Detail

DistanceTolerance

CleanupFacetBodyBuilder.DistanceTolerance

Returns or sets the tolerance value use to detect the faults in facet body and fix the same

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

Getter Method

Signature DistanceTolerance

Returns: Return type:float

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature DistanceTolerance

Parameters:disTolerance (float) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

FoldedEdges

CleanupFacetBodyBuilder.FoldedEdges

Returns or sets the option to identify or repair facets having an angle with adjacent facets less than a specified minimum value

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

Getter Method

Signature FoldedEdges

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature FoldedEdges

Parameters:foldedEdges (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

InconsistentNormals

CleanupFacetBodyBuilder.InconsistentNormals

Returns or sets the option to identify or repair normals of neighboring facets or vertices that do not have the right orientation

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

Getter Method

Signature InconsistentNormals

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature InconsistentNormals

Parameters:inconsistentNormals (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

InputBodies

CleanupFacetBodyBuilder.InputBodies

Returns the input facet bodies to be analyzed or repaired

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

Getter Method

Signature InputBodies

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX10.0.0.

License requirements: None.

LaminarSlits

CleanupFacetBodyBuilder.LaminarSlits

Returns or sets the option to identify or repair thin holes or slits in the mesh caused by facets not being aligned

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

Getter Method

Signature LaminarSlits

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature LaminarSlits

Parameters:laminarSlits (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

LongFacets

CleanupFacetBodyBuilder.LongFacets

Returns or sets the option to identify or repair facets with a ratio of longest to shortest side exceeding a specified value

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

Getter Method

Signature LongFacets

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature LongFacets

Parameters:longFacets (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

MaxRatioLongFacets

CleanupFacetBodyBuilder.MaxRatioLongFacets

Returns or sets the specified value used to define long facets

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

Getter Method

Signature MaxRatioLongFacets

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature MaxRatioLongFacets

Parameters:maxRatioLongFacets (float) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

MinAngleFoldedFacets

CleanupFacetBodyBuilder.MinAngleFoldedFacets

Returns or sets the minimum angle between adjacent facets to define folded facets

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

Getter Method

Signature MinAngleFoldedFacets

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature MinAngleFoldedFacets

Parameters:minAngleFoldedFacets (float) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

OriginalBodyOption

CleanupFacetBodyBuilder.OriginalBodyOption

Returns or sets the option for handling the input facet bodies

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

Getter Method

Signature OriginalBodyOption

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderOriginalBodyOptions

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature OriginalBodyOption

Parameters:enumOriginalBodyOption (NXOpen.Facet.CleanupFacetBodyBuilderOriginalBodyOptions) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SelfIntersections

CleanupFacetBodyBuilder.SelfIntersections

Returns or sets the option to identify or repair facets of the same mesh intersecting each other

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

Getter Method

Signature SelfIntersections

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature SelfIntersections

Parameters:selfIntersections (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ShowInfo

CleanupFacetBodyBuilder.ShowInfo

Returns or sets the option to display numbers of various type of defects identified or repaired in the NXOpen.ListingWindow.

If this option is true, but the program is running externally without UI, display would go to a standard output devicethe. The listing window output can be sent to the Information window or to a file, or to both. See NXOpen.ListingWindow.SelectDevice() for more information.

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

Getter Method

Signature ShowInfo

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ShowInfo

Parameters:showInfo (bool) –

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ThinFacets

CleanupFacetBodyBuilder.ThinFacets

Returns or sets the option to identify or repair facets with with one long edge and two edges with more or the less the same length and a ratio of length to width exceeding a specified value

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

Getter Method

Signature ThinFacets

Returns: Return type:NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ThinFacets

Parameters:thinFacets (NXOpen.Facet.CleanupFacetBodyBuilderCleanupOptions) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Method Detail

DisplayCleanupReportInListWindow

CleanupFacetBodyBuilder.DisplayCleanupReportInListWindow

Displays the NXOpen.ListingWindow with numbers of various type of defects identified or repaired.

If we call this method externally without UI, it displays the information on standard output device. The listing window output can be sent to the Information window or to a file, or to both. See NXOpen.ListingWindow.SelectDevice() for more information.

Signature DisplayCleanupReportInListWindow()

New in version NX11.0.0.

License requirements: None.

SetAllOptionsToAnalyze

CleanupFacetBodyBuilder.SetAllOptionsToAnalyze

Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.Analyze, which means to identify the defects only for the input bodies

Signature SetAllOptionsToAnalyze()

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SetAllOptionsToNone

CleanupFacetBodyBuilder.SetAllOptionsToNone

Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.None, which means to do nothing

Signature SetAllOptionsToNone()

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SetAllOptionsToRepair

CleanupFacetBodyBuilder.SetAllOptionsToRepair

Sets all cleanup options to Facet.CleanupFacetBodyBuilderCleanupOptions.Repair, which means to identify as well as repair the defects for the input bodies

Signature SetAllOptionsToRepair()

New in version NX10.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Validate

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