NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Facet::DecimateFacetBodyBuilder Class Reference

Represents a NXOpen::Facet::DecimateFacetBodyBuilder . More...

Inheritance diagram for NXOpen::Facet::DecimateFacetBodyBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DecimateMethodType { DecimateMethodTypeChordalDeviation, DecimateMethodTypeSmallestFacet, DecimateMethodTypePercentage }
 Decimate Method. More...
 

Public Member Functions

double AngleThreshold ()
 Returns the value indicating maximum angle, where any facets with a larger relative angle are not reduced. More...
 
NXOpen::SelectDisplayableObjectListBodies ()
 Returns the facet bodies to be decimated. More...
 
NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType DecimateMethod ()
 Returns the decimation method
Created in NX7.5.0. More...
 
NXOpen::Facet::SelectFacetedBodyListFacetBodies ()
 Returns the facet bodies to be decimated
More...
 
NXOpen::FacetCollectorFacetCollector ()
 Returns a collector of facets on the facet bodies to be decimated. More...
 
bool IsEditCopy ()
 Returns the value indicating if a copy of the facet body to be decimated without altering the original
Created in NX7.5.0. More...
 
bool IsLockBoundary ()
 Returns the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact
Created in NX7.5.0. More...
 
double MinimumArea ()
 Returns the value indicating area of the smallest facet that is to be retained. More...
 
double Percentage ()
 Returns the value indicating percentage by which facet count is to be reduced. More...
 
NXOpen::GeometricUtilities::BoundaryDefinitionBuilderListRegionList ()
 Returns an optional list of regions on the facet bodies to be decimated. More...
 
void SetAngleThreshold (double angleThreshold)
 Sets the value indicating maximum angle, where any facets with a larger relative angle are not reduced. More...
 
void SetDecimateMethod (NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType decimateMethod)
 Sets the decimation method
Created in NX7.5.0. More...
 
void SetEditCopy (bool isEditCopy)
 Sets the value indicating if a copy of the facet body to be decimated without altering the original
Created in NX7.5.0. More...
 
void SetFacetCollector (NXOpen::FacetCollector *collector)
 Sets a collector of facets on the facet bodies to be decimated. More...
 
void SetLockBoundary (bool isLockBoundary)
 Sets the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact
Created in NX7.5.0. More...
 
void SetMinimumArea (double minimumArea)
 Sets the value indicating area of the smallest facet that is to be retained. More...
 
void SetPercentage (double percentage)
 Sets the value indicating percentage by which facet count is to be reduced. More...
 
void SetTolerance (double tolerance)
 Sets the value indicating maximum chordal deviation from the original facet body. More...
 
double Tolerance ()
 Returns the value indicating maximum chordal deviation from the original facet body. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX7.5.0.

Member Enumeration Documentation

Decimate Method.

Enumerator
DecimateMethodTypeChordalDeviation 

Chordal deviation reduces the number of facets by removing facets which do not effect the overall accuracy of the mesh.

DecimateMethodTypeSmallestFacet 

Smallest facet removes all facets smaller than the defined area, thus removing facets deemed to be redundant by the designer.

DecimateMethodTypePercentage 

Percentage option allows the user to reduce the facet count by overall percentage.

Member Function Documentation

double NXOpen::Facet::DecimateFacetBodyBuilder::AngleThreshold ( )

Returns the value indicating maximum angle, where any facets with a larger relative angle are not reduced.

This allows sharp edges to be retained.
Created in NX7.5.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Facet::DecimateFacetBodyBuilder::Bodies ( )

Returns the facet bodies to be decimated.

Inputs to this command can be convergent objects.

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::Facet::SubdivideFacetBodyBuilder::FacetCollector instead.


Created in NX11.0.0.

License requirements : None

NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethod ( )

Returns the decimation method
Created in NX7.5.0.



License requirements : None

NXOpen::Facet::SelectFacetedBodyList* NXOpen::Facet::DecimateFacetBodyBuilder::FacetBodies ( )

Returns the facet bodies to be decimated

Deprecated:
Deprecated in NX11.0.0.

Use NXOpen::Facet::DecimateFacetBodyBuilder::Bodies instead.


Created in NX7.5.0.

License requirements : None

NXOpen::FacetCollector* NXOpen::Facet::DecimateFacetBodyBuilder::FacetCollector ( )

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


Created in NX12.0.0.

License requirements : None

bool NXOpen::Facet::DecimateFacetBodyBuilder::IsEditCopy ( )

Returns the value indicating if a copy of the facet body to be decimated without altering the original
Created in NX7.5.0.



License requirements : None

bool NXOpen::Facet::DecimateFacetBodyBuilder::IsLockBoundary ( )

Returns the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact
Created in NX7.5.0.



License requirements : None

double NXOpen::Facet::DecimateFacetBodyBuilder::MinimumArea ( )

Returns 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::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypeSmallestFacet .
Created in NX7.5.0.

License requirements : None

double NXOpen::Facet::DecimateFacetBodyBuilder::Percentage ( )

Returns the value indicating percentage by which facet count is to be reduced.

This value is used when NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypePercentage .
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::BoundaryDefinitionBuilderList* NXOpen::Facet::DecimateFacetBodyBuilder::RegionList ( )

Returns an optional list of regions on the facet bodies to be decimated.


Deprecated:
Deprecated in NX12.0.0. Use NXOpen::Facet::SubdivideFacetBodyBuilder::FacetCollector instead.


Created in NX7.5.0.

License requirements : None

void NXOpen::Facet::DecimateFacetBodyBuilder::SetAngleThreshold ( double  angleThreshold)

Sets the value indicating maximum angle, where any facets with a larger relative angle are not reduced.

This allows sharp edges to be retained.
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
angleThresholdanglethreshold
void NXOpen::Facet::DecimateFacetBodyBuilder::SetDecimateMethod ( NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType  decimateMethod)

Sets the decimation method
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
decimateMethoddecimatemethod
void NXOpen::Facet::DecimateFacetBodyBuilder::SetEditCopy ( bool  isEditCopy)

Sets the value indicating if a copy of the facet body to be decimated without altering the original
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
isEditCopyiseditcopy
void NXOpen::Facet::DecimateFacetBodyBuilder::SetFacetCollector ( NXOpen::FacetCollector collector)

Sets a collector of facets on the facet bodies to be decimated.


Created in NX12.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
collectorcollector
void NXOpen::Facet::DecimateFacetBodyBuilder::SetLockBoundary ( bool  isLockBoundary)

Sets the value indicating if the open edges of inner and outer loops in the facet bodies are to be kept intact
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
isLockBoundaryislockboundary
void NXOpen::Facet::DecimateFacetBodyBuilder::SetMinimumArea ( double  minimumArea)

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::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypeSmallestFacet .
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
minimumAreaminimumarea
void NXOpen::Facet::DecimateFacetBodyBuilder::SetPercentage ( double  percentage)

Sets the value indicating percentage by which facet count is to be reduced.

This value is used when NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypePercentage .
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
percentagepercentage
void NXOpen::Facet::DecimateFacetBodyBuilder::SetTolerance ( double  tolerance)

Sets the value indicating maximum chordal deviation from the original facet body.

The value is used when NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypeChordalDeviation .
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
tolerancetolerance
double NXOpen::Facet::DecimateFacetBodyBuilder::Tolerance ( )

Returns the value indicating maximum chordal deviation from the original facet body.

The value is used when NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodType is NXOpen::Facet::DecimateFacetBodyBuilder::DecimateMethodTypeChordalDeviation .
Created in NX7.5.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.