LocalUntrimBuilder Class

class NXOpen.GeometricUtilities.LocalUntrimBuilder

Bases: NXOpen.Builder

Represents a NXOpen.GeometricUtilities.LocalUntrimBuilder builder.

This builder is used to untrim and extend a sheet. To create a new instance of this class, use NXOpen.GeometricUtilities.LocalUntrimManager.CreateBuilder()

Default values.

Property	Value
EditCopy	0
UEndDistance.Value	0 (millimeters part), 0 (inches part)
UStartDistance.Value	0 (millimeters part), 0 (inches part)
VEndDistance.Value	0 (millimeters part), 0 (inches part)
VStartDistance.Value	0 (millimeters part), 0 (inches part)

New in version NX9.0.0.

Properties

Property	Description
EdgeCollector	Returns the edges on the face to delete.
EditCopy	Returns or sets the flag to indicate whether to edit a copied face or not.
Face	Returns the tool object to split the target body.
RemoveBoundary	Returns or sets the flag to indicate whether to remove the face boundary or not.
Tag	Returns the Tag for this object.
UEndDistance	Returns the U end distance.
UEndLimit	Returns the region limit of U end.
UStartDistance	Returns the U start distance.
UStartLimit	Returns the region limit of U start.
VEndDistance	Returns the V end distance.
VEndLimit	Returns the region limit of V end.
VStartDistance	Returns the V start distance.
VStartLimit	Returns the region limit of V start.

Methods

Method	Description
CleanUpFeaturesCreated	Cleans up the features created by the selecting face call back.
Commit	Commits any edits that have been applied to the builder.
CreateCopyFace	Creates the extracted face when the flag of Edit a Copy is turned on or a solid body face is selected.
CreateProductBoundingBox	Creates the product initial bounding box.
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.
SetCurrentFeature	Records the current feature before constructing the dialog.
SetInitialDistanceValue	Sets the initial distance value.
SetLimitChangeValue	Sets the limit boundary handle type.
SetOriginalFace	Sets the originally selected face.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UpdateBoundingBox	Updates the bounding box when changing the distance value.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

EdgeCollector

LocalUntrimBuilder.EdgeCollector

Returns the edges on the face to delete.

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

Getter Method

Signature EdgeCollector

Returns: Return type:NXOpen.ScCollector

New in version NX9.0.0.

License requirements: None.

EditCopy

LocalUntrimBuilder.EditCopy

Returns or sets the flag to indicate whether to edit a copied face or not.

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

Getter Method

Signature EditCopy

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature EditCopy

Parameters:editCopy (bool) –

New in version NX9.0.0.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

Face

LocalUntrimBuilder.Face

Returns the tool object to split the target body.

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

Getter Method

Signature Face

Returns: Return type:NXOpen.SelectFace

New in version NX9.0.0.

License requirements: None.

RemoveBoundary

LocalUntrimBuilder.RemoveBoundary

Returns or sets the flag to indicate whether to remove the face boundary or not.

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

Getter Method

Signature RemoveBoundary

Returns: Return type:bool

New in version NX9.0.2.

License requirements: None.

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

Setter Method

Signature RemoveBoundary

Parameters:removeBoundary (bool) –

New in version NX9.0.2.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

UEndDistance

LocalUntrimBuilder.UEndDistance

Returns the U end distance.

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

Getter Method

Signature UEndDistance

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

UEndLimit

LocalUntrimBuilder.UEndLimit

Returns the region limit of U end.

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

Getter Method

Signature UEndLimit

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX9.0.0.

License requirements: None.

UStartDistance

LocalUntrimBuilder.UStartDistance

Returns the U start distance.

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

Getter Method

Signature UStartDistance

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

UStartLimit

LocalUntrimBuilder.UStartLimit

Returns the region limit of U start.

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

Getter Method

Signature UStartLimit

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX9.0.0.

License requirements: None.

VEndDistance

LocalUntrimBuilder.VEndDistance

Returns the V end distance.

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

Getter Method

Signature VEndDistance

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

VEndLimit

LocalUntrimBuilder.VEndLimit

Returns the region limit of V end.

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

Getter Method

Signature VEndLimit

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX9.0.0.

License requirements: None.

VStartDistance

LocalUntrimBuilder.VStartDistance

Returns the V start distance.

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

Getter Method

Signature VStartDistance

Returns: Return type:NXOpen.Expression

New in version NX9.0.0.

License requirements: None.

VStartLimit

LocalUntrimBuilder.VStartLimit

Returns the region limit of V start.

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

Getter Method

Signature VStartLimit

Returns: Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX9.0.0.

License requirements: None.

Method Detail

CleanUpFeaturesCreated

LocalUntrimBuilder.CleanUpFeaturesCreated

Cleans up the features created by the selecting face call back.

Signature CleanUpFeaturesCreated()

New in version NX9.0.0.

License requirements: None.

CreateCopyFace

LocalUntrimBuilder.CreateCopyFace

Creates the extracted face when the flag of Edit a Copy is turned on or a solid body face is selected.

Signature CreateCopyFace()

New in version NX9.0.0.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

CreateProductBoundingBox

LocalUntrimBuilder.CreateProductBoundingBox

Creates the product initial bounding box.

Signature CreateProductBoundingBox()

New in version NX9.0.0.

License requirements: None.

SetCurrentFeature

LocalUntrimBuilder.SetCurrentFeature

Records the current feature before constructing the dialog.

Signature SetCurrentFeature(object)

Parameters:object (NXOpen.Features.Feature) –

New in version NX9.0.0.

License requirements: None.

SetInitialDistanceValue

LocalUntrimBuilder.SetInitialDistanceValue

Sets the initial distance value.

Signature SetInitialDistanceValue(distanceValues)

Parameters:distanceValues (list of float) –

New in version NX10.0.1.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

SetLimitChangeValue

LocalUntrimBuilder.SetLimitChangeValue

Sets the limit boundary handle type.

Signature SetLimitChangeValue(limitType)

Parameters:limitType (int) –

New in version NX10.0.1.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

SetOriginalFace

LocalUntrimBuilder.SetOriginalFace

Sets the originally selected face.

Signature SetOriginalFace(originalFace)

Parameters:originalFace (NXOpen.Face) –

New in version NX9.0.0.

License requirements: nx_freeform_1 (“basic freeform modeling”) OR nx_freeform_2 (“advanced freeform modeling”)

UpdateBoundingBox

LocalUntrimBuilder.UpdateBoundingBox

Updates the bounding box when changing the distance value.

Signature UpdateBoundingBox()

New in version NX9.0.0.

License requirements: None.

Validate

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