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

Represents a collection of faceted bodies in a part
To obtain an instance of this class, refer to NXOpen::Part

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Facet::FacetedBodyCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Types

enum  Type { TypeNx, TypeJt }
 Specifies the type of facets created when copying or converting faceted bodies. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
void Convert (NXOpen::Facet::FacetedBody *fromBody, NXOpen::Facet::FacetedBodyCollection::Type toFacetType)
 Converts the internal representation of this faceted body to the specified type. More...
 
NXOpen::Facet::FacetedBodyCopy (NXOpen::Facet::FacetedBody *fromBody, NXOpen::Part *toPart, NXOpen::Facet::FacetedBodyCollection::Type toFacetType)
 Copies a faceted body and optionally changes the internal representation to the given type (This is only valid for JT to NX copy) More...
 
NXOpen::Facet::BestFitAlignBuilderCreateBestFitAlignBuilder ()
 Creates a NXOpen::Facet::BestFitAlignBuilder. More...
 
NXOpen::Facet::BridgeFacetBodyBuilderCreateBridgeFacetBodyBuilder ()
 Creates a NXOpen::Facet::BridgeFacetBodyBuilder. More...
 
NXOpen::Facet::DecimateFacetBodyBuilderCreateDecimateFacetBodyBuilder ()
 Creates a NXOpen::Facet::DecimateFacetBodyBuilder. More...
 
NXOpen::Facet::ExtrudeFacetBodyBuilderCreateExtrudeFacetBodyBuilder ()
 Creates a NXOpen::Facet::ExtrudeFacetBodyBuilder. More...
 
NXOpen::Facet::ExtrudeProfileBuilderCreateExtrudeProfileBuilder ()
 Creates a NXOpen::Facet::ExtrudeProfileBuilder. More...
 
void CreateFacetBody (const std::vector< NXOpen::Body * > &solidBodies, std::vector< NXOpen::Facet::FacetedBody * > &facetBodies, std::vector< int > &errorTable)
 Creates a JT NXOpen::Facet::FacetedBody using the default faceting tolerances. More...
 
void CreateFacetBodyFromFaces (const std::vector< NXOpen::Face * > &solidFaces, std::vector< NXOpen::Facet::FacetedBody * > &facetBodies, std::vector< int > &errorTable)
 Creates a JT NXOpen::Facet::FacetedBody using the default faceting tolerances. More...
 
NXOpen::Facet::CurvatureBuilderCreateFacetCurvatureBuilder ()
 Create a NXOpen::Facet::CurvatureBuilder object. More...
 
NXOpen::Facet::FeatureExtractionBuilderCreateFacetFeatureExtractionBuilder ()
 Create a NXOpen::Facet::FeatureExtractionBuilder object. More...
 
NXOpen::Facet::FillHoleBuilderCreateFillHoleBuilder ()
 Creates a NXOpen::Facet::FillHoleBuilder. More...
 
NXOpen::Facet::MergeFacetBodyBuilderCreateMergeFacetBodyBuilder ()
 Creates a NXOpen::Facet::MergeFacetBodyBuilder. More...
 
NXOpen::Facet::MultiPatchAlignmentBuilderCreateMultiPatchAlignmentBuilder ()
 Creates a NXOpen::Facet::MultiPatchAlignmentBuilder. More...
 
NXOpen::Facet::SewFacetBodyBuilderCreateSewFacetBodyBuilder ()
 Creates a NXOpen::Facet::SewFacetBodyBuilder. More...
 
NXOpen::Facet::SmoothFacetBodyBuilderCreateSmoothFacetBodyBuilder ()
 Creates a NXOpen::Facet::SmoothFacetBodyBuilder. More...
 
NXOpen::Facet::SnipFacetBodyBuilderCreateSnipFacetBodyBuilder ()
 Creates a NXOpen::Facet::SnipFacetBodyBuilder. More...
 
NXOpen::Facet::STLImportBuilderCreateSTLImportBuilder ()
 Creates a NXOpen::Facet::STLImportBuilder. More...
 
NXOpen::Facet::SubdivideFacetBodyBuilderCreateSubdivideFacetBodyBuilder ()
 Creates a NXOpen::Facet::SubdivideFacetBodyBuilder. More...
 
void DeleteTemporaryFacesAndEdges ()
 Delete any temporary faces and edges on faceted bodies that may have been created in the specified part. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Facet::FacetModelingCollectionFacetModelingCollection ()
 Returns the FacetModelingCollection instance belonging to this part
Created in NX10.0.0. More...
 
