TransformBuilder Class¶
-
class
NXOpen.Weld.
TransformBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Weld.TransformBuilder
builderTo create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateTransformBuilder()
New in version NX11.0.1.
Properties¶
Property | Description |
---|---|
Associative | Returns or sets the indication to create associative feature |
Characteristics | Returns the collection of welding characteristics defined by attributes. |
ConnectedPartMethod | Returns or sets the method used to find connected parts |
ConnectedPartTolerance | Returns the expression containing the value of the connected part tolerance. |
Features | Returns the weld features to transform |
MirrorPlane | Returns or sets the mirror plane, used when NXOpen.Weld.TransformBuilderTransformationTypes is set to :py:class:` NXOpen.Weld.TransformBuilderTransformationTypes.Mirror < NXOpen.Weld.TransformBuilderTransformationTypes>` |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TranslateCsys | Returns or sets the coordinate system that defines the translate offset directions. |
TranslateX | Returns the expression containing the value of the x translation distance. |
TranslateY | Returns the expression containing the value of the y translation distance. |
TranslateZ | Returns the expression containing the value of the z translation distance. |
Type | Returns or sets the transformation type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
TransformBuilderConnectedPartMethods Enumeration | The type to define the method used to find connected parts |
TransformBuilderTransformationTypes Enumeration | The transformation types |
Property Detail¶
Associative¶
-
TransformBuilder.
Associative
¶ Returns or sets the indication to create associative feature
-------------------------------------
Getter Method
Signature
Associative
Returns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
Associative
Parameters: associative (bool) – New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
Characteristics¶
-
TransformBuilder.
Characteristics
¶ Returns the collection of welding characteristics defined by attributes.
-------------------------------------
Getter Method
Signature
Characteristics
Returns: Return type: NXOpen.Weld.CharacteristicsBuilder
New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
ConnectedPartMethod¶
-
TransformBuilder.
ConnectedPartMethod
¶ Returns or sets the method used to find connected parts
-------------------------------------
Getter Method
Signature
ConnectedPartMethod
Returns: Return type: NXOpen.Weld.TransformBuilderConnectedPartMethods
New in version NX12.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConnectedPartMethod
Parameters: method ( NXOpen.Weld.TransformBuilderConnectedPartMethods
) –New in version NX12.0.0.
License requirements: ugweld (“UG WELD”)
ConnectedPartTolerance¶
-
TransformBuilder.
ConnectedPartTolerance
¶ Returns the expression containing the value of the connected part tolerance.
This is used to find connected part information for the transformed weld.
-------------------------------------
Getter Method
Signature
ConnectedPartTolerance
Returns: Return type: NXOpen.Expression
New in version NX11.0.1.
License requirements: None.
Features¶
-
TransformBuilder.
Features
¶ Returns the weld features to transform
-------------------------------------
Getter Method
Signature
Features
Returns: Return type: NXOpen.Features.SelectBodyFeatureList
New in version NX11.0.1.
License requirements: None.
MirrorPlane¶
-
TransformBuilder.
MirrorPlane
¶ Returns or sets the mirror plane, used when
NXOpen.Weld.TransformBuilderTransformationTypes
is set to :py:class:` NXOpen.Weld.TransformBuilderTransformationTypes.Mirror < NXOpen.Weld.TransformBuilderTransformationTypes>`-------------------------------------
Getter Method
Signature
MirrorPlane
Returns: Return type: NXOpen.Plane
New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MirrorPlane
Parameters: mirrorPlane ( NXOpen.Plane
) –New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
TranslateCsys¶
-
TransformBuilder.
TranslateCsys
¶ Returns or sets the coordinate system that defines the translate offset directions.
If not specified the absolute coordinate system will be used. Used when
NXOpen.Weld.TransformBuilderTransformationTypes
is set to :py:class:` NXOpen.Weld.TransformBuilderTransformationTypes.Translate < NXOpen.Weld.TransformBuilderTransformationTypes>`-------------------------------------
Getter Method
Signature
TranslateCsys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslateCsys
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
TranslateX¶
-
TransformBuilder.
TranslateX
¶ Returns the expression containing the value of the x translation distance.
Used when
NXOpen.Weld.TransformBuilderTransformationTypes
is set to :py:class:` NXOpen.Weld.TransformBuilderTransformationTypes.Translate < NXOpen.Weld.TransformBuilderTransformationTypes>`-------------------------------------
Getter Method
Signature
TranslateX
Returns: Return type: NXOpen.Expression
New in version NX11.0.1.
License requirements: None.
TranslateY¶
-
TransformBuilder.
TranslateY
¶ Returns the expression containing the value of the y translation distance.
-------------------------------------
Getter Method
Signature
TranslateY
Returns: Return type: NXOpen.Expression
New in version NX11.0.1.
License requirements: None.
TranslateZ¶
-
TransformBuilder.
TranslateZ
¶ Returns the expression containing the value of the z translation distance.
-------------------------------------
Getter Method
Signature
TranslateZ
Returns: Return type: NXOpen.Expression
New in version NX11.0.1.
License requirements: None.
Type¶
-
TransformBuilder.
Type
¶ Returns or sets the transformation type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Weld.TransformBuilderTransformationTypes
New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Type
Parameters: transType ( NXOpen.Weld.TransformBuilderTransformationTypes
) –New in version NX11.0.1.
License requirements: ugweld (“UG WELD”)
Method Detail¶
Validate¶
-
TransformBuilder.
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.