MultiPatchAlignmentBuilder Class

class NXOpen.Facet.MultiPatchAlignmentBuilder

Bases: NXOpen.Builder

Aligns multiple facet bodies to one another without using reference points.

To create a new instance of this class, use NXOpen.Facet.FacetedBodyCollection.CreateMultiPatchAlignmentBuilder()

Default values.

Property Value
Iteration 10
MaximumCheckingDistance 10.0 (millimeters part), 0.5 (inches part)
Resolution High
Tolerance 0.01 (millimeters part), 0.005 (inches part)

New in version NX7.5.0.

Properties

Property Description
AlignmentBodies Returns the facet bodies to be aligned.
Iteration Returns or sets the value indicating the number of times the alignment algorithm is applied.
MaximumCheckingDistance Returns or sets the distance facets may be from one another in order to be used in the alignment.
ReferencePatches Returns an optional reference facet body with a location and orientation that will remain fixed, causing all of the other selected facet bodies to align with it.
Resolution Returns or sets the type indicating number of facets to be used in the alignment.
Tag Returns the Tag for this object.
Tolerance Returns or sets the precision of the alignment.

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

MultiPatchAlignmentBuilderResolutionType Enumeration Determines the number of facets used in the alignment.

Property Detail

AlignmentBodies

MultiPatchAlignmentBuilder.AlignmentBodies

Returns the facet bodies to be aligned.

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

Getter Method

Signature AlignmentBodies

Returns:
Return type:NXOpen.Facet.SelectFacetedBodyList

New in version NX7.5.0.

License requirements: None.

Iteration

MultiPatchAlignmentBuilder.Iteration

Returns or sets the value indicating the number of times the alignment algorithm is applied.

Many iterations improve alignment accuracy but take longer.

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

Getter Method

Signature Iteration

Returns:
Return type:int

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Iteration

Parameters:iteration (int) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

MaximumCheckingDistance

MultiPatchAlignmentBuilder.MaximumCheckingDistance

Returns or sets the distance facets may be from one another in order to be used in the alignment.

Larger numbers slow the alignment process.

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

Getter Method

Signature MaximumCheckingDistance

Returns:
Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MaximumCheckingDistance

Parameters:maximumCheckingDistance (float) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ReferencePatches

MultiPatchAlignmentBuilder.ReferencePatches

Returns an optional reference facet body with a location and orientation that will remain fixed, causing all of the other selected facet bodies to align with it.

If you do not select a reference body, all of the selected facet bodies will align to each other, without a fixed location.

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

Getter Method

Signature ReferencePatches

Returns:
Return type:NXOpen.Facet.SelectFacetedBodyList

New in version NX7.5.0.

License requirements: None.

Resolution

MultiPatchAlignmentBuilder.Resolution

Returns or sets the type indicating number of facets to be used in the alignment.

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

Getter Method

Signature Resolution

Returns:
Return type:NXOpen.Facet.MultiPatchAlignmentBuilderResolutionType

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Resolution

Parameters:resolution (NXOpen.Facet.MultiPatchAlignmentBuilderResolutionType) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Tolerance

MultiPatchAlignmentBuilder.Tolerance

Returns or sets the precision of the alignment.

Alignment will complete when tolerance is met or the number of iterations has been reached.

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

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

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