NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::FaceRecognitionBuilder Class Reference

Represents a collection of faces and their relationships to other faces in the model
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Features::FaceRecognitionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool CoaxialEnabled ()
 Returns a value that indicates whether coaxial relation recognition is enabled
Created in NX6.0.0. More...
 
bool CoplanarAxesEnabled ()
 Returns a value that indicates whether coplanar axes relation recognition is enabled
Created in NX6.0.0. More...
 
bool CoplanarEnabled ()
 Returns a value that indicates whether coplanar relation recognition is enabled
Created in NX6.0.0. More...
 
void DeleteConstraint (NXOpen::Features::Feature *feature)
 Deletes the persistent constraint
Created in NX7.0.0. More...
 
void DeleteOffsetRelation (const std::vector< NXOpen::NXObject * > &offsetFaces)
 Deletes the offset relation
Created in NX7.0.0. More...
 
void DeselectEntities (const std::vector< NXOpen::NXObject * > &entities)
 Removes entities from collector
Created in NX6.0.0. More...
 
bool EqualDiameterEnabled ()
 Returns a value that indicates whether equal diameter recognition is enabled
Created in NX6.0.0. More...
 
NXOpen::ScCollectorFaceCollector ()
 Returns the face collector
Created in NX6.0.0. More...
 
void LockConstraint (NXOpen::Features::Feature *feature)
 Locks the persistent constraint
Created in NX7.0.0. More...
 
bool OffsetEnabled ()
 Returns a value that indicates whether symmetric relation recognition is enabled
Created in NX7.0.0. More...
 
bool ParallelEnabled ()
 Returns a value that indicates whether parallel relation recognition is enabled
Created in NX6.0.0. More...
 
bool PerpendicularEnabled ()
 Returns a value that indicates whether perpendicular relation recognition is enabled
Created in NX6.0.0. More...
 
void RecognizeCoaxial (bool isNear)
 Recognizes coaxial relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeCoplanar (bool isNear)
 Recognizes coplanar relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeCoplanarAxes (bool isNear)
 Recognizes coplanar axes relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeEqualDiameter (bool isNear)
 Recognizes equal diameter relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeOffset (bool isNear)
 Recognizes offset relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeParallel (bool isNear)
 Recognizes parallel relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizePerpendicular (bool isNear)
 Recognizes perpendicular relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeSymmetric (bool isNear)
 Recognizes symmetric relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeTangent (bool isNear)
 Recognizes tangent relations to last faces added to face collector
Created in NX6.0.0. More...
 
void RecognizeThicknessChain (bool isNear)
 Recognizes thickness chain relations to last faces added to face collector
Created in NX7.0.0. More...
 
NXOpen::GeometricUtilities::OrientXpressBuilderReferenceCoordinateSystem ()
 Returns the reference coordinate system to use for symmetry and coplanar axis recognition
Created in NX6.0.0. More...
 
int RelationScope ()
 Returns a value that indicates what kind of relations are needed to recognize
Created in NX7.5.0. More...
 
void ReplaceRules (const std::vector< NXOpen::SelectionIntentRule * > &rules, bool createRulesWoUpdate)
 Replace collector rules. More...
 
void SelectEntities (const std::vector< NXOpen::NXObject * > &entities)
 Adds entities to collector
Created in NX6.0.0. More...
 
void SetCoaxialEnabled (bool coaxialEnabled)
 Sets a value that indicates whether coaxial relation recognition is enabled
Created in NX6.0.0. More...
 
void SetCoplanarAxesEnabled (bool coplanarEnabled)
 Sets a value that indicates whether coplanar axes relation recognition is enabled
Created in NX6.0.0. More...
 
void SetCoplanarEnabled (bool coplanarEnabled)
 Sets a value that indicates whether coplanar relation recognition is enabled
Created in NX6.0.0. More...
 
void SetEqualDiameterEnabled (bool equalDiameterEnabled)
 Sets a value that indicates whether equal diameter recognition is enabled
Created in NX6.0.0. More...
 
void SetOffsetEnabled (bool offsetEnabled)
 Sets a value that indicates whether symmetric relation recognition is enabled
Created in NX7.0.0. More...
 
void SetParallelEnabled (bool parallelEnabled)
 Sets a value that indicates whether parallel relation recognition is enabled
Created in NX6.0.0. More...
 
void SetPerpendicularEnabled (bool perpendicularEnabled)
 Sets a value that indicates whether perpendicular relation recognition is enabled
Created in NX6.0.0. More...
 
void SetRelationScope (int relationScope)
 Sets a value that indicates what kind of relations are needed to recognize
Created in NX7.5.0. More...
 
void SetSymmetricEnabled (bool symmetricEnabled)
 Sets a value that indicates whether symmetric relation recognition is enabled
Created in NX6.0.0. More...
 
void SetTangentEnabled (bool tangentEnabled)
 Sets a value that indicates whether tangent relation recognition is enabled
Created in NX6.0.0. More...
 
void SetThicknessChainEnabled (bool thicknessChainEnabled)
 Sets a value that indicates whether thickness chain relation recognition is enabled
Created in NX7.0.0. More...
 
void SetUseFaceBrowse (bool useFaceBrowse)
 Sets a value that indicates whether relations are found when faces are added to the face collector
Created in NX6.0.0. More...
 
bool SymmetricEnabled ()
 Returns a value that indicates whether symmetric relation recognition is enabled
Created in NX6.0.0. More...
 
bool TangentEnabled ()
 Returns a value that indicates whether tangent relation recognition is enabled
Created in NX6.0.0. More...
 
bool ThicknessChainEnabled ()
 Returns a value that indicates whether thickness chain relation recognition is enabled
Created in NX7.0.0. More...
 
void UnlockConstraint (NXOpen::Features::Feature *feature)
 Unlocks the persistent constraint
Created in NX7.0.0. More...
 
void UnrecognizeCoaxial (bool isNear)
 Removes coaxial relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeCoplanar (bool isNear)
 Removes coplanar relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeCoplanarAxes (bool isNear)
 Removes coplanar axes relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeEqualDiameter (bool isNear)
 Removes equal diameter relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeOffset (bool isNear)
 Removes offset relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeParallel (bool isNear)
 Removes parallel relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizePerpendicular (bool isNear)
 Removes perpendicular relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeSymmetric (bool isNear)
 Removes symmetric relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeTangent (bool isNear)
 Removes tangent relations to last faces added to face collector
Created in NX6.0.0. More...
 
void UnrecognizeThicknessChain (bool isNear)
 Removes thickness chain relations to last faces added to face collector
Created in NX7.0.0. More...
 
bool UseFaceBrowse ()
 Returns a value that indicates whether relations are found when faces are added to the face collector
Created in NX6.0.0. 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 collection of faces and their relationships to other faces in the model
Created in NX6.0.0.


Member Function Documentation

bool NXOpen::Features::FaceRecognitionBuilder::CoaxialEnabled ( )

Returns a value that indicates whether coaxial relation recognition is enabled
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::CoplanarAxesEnabled ( )

Returns a value that indicates whether coplanar axes relation recognition is enabled
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::CoplanarEnabled ( )

Returns a value that indicates whether coplanar relation recognition is enabled
Created in NX6.0.0.



License requirements : None

void NXOpen::Features::FaceRecognitionBuilder::DeleteConstraint ( NXOpen::Features::Feature feature)

Deletes the persistent constraint
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
featurethe persistent constraint feature
void NXOpen::Features::FaceRecognitionBuilder::DeleteOffsetRelation ( const std::vector< NXOpen::NXObject * > &  offsetFaces)

Deletes the offset relation
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
offsetFacesoffsetfaces
void NXOpen::Features::FaceRecognitionBuilder::DeselectEntities ( const std::vector< NXOpen::NXObject * > &  entities)

Removes entities from collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
entitiesentities
bool NXOpen::Features::FaceRecognitionBuilder::EqualDiameterEnabled ( )

Returns a value that indicates whether equal diameter recognition is enabled
Created in NX6.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::Features::FaceRecognitionBuilder::FaceCollector ( )

Returns the face collector
Created in NX6.0.0.



License requirements : None

void NXOpen::Features::FaceRecognitionBuilder::LockConstraint ( NXOpen::Features::Feature feature)

Locks the persistent constraint
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
featurethe persistent constraint feature
bool NXOpen::Features::FaceRecognitionBuilder::OffsetEnabled ( )

Returns a value that indicates whether symmetric relation recognition is enabled
Created in NX7.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::ParallelEnabled ( )

Returns a value that indicates whether parallel relation recognition is enabled
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::PerpendicularEnabled ( )

Returns a value that indicates whether perpendicular relation recognition is enabled
Created in NX6.0.0.



License requirements : None

void NXOpen::Features::FaceRecognitionBuilder::RecognizeCoaxial ( bool  isNear)

Recognizes coaxial relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeCoplanar ( bool  isNear)

Recognizes coplanar relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeCoplanarAxes ( bool  isNear)

Recognizes coplanar axes relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeEqualDiameter ( bool  isNear)

Recognizes equal diameter relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeOffset ( bool  isNear)

Recognizes offset relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeParallel ( bool  isNear)

Recognizes parallel relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizePerpendicular ( bool  isNear)

Recognizes perpendicular relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeSymmetric ( bool  isNear)

Recognizes symmetric relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeTangent ( bool  isNear)

Recognizes tangent relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::RecognizeThicknessChain ( bool  isNear)

Recognizes thickness chain relations to last faces added to face collector
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
NXOpen::GeometricUtilities::OrientXpressBuilder* NXOpen::Features::FaceRecognitionBuilder::ReferenceCoordinateSystem ( )

Returns the reference coordinate system to use for symmetry and coplanar axis recognition
Created in NX6.0.0.



License requirements : None

int NXOpen::Features::FaceRecognitionBuilder::RelationScope ( )

Returns a value that indicates what kind of relations are needed to recognize
Created in NX7.5.0.



License requirements : None

void NXOpen::Features::FaceRecognitionBuilder::ReplaceRules ( const std::vector< NXOpen::SelectionIntentRule * > &  rules,
bool  createRulesWoUpdate 
)

Replace collector rules.


Created in NX7.0.0.

License requirements : gateway ("UG GATEWAY")

Parameters
rulesSelection intent rules. To create selection intent rules see documentation of ScRuleFactory for more details.
createRulesWoUpdateFlag to tell whether rules should be created wo_update
void NXOpen::Features::FaceRecognitionBuilder::SelectEntities ( const std::vector< NXOpen::NXObject * > &  entities)

Adds entities to collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
entitiesentities
void NXOpen::Features::FaceRecognitionBuilder::SetCoaxialEnabled ( bool  coaxialEnabled)

Sets a value that indicates whether coaxial relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
coaxialEnabledcoaxialenabled
void NXOpen::Features::FaceRecognitionBuilder::SetCoplanarAxesEnabled ( bool  coplanarEnabled)

Sets a value that indicates whether coplanar axes relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
coplanarEnabledcoplanarenabled
void NXOpen::Features::FaceRecognitionBuilder::SetCoplanarEnabled ( bool  coplanarEnabled)

Sets a value that indicates whether coplanar relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
coplanarEnabledcoplanarenabled
void NXOpen::Features::FaceRecognitionBuilder::SetEqualDiameterEnabled ( bool  equalDiameterEnabled)

Sets a value that indicates whether equal diameter recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
equalDiameterEnabledequaldiameterenabled
void NXOpen::Features::FaceRecognitionBuilder::SetOffsetEnabled ( bool  offsetEnabled)

Sets a value that indicates whether symmetric relation recognition is enabled
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
offsetEnabledoffsetenabled
void NXOpen::Features::FaceRecognitionBuilder::SetParallelEnabled ( bool  parallelEnabled)

Sets a value that indicates whether parallel relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
parallelEnabledparallelenabled
void NXOpen::Features::FaceRecognitionBuilder::SetPerpendicularEnabled ( bool  perpendicularEnabled)

Sets a value that indicates whether perpendicular relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
perpendicularEnabledperpendicularenabled
void NXOpen::Features::FaceRecognitionBuilder::SetRelationScope ( int  relationScope)

Sets a value that indicates what kind of relations are needed to recognize
Created in NX7.5.0.



License requirements : gateway ("UG GATEWAY")

Parameters
relationScoperelationscope
void NXOpen::Features::FaceRecognitionBuilder::SetSymmetricEnabled ( bool  symmetricEnabled)

Sets a value that indicates whether symmetric relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
symmetricEnabledsymmetricenabled
void NXOpen::Features::FaceRecognitionBuilder::SetTangentEnabled ( bool  tangentEnabled)

Sets a value that indicates whether tangent relation recognition is enabled
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
tangentEnabledtangentenabled
void NXOpen::Features::FaceRecognitionBuilder::SetThicknessChainEnabled ( bool  thicknessChainEnabled)

Sets a value that indicates whether thickness chain relation recognition is enabled
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
thicknessChainEnabledthicknesschainenabled
void NXOpen::Features::FaceRecognitionBuilder::SetUseFaceBrowse ( bool  useFaceBrowse)

Sets a value that indicates whether relations are found when faces are added to the face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
useFaceBrowseusefacebrowse
bool NXOpen::Features::FaceRecognitionBuilder::SymmetricEnabled ( )

Returns a value that indicates whether symmetric relation recognition is enabled
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::TangentEnabled ( )

Returns a value that indicates whether tangent relation recognition is enabled
Created in NX6.0.0.



License requirements : None

bool NXOpen::Features::FaceRecognitionBuilder::ThicknessChainEnabled ( )

Returns a value that indicates whether thickness chain relation recognition is enabled
Created in NX7.0.0.



License requirements : None

void NXOpen::Features::FaceRecognitionBuilder::UnlockConstraint ( NXOpen::Features::Feature feature)

Unlocks the persistent constraint
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
featurethe persistent constraint feature
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeCoaxial ( bool  isNear)

Removes coaxial relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeCoplanar ( bool  isNear)

Removes coplanar relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeCoplanarAxes ( bool  isNear)

Removes coplanar axes relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeEqualDiameter ( bool  isNear)

Removes equal diameter relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeOffset ( bool  isNear)

Removes offset relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeParallel ( bool  isNear)

Removes parallel relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizePerpendicular ( bool  isNear)

Removes perpendicular relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeSymmetric ( bool  isNear)

Removes symmetric relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeTangent ( bool  isNear)

Removes tangent relations to last faces added to face collector
Created in NX6.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
void NXOpen::Features::FaceRecognitionBuilder::UnrecognizeThicknessChain ( bool  isNear)

Removes thickness chain relations to last faces added to face collector
Created in NX7.0.0.



License requirements : gateway ("UG GATEWAY")

Parameters
isNeartrue for near relations, false for far relations
bool NXOpen::Features::FaceRecognitionBuilder::UseFaceBrowse ( )

Returns a value that indicates whether relations are found when faces are added to the face collector
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Features::FaceRecognitionBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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