DecimateFacetBodyBuilder Class¶
-
class
NXOpen.Facet.
DecimateFacetBodyBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Facet.DecimateFacetBodyBuilder
.Decimate Body Builder is a function to facilitate the reduction of data by reducing the density of facets while keeping the general shape in tact. Three different methods are provided to reduce the data. To create a new instance of this class, use
NXOpen.Facet.FacetedBodyCollection.CreateDecimateFacetBodyBuilder()
Default values.
Property Value AngleThreshold 15 DecimateMethod ChordalDeviation IsEditCopy 0 IsLockBoundary 0 MinimumArea 1 Percentage 10 Tolerance 0.25 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AngleThreshold | Returns or sets the value indicating maximum angle, where any facets with a larger relative angle are not reduced. |
Bodies | Returns the facet bodies to be decimated. |
DecimateMethod | Returns or sets the decimation method |
FacetBodies | Returns the facet bodies to be decimated |
FacetCollector | Returns or sets a collector of facets on the facet bodies to be decimated. |
IsEditCopy | Returns or sets the value indicating if a copy of the facet body to be decimated without altering the original |
IsLockBoundary | Returns or sets the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact |
MinimumArea | Returns or sets the value indicating area of the smallest facet that is to be retained. |
Percentage | Returns or sets the value indicating percentage by which facet count is to be reduced. |
RegionList | Returns an optional list of regions on the facet bodies to be decimated. |
Tag | Returns the Tag for this object. |
Tolerance | Returns or sets the value indicating maximum chordal deviation from the original facet body. |
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. |
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¶
DecimateFacetBodyBuilderDecimateMethodType Enumeration | Decimate Method |
Property Detail¶
AngleThreshold¶
-
DecimateFacetBodyBuilder.
AngleThreshold
¶ Returns or sets the value indicating maximum angle, where any facets with a larger relative angle are not reduced.
This allows sharp edges to be retained.
-------------------------------------
Getter Method
Signature
AngleThreshold
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleThreshold
Parameters: angleThreshold (float) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Bodies¶
-
DecimateFacetBodyBuilder.
Bodies
¶ Returns the facet bodies to be decimated.
Inputs to this command can be convergent objects.
-------------------------------------
Getter Method
Signature
Bodies
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX11.0.0.
Deprecated since version NX12.0.0: Use
NXOpen.Facet.SubdivideFacetBodyBuilder.FacetCollector()
instead.License requirements: None.
DecimateMethod¶
-
DecimateFacetBodyBuilder.
DecimateMethod
¶ Returns or sets the decimation method
-------------------------------------
Getter Method
Signature
DecimateMethod
Returns: Return type: NXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DecimateMethod
Parameters: decimateMethod ( NXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType
) –New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
FacetBodies¶
-
DecimateFacetBodyBuilder.
FacetBodies
¶ Returns the facet bodies to be decimated
-------------------------------------
Getter Method
Signature
FacetBodies
Returns: Return type: NXOpen.Facet.SelectFacetedBodyList
New in version NX7.5.0.
Deprecated since version NX11.0.0: Use
NXOpen.Facet.DecimateFacetBodyBuilder.Bodies()
instead.License requirements: None.
FacetCollector¶
-
DecimateFacetBodyBuilder.
FacetCollector
¶ Returns or sets a collector of facets on the facet bodies to be decimated.
-------------------------------------
Getter Method
Signature
FacetCollector
Returns: Return type: NXOpen.FacetCollector
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FacetCollector
Parameters: collector ( NXOpen.FacetCollector
) –New in version NX12.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
IsEditCopy¶
-
DecimateFacetBodyBuilder.
IsEditCopy
¶ Returns or sets the value indicating if a copy of the facet body to be decimated without altering the original
-------------------------------------
Getter Method
Signature
IsEditCopy
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsEditCopy
Parameters: isEditCopy (bool) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
IsLockBoundary¶
-
DecimateFacetBodyBuilder.
IsLockBoundary
¶ Returns or sets the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact
-------------------------------------
Getter Method
Signature
IsLockBoundary
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsLockBoundary
Parameters: isLockBoundary (bool) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
MinimumArea¶
-
DecimateFacetBodyBuilder.
MinimumArea
¶ Returns or sets the value indicating area of the smallest facet that is to be retained.
All the facets smaller than the minimum area are removed. This value is used when
NXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType
isNXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType.SmallestFacet
.-------------------------------------
Getter Method
Signature
MinimumArea
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumArea
Parameters: minimumArea (float) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Percentage¶
-
DecimateFacetBodyBuilder.
Percentage
¶ Returns or sets the value indicating percentage by which facet count is to be reduced.
This value is used when
NXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType
isNXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType.Percentage
.-------------------------------------
Getter Method
Signature
Percentage
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Percentage
Parameters: percentage (float) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
RegionList¶
-
DecimateFacetBodyBuilder.
RegionList
¶ Returns an optional list of regions on the facet bodies to be decimated.
-------------------------------------
Getter Method
Signature
RegionList
Returns: Return type: NXOpen.GeometricUtilities.BoundaryDefinitionBuilderList
New in version NX7.5.0.
Deprecated since version NX12.0.0: Use
NXOpen.Facet.SubdivideFacetBodyBuilder.FacetCollector()
instead.License requirements: None.
Tolerance¶
-
DecimateFacetBodyBuilder.
Tolerance
¶ Returns or sets the value indicating maximum chordal deviation from the original facet body.
The value is used when
NXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType
isNXOpen.Facet.DecimateFacetBodyBuilderDecimateMethodType.ChordalDeviation
.-------------------------------------
Getter Method
Signature
Tolerance
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance
Parameters: tolerance (float) – New in version NX7.5.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
Validate¶
-
DecimateFacetBodyBuilder.
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.