FreeTransformerBuilder Class¶
-
class
NXOpen.Features.FreeTransformerBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.FreeTransformerbuilderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateFreeTransformerBuilder()Default values.
Property Value AsOriginalOption 0 Free2DOption 0 HideOriginal 0 ShowTransformVectors 0 StepExpression.Value 1 New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| AsOriginalOption | Returns or sets the option to use the same colors and layers of the original geometries for creating new geometries |
| DistanceTolerance | Returns or sets the distance tolerance used in the transformation or morphing calculations |
| FixedCurvesList | Returns the fixed curves list that defines the list items containing fixed curves used in the transformation or morphing calculations |
| Free2DOption | Returns or sets the option to turn on or off the Free 2D plane used in the transformation or morphing calculations |
| Free2DPlane | Returns or sets the Free 2D plane to be used in the transformation or morphing calculations |
| HideOriginal | Returns or sets the option to hide the original geometries after creating new geometries |
| 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 |
| ShowTransformVectors | Returns or sets the option to show temporary transform vectors in preview |
| StepExpression | Returns the expression that defines the step count used in the transformation or morphing calculations |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| TransformCurves | Returns the curves to be transformed |
| TransformCurvesList | Returns the transformation curves list that defines the list items containing the transformation start and end curves used in the transformation or morphing calculations |
| TransformFaces | Returns the faces to be transformed |
| TransformPointsList | Returns the transformation points list that defines list items containing the transformation start and end points used in the transformation or morphing calculations |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature @return |
| 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. |
Property Detail¶
AsOriginalOption¶
-
FreeTransformerBuilder.AsOriginalOption¶ Returns or sets the option to use the same colors and layers of the original geometries for creating new geometries
-------------------------------------Getter Method
Signature
AsOriginalOption()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AsOriginalOption(asOriginalOption)Parameters: asOriginalOption (bool) – New in version NX10.0.0.
License requirements: None.
DistanceTolerance¶
-
FreeTransformerBuilder.DistanceTolerance¶ Returns or sets the distance tolerance used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
DistanceTolerance()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceTolerance(distanceTolerance)Parameters: distanceTolerance (float) – New in version NX10.0.0.
License requirements: None.
FixedCurvesList¶
-
FreeTransformerBuilder.FixedCurvesList¶ Returns the fixed curves list that defines the list items containing fixed curves used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
FixedCurvesList()Returns: Return type: NXOpen.GeometricUtilities.FtmFixedCurvesBuilderListNew in version NX10.0.0.
License requirements: None.
Free2DOption¶
-
FreeTransformerBuilder.Free2DOption¶ Returns or sets the option to turn on or off the Free 2D plane used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
Free2DOption()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Free2DOption(free2DOption)Parameters: free2DOption (bool) – New in version NX10.0.0.
License requirements: None.
Free2DPlane¶
-
FreeTransformerBuilder.Free2DPlane¶ Returns or sets the Free 2D plane to be used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
Free2DPlane()Returns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Free2DPlane(free2DPlane)Parameters: free2DPlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: None.
HideOriginal¶
-
FreeTransformerBuilder.HideOriginal¶ Returns or sets the option to hide the original geometries after creating new geometries
-------------------------------------Getter Method
Signature
HideOriginal()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HideOriginal(hideOriginal)Parameters: hideOriginal (bool) – New in version NX10.0.0.
License requirements: None.
ShowTransformVectors¶
-
FreeTransformerBuilder.ShowTransformVectors¶ Returns or sets the option to show temporary transform vectors in preview
-------------------------------------Getter Method
Signature
ShowTransformVectors()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowTransformVectors(showTransformVectors)Parameters: showTransformVectors (bool) – New in version NX10.0.0.
License requirements: None.
StepExpression¶
-
FreeTransformerBuilder.StepExpression¶ Returns the expression that defines the step count used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
StepExpression()Returns: Return type: NXOpen.ExpressionNew in version NX10.0.0.
License requirements: None.
TransformCurves¶
-
FreeTransformerBuilder.TransformCurves¶ Returns the curves to be transformed
-------------------------------------Getter Method
Signature
TransformCurves()Returns: Return type: NXOpen.SectionNew in version NX10.0.0.
License requirements: None.
TransformCurvesList¶
-
FreeTransformerBuilder.TransformCurvesList¶ Returns the transformation curves list that defines the list items containing the transformation start and end curves used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
TransformCurvesList()Returns: Return type: NXOpen.GeometricUtilities.FtmTransformCurvesBuilderListNew in version NX10.0.0.
License requirements: None.
TransformFaces¶
-
FreeTransformerBuilder.TransformFaces¶ Returns the faces to be transformed
-------------------------------------Getter Method
Signature
TransformFaces()Returns: Return type: NXOpen.ScCollectorNew in version NX10.0.0.
License requirements: None.
TransformPointsList¶
-
FreeTransformerBuilder.TransformPointsList¶ Returns the transformation points list that defines list items containing the transformation start and end points used in the transformation or morphing calculations
-------------------------------------Getter Method
Signature
TransformPointsList()Returns: Return type: NXOpen.GeometricUtilities.FtmTransformPointsBuilderListNew in version NX10.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
FreeTransformerBuilder.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.