FaceRecognitionBuilder Class¶

class NXOpen.Features.FaceRecognitionBuilder¶

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a collection of faces and their relationships to other faces in the model

New in version NX6.0.0.

Properties¶

Property	Description
CoaxialEnabled	Returns or sets a value that indicates whether coaxial relation recognition is enabled
CoplanarAxesEnabled	Returns or sets a value that indicates whether coplanar axes relation recognition is enabled
CoplanarEnabled	Returns or sets a value that indicates whether coplanar relation recognition is enabled
EqualDiameterEnabled	Returns or sets a value that indicates whether equal diameter recognition is enabled
FaceCollector	Returns the face collector
OffsetEnabled	Returns or sets a value that indicates whether symmetric relation recognition is enabled
ParallelEnabled	Returns or sets a value that indicates whether parallel relation recognition is enabled
PerpendicularEnabled	Returns or sets a value that indicates whether perpendicular relation recognition is enabled
ReferenceCoordinateSystem	Returns the reference coordinate system to use for symmetry and coplanar axis recognition
RelationScope	Returns or sets a value that indicates what kind of relations are needed to recognize
SymmetricEnabled	Returns or sets a value that indicates whether symmetric relation recognition is enabled
Tag	Returns the Tag for this object.
TangentEnabled	Returns or sets a value that indicates whether tangent relation recognition is enabled
ThicknessChainEnabled	Returns or sets a value that indicates whether thickness chain relation recognition is enabled
UseFaceBrowse	Returns or sets a value that indicates whether relations are found when faces are added to the face collector

Methods¶

Method	Description
DeleteConstraint	Deletes the persistent constraint
DeleteOffsetRelation	Deletes the offset relation
DeselectEntities	Removes entities from collector
LockConstraint	Locks the persistent constraint
RecognizeCoaxial	Recognizes coaxial relations to last faces added to face collector
RecognizeCoplanar	Recognizes coplanar relations to last faces added to face collector
RecognizeCoplanarAxes	Recognizes coplanar axes relations to last faces added to face collector
RecognizeEqualDiameter	Recognizes equal diameter relations to last faces added to face collector
RecognizeOffset	Recognizes offset relations to last faces added to face collector
RecognizeParallel	Recognizes parallel relations to last faces added to face collector
RecognizePerpendicular	Recognizes perpendicular relations to last faces added to face collector
RecognizeSymmetric	Recognizes symmetric relations to last faces added to face collector
RecognizeTangent	Recognizes tangent relations to last faces added to face collector
RecognizeThicknessChain	Recognizes thickness chain relations to last faces added to face collector
ReplaceRules	Replace collector rules.
SelectEntities	Adds entities to collector
UnlockConstraint	Unlocks the persistent constraint
UnrecognizeCoaxial	Removes coaxial relations to last faces added to face collector
UnrecognizeCoplanar	Removes coplanar relations to last faces added to face collector
UnrecognizeCoplanarAxes	Removes coplanar axes relations to last faces added to face collector
UnrecognizeEqualDiameter	Removes equal diameter relations to last faces added to face collector
UnrecognizeOffset	Removes offset relations to last faces added to face collector
UnrecognizeParallel	Removes parallel relations to last faces added to face collector
UnrecognizePerpendicular	Removes perpendicular relations to last faces added to face collector
UnrecognizeSymmetric	Removes symmetric relations to last faces added to face collector
UnrecognizeTangent	Removes tangent relations to last faces added to face collector
UnrecognizeThicknessChain	Removes thickness chain relations to last faces added to face collector
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail¶

CoaxialEnabled¶

FaceRecognitionBuilder.CoaxialEnabled¶

Returns or sets a value that indicates whether coaxial relation recognition is enabled

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

Getter Method

Signature CoaxialEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CoaxialEnabled

Parameters:	coaxialEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

CoplanarAxesEnabled¶

FaceRecognitionBuilder.CoplanarAxesEnabled¶

Returns or sets a value that indicates whether coplanar axes relation recognition is enabled

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

Getter Method

Signature CoplanarAxesEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CoplanarAxesEnabled

Parameters:	coplanarEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

CoplanarEnabled¶

FaceRecognitionBuilder.CoplanarEnabled¶

Returns or sets a value that indicates whether coplanar relation recognition is enabled

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

Getter Method

Signature CoplanarEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature CoplanarEnabled

Parameters:	coplanarEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

EqualDiameterEnabled¶

FaceRecognitionBuilder.EqualDiameterEnabled¶