NXOpen::Facet::FacetedBodyFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Facet::FacetedBody with the given identifier as recorded in a journal. More...
 
NXOpen::Facet::FacetedBodyFindObject (const char *journalIdentifier)
 Finds the NXOpen::Facet::FacetedBody with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::Facet::FacetedBody * > 
GetAssociatedFacetedBodies (NXOpen::Body *solidBody, int *numberOfUnloadedFacetedBodies)
 Returns the loaded solid bodies associated with the argument faceted body. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of faceted bodies in a part
To obtain an instance of this class, refer to NXOpen::Part

Created in NX5.0.0.


Member Enumeration Documentation

Specifies the type of facets created when copying or converting faceted bodies.

Enumerator
TypeNx 

NX facet.

TypeJt 

JT facet.

Member Function Documentation

iterator NXOpen::Facet::FacetedBodyCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::Facet::FacetedBodyCollection::Convert ( NXOpen::Facet::FacetedBody fromBody,
NXOpen::Facet::FacetedBodyCollection::Type  toFacetType 
)

Converts the internal representation of this faceted body to the specified type.

This does not create a new body
Created in NX5.0.0.

License requirements : None

Parameters
fromBodyThe faceted body to convert
toFacetTypeTo facet type
NXOpen::Facet::FacetedBody* NXOpen::Facet::FacetedBodyCollection::Copy ( NXOpen::Facet::FacetedBody fromBody,
NXOpen::Part toPart,
NXOpen::Facet::FacetedBodyCollection::Type  toFacetType 
)

Copies a faceted body and optionally changes the internal representation to the given type (This is only valid for JT to NX copy)

Returns
New body
Created in NX5.0.0.

License requirements : None
Parameters
fromBodyThe faceted body to copy
toPartPart to create the copy in
toFacetTypeTo facet type
NXOpen::Facet::BestFitAlignBuilder* NXOpen::Facet::FacetedBodyCollection::CreateBestFitAlignBuilder ( )

Creates a NXOpen::Facet::BestFitAlignBuilder.

Returns

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR nx_freeform_1 ("basic freeform modeling")
NXOpen::Facet::BridgeFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateBridgeFacetBodyBuilder ( )

Creates a NXOpen::Facet::BridgeFacetBodyBuilder.

Returns

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM") OR die_engineering ("DIE ENGINEERING")
NXOpen::Facet::DecimateFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateDecimateFacetBodyBuilder ( )

Creates a NXOpen::Facet::DecimateFacetBodyBuilder.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
NXOpen::Facet::ExtrudeFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateExtrudeFacetBodyBuilder ( )

Creates a NXOpen::Facet::ExtrudeFacetBodyBuilder.

Returns

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM") OR die_engineering ("DIE ENGINEERING")
NXOpen::Facet::ExtrudeProfileBuilder* NXOpen::Facet::FacetedBodyCollection::CreateExtrudeProfileBuilder ( )

Creates a NXOpen::Facet::ExtrudeProfileBuilder.

Returns

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM") OR die_engineering ("DIE ENGINEERING")
void NXOpen::Facet::FacetedBodyCollection::CreateFacetBody ( const std::vector< NXOpen::Body * > &  solidBodies,
std::vector< NXOpen::Facet::FacetedBody * > &  facetBodies,
std::vector< int > &  errorTable 
)

Creates a JT NXOpen::Facet::FacetedBody using the default faceting tolerances.

The output facetBodies and errorTable arrays are the same size as the input nSolidBodies. The errorTable array provides information about any errors encountered when faceting bodies. Note that it is possible that faceted bodies with 0 facets are created (and returned in the facetBodies parameter). For this case, the errorTable will contain the UF_FACET_err_zero_facets_produced error. If there is an existing facet body it will get refaceted with the previous tolerance used to tessellate it . See NXOpen::Body::GetFacetedBody for ways to check for this situation.


Created in NX7.5.5.

License requirements : adv_assemblies ("ADVANCED ASSEMBLIES")

Parameters
solidBodiessolidbodies
facetBodiesfacetbodies
errorTableerrortable
void NXOpen::Facet::FacetedBodyCollection::CreateFacetBodyFromFaces ( const std::vector< NXOpen::Face * > &  solidFaces,
std::vector< NXOpen::Facet::FacetedBody * > &  facetBodies,
std::vector< int > &  errorTable 
)

Creates a JT NXOpen::Facet::FacetedBody using the default faceting tolerances.

The output facetBodies and errorTable arrays are the same size as the input nSolidFaces. The errorTable array provides information about any errors encountered when faceting bodies. Note that it is possible that faceted bodies with 0 facets are created (and returned in the facetBodies parameter). For this case, the errorTable will contain the UF_FACET_err_zero_facets_produced error. If there is an existing facet body it will get refaceted with the previous tolerance used to tessellate it . See NXOpen::Body::GetFacetedBody for ways to check for this situation.


Created in NX8.5.0.

License requirements : adv_assemblies ("ADVANCED ASSEMBLIES")

Parameters
solidFacessolidfaces
facetBodiesfacetbodies
errorTableerrortable
NXOpen::Facet::CurvatureBuilder* NXOpen::Facet::FacetedBodyCollection::CreateFacetCurvatureBuilder ( )

Create a NXOpen::Facet::CurvatureBuilder object.

Returns

Created in NX5.0.0.

License requirements : None
NXOpen::Facet::FeatureExtractionBuilder* NXOpen::Facet::FacetedBodyCollection::CreateFacetFeatureExtractionBuilder ( )

Create a NXOpen::Facet::FeatureExtractionBuilder object.

Returns

Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
NXOpen::Facet::FillHoleBuilder* NXOpen::Facet::FacetedBodyCollection::CreateFillHoleBuilder ( )

Creates a NXOpen::Facet::FillHoleBuilder.

Returns

Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
NXOpen::Facet::MergeFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateMergeFacetBodyBuilder ( )

Creates a NXOpen::Facet::MergeFacetBodyBuilder.

Returns

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM") OR die_engineering ("DIE ENGINEERING")
NXOpen::Facet::MultiPatchAlignmentBuilder* NXOpen::Facet::FacetedBodyCollection::CreateMultiPatchAlignmentBuilder ( )

Creates a NXOpen::Facet::MultiPatchAlignmentBuilder.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
NXOpen::Facet::SewFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateSewFacetBodyBuilder ( )

Creates a NXOpen::Facet::SewFacetBodyBuilder.

Returns

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM") OR die_engineering ("DIE ENGINEERING")
NXOpen::Facet::SmoothFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateSmoothFacetBodyBuilder ( )

Creates a NXOpen::Facet::SmoothFacetBodyBuilder.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
NXOpen::Facet::SnipFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateSnipFacetBodyBuilder ( )

Creates a NXOpen::Facet::SnipFacetBodyBuilder.

Returns

Created in NX6.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
NXOpen::Facet::STLImportBuilder* NXOpen::Facet::FacetedBodyCollection::CreateSTLImportBuilder ( )

Creates a NXOpen::Facet::STLImportBuilder.

Returns

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR nx_freeform_1 ("basic freeform modeling")
NXOpen::Facet::SubdivideFacetBodyBuilder* NXOpen::Facet::FacetedBodyCollection::CreateSubdivideFacetBodyBuilder ( )

Creates a NXOpen::Facet::SubdivideFacetBodyBuilder.

Returns

Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")
void NXOpen::Facet::FacetedBodyCollection::DeleteTemporaryFacesAndEdges ( )

Delete any temporary faces and edges on faceted bodies that may have been created in the specified part.

Please note that this call will invoke an Update operation.


Created in NX5.0.2.

License requirements : None

iterator NXOpen::Facet::FacetedBodyCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Facet::FacetModelingCollection* NXOpen::Facet::FacetedBodyCollection::FacetModelingCollection ( )

Returns the FacetModelingCollection instance belonging to this part
Created in NX10.0.0.


NXOpen::Facet::FacetedBody* NXOpen::Facet::FacetedBodyCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Facet::FacetedBody with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Faceted body with this identifier
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the faceted body you want
NXOpen::Facet::FacetedBody* NXOpen::Facet::FacetedBodyCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Facet::FacetedBody with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Faceted body with this identifier
Created in NX5.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the faceted body you want
std::vector<NXOpen::Facet::FacetedBody *> NXOpen::Facet::FacetedBodyCollection::GetAssociatedFacetedBodies ( NXOpen::Body solidBody,
int *  numberOfUnloadedFacetedBodies 
)

Returns the loaded solid bodies associated with the argument faceted body.

Also returns the number of unloaded associated faceted bodies.

Returns
Array of loaded associated faceted bodies
Created in NX5.0.0.

License requirements : None
Parameters
solidBodyThe body for which to get associated faceted bodies
numberOfUnloadedFacetedBodiesThe number of unloaded associated faceted bodies for this solids body
tag_t NXOpen::Facet::FacetedBodyCollection::Tag ( ) const

Returns the tag of this object.


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