Returns or sets a value that indicates whether equal diameter recognition is enabled

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

Getter Method

Signature EqualDiameterEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature EqualDiameterEnabled

Parameters:	equalDiameterEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

FaceCollector¶

FaceRecognitionBuilder.FaceCollector¶

Returns the face collector

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

Getter Method

Signature FaceCollector

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX6.0.0.

License requirements: None.

OffsetEnabled¶

FaceRecognitionBuilder.OffsetEnabled¶

Returns or sets a value that indicates whether symmetric relation recognition is enabled

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

Getter Method

Signature OffsetEnabled

Returns:
Return type:	bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature OffsetEnabled

Parameters:	offsetEnabled (bool) –

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

ParallelEnabled¶

FaceRecognitionBuilder.ParallelEnabled¶

Returns or sets a value that indicates whether parallel relation recognition is enabled

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

Getter Method

Signature ParallelEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ParallelEnabled

Parameters:	parallelEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

PerpendicularEnabled¶

FaceRecognitionBuilder.PerpendicularEnabled¶

Returns or sets a value that indicates whether perpendicular relation recognition is enabled

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

Getter Method

Signature PerpendicularEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PerpendicularEnabled

Parameters:	perpendicularEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

ReferenceCoordinateSystem¶

FaceRecognitionBuilder.ReferenceCoordinateSystem¶

Returns the reference coordinate system to use for symmetry and coplanar axis recognition

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

Getter Method

Signature ReferenceCoordinateSystem

Returns:
Return type:	`NXOpen.GeometricUtilities.OrientXpressBuilder`

New in version NX6.0.0.

License requirements: None.

RelationScope¶

FaceRecognitionBuilder.RelationScope¶

Returns or sets a value that indicates what kind of relations are needed to recognize

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

Getter Method

Signature RelationScope

Returns:
Return type:	int

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature RelationScope

Parameters:	relationScope (int) –

New in version NX7.5.0.

License requirements: gateway (“UG GATEWAY”)

SymmetricEnabled¶

FaceRecognitionBuilder.SymmetricEnabled¶

Returns or sets a value that indicates whether symmetric relation recognition is enabled

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

Getter Method

Signature SymmetricEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature SymmetricEnabled

Parameters:	symmetricEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

TangentEnabled¶

FaceRecognitionBuilder.TangentEnabled¶

Returns or sets a value that indicates whether tangent relation recognition is enabled

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

Getter Method

Signature TangentEnabled

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TangentEnabled

Parameters:	tangentEnabled (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

ThicknessChainEnabled¶

FaceRecognitionBuilder.ThicknessChainEnabled¶

Returns or sets a value that indicates whether thickness chain relation recognition is enabled

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

Getter Method

Signature ThicknessChainEnabled

Returns:
Return type:	bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature ThicknessChainEnabled

Parameters:	thicknessChainEnabled (bool) –

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

UseFaceBrowse¶

FaceRecognitionBuilder.UseFaceBrowse¶

Returns or sets a value that indicates whether relations are found when faces are added to the face collector

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

Getter Method

Signature UseFaceBrowse

Returns:
Return type:	bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature UseFaceBrowse

Parameters:	useFaceBrowse (bool) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

Method Detail¶

DeleteConstraint¶

FaceRecognitionBuilder.DeleteConstraint¶

Deletes the persistent constraint

Signature DeleteConstraint(feature)

Parameters:	feature (`NXOpen.Features.Feature`) – the persistent constraint feature

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

DeleteOffsetRelation¶

FaceRecognitionBuilder.DeleteOffsetRelation¶

Deletes the offset relation

Signature DeleteOffsetRelation(offsetFaces)

Parameters:	offsetFaces (list of `NXOpen.NXObject`) –

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

DeselectEntities¶

FaceRecognitionBuilder.DeselectEntities¶

Removes entities from collector

Signature DeselectEntities(entities)

Parameters:	entities (list of `NXOpen.NXObject`) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

LockConstraint¶

FaceRecognitionBuilder.LockConstraint¶

Locks the persistent constraint

Signature LockConstraint(feature)

Parameters:	feature (`NXOpen.Features.Feature`) – the persistent constraint feature

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeCoaxial¶

FaceRecognitionBuilder.RecognizeCoaxial¶

Recognizes coaxial relations to last faces added to face collector

Signature RecognizeCoaxial(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeCoplanar¶

FaceRecognitionBuilder.RecognizeCoplanar¶

Recognizes coplanar relations to last faces added to face collector

Signature RecognizeCoplanar(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeCoplanarAxes¶

FaceRecognitionBuilder.RecognizeCoplanarAxes¶

Recognizes coplanar axes relations to last faces added to face collector

Signature RecognizeCoplanarAxes(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeEqualDiameter¶

FaceRecognitionBuilder.RecognizeEqualDiameter¶

Recognizes equal diameter relations to last faces added to face collector

Signature RecognizeEqualDiameter(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeOffset¶

FaceRecognitionBuilder.RecognizeOffset¶

Recognizes offset relations to last faces added to face collector

Signature RecognizeOffset(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeParallel¶

FaceRecognitionBuilder.RecognizeParallel¶

Recognizes parallel relations to last faces added to face collector

Signature RecognizeParallel(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizePerpendicular¶

FaceRecognitionBuilder.RecognizePerpendicular¶

Recognizes perpendicular relations to last faces added to face collector

Signature RecognizePerpendicular(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeSymmetric¶

FaceRecognitionBuilder.RecognizeSymmetric¶

Recognizes symmetric relations to last faces added to face collector

Signature RecognizeSymmetric(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeTangent¶

FaceRecognitionBuilder.RecognizeTangent¶

Recognizes tangent relations to last faces added to face collector

Signature RecognizeTangent(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

RecognizeThicknessChain¶

FaceRecognitionBuilder.RecognizeThicknessChain¶

Recognizes thickness chain relations to last faces added to face collector

Signature RecognizeThicknessChain(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

ReplaceRules¶

FaceRecognitionBuilder.ReplaceRules¶

Replace collector rules.

Signature ReplaceRules(rules, createRulesWoUpdate)

Parameters:	rules (list of `NXOpen.SelectionIntentRule`) – Selection intent rules. To create selection intent rules see documentation of `ScRuleFactory` for more details. createRulesWoUpdate (bool) – Flag to tell whether rules should be created wo_update

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

SelectEntities¶

FaceRecognitionBuilder.SelectEntities¶

Adds entities to collector

Signature SelectEntities(entities)

Parameters:	entities (list of `NXOpen.NXObject`) –

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnlockConstraint¶

FaceRecognitionBuilder.UnlockConstraint¶

Unlocks the persistent constraint

Signature UnlockConstraint(feature)

Parameters:	feature (`NXOpen.Features.Feature`) – the persistent constraint feature

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeCoaxial¶

FaceRecognitionBuilder.UnrecognizeCoaxial¶

Removes coaxial relations to last faces added to face collector

Signature UnrecognizeCoaxial(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeCoplanar¶

FaceRecognitionBuilder.UnrecognizeCoplanar¶

Removes coplanar relations to last faces added to face collector

Signature UnrecognizeCoplanar(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeCoplanarAxes¶

FaceRecognitionBuilder.UnrecognizeCoplanarAxes¶

Removes coplanar axes relations to last faces added to face collector

Signature UnrecognizeCoplanarAxes(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeEqualDiameter¶

FaceRecognitionBuilder.UnrecognizeEqualDiameter¶

Removes equal diameter relations to last faces added to face collector

Signature UnrecognizeEqualDiameter(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeOffset¶

FaceRecognitionBuilder.UnrecognizeOffset¶

Removes offset relations to last faces added to face collector

Signature UnrecognizeOffset(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeParallel¶

FaceRecognitionBuilder.UnrecognizeParallel¶

Removes parallel relations to last faces added to face collector

Signature UnrecognizeParallel(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizePerpendicular¶

FaceRecognitionBuilder.UnrecognizePerpendicular¶

Removes perpendicular relations to last faces added to face collector

Signature UnrecognizePerpendicular(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeSymmetric¶

FaceRecognitionBuilder.UnrecognizeSymmetric¶

Removes symmetric relations to last faces added to face collector

Signature UnrecognizeSymmetric(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeTangent¶

FaceRecognitionBuilder.UnrecognizeTangent¶

Removes tangent relations to last faces added to face collector

Signature UnrecognizeTangent(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX6.0.0.

License requirements: gateway (“UG GATEWAY”)

UnrecognizeThicknessChain¶

FaceRecognitionBuilder.UnrecognizeThicknessChain¶

Removes thickness chain relations to last faces added to face collector

Signature UnrecognizeThicknessChain(isNear)

Parameters:	isNear (bool) – true for near relations, false for far relations

New in version NX7.0.0.

License requirements: gateway (“UG GATEWAY”)

Validate¶

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