StudioXformBuilderEx Class — NXOpen Python API Reference 12.0.0 documentation

# StudioXformBuilderEx Class

class `NXOpen.Features.``StudioXformBuilderEx`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.StudioXform` builder

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateStudioXformBuilderEx()`

  Default values.

  Property | Value
  --- | ---
  AdvancedMethodOption | AdvancedOff
  CanUseFaceFinder | 0
  CurveRange.AnchorPosition | Start
  DegreesAndSegmentsOrPatches.Degree | 3
  DegreesAndSegmentsOrPatches.SegmentsOrPatches | 1
  DegreesAndSegmentsOrPatches.UDegree | 5
  DegreesAndSegmentsOrPatches.UPatches | 1
  DegreesAndSegmentsOrPatches.VDegree | 5
  DegreesAndSegmentsOrPatches.VPatches | 1
  ExtractMethod | Original
  FaceFinder.CoaxialEnabled | 0
  FaceFinder.CoplanarAxesEnabled | 0
  FaceFinder.CoplanarEnabled | 0
  FaceFinder.EqualDiameterEnabled | 0
  FaceFinder.OffsetEnabled | 0
  FaceFinder.ParallelEnabled | 0
  FaceFinder.PerpendicularEnabled | 0
  FaceFinder.SymmetricEnabled | 0
  FaceFinder.TangentEnabled | 0
  FaceFinder.ThicknessChainEnabled | 0
  FaceFinder.UseFaceBrowse | 1
  FallOffScale | 0
  FeatureSaveMethod | Relative
  InsertKnotDirection | UDirection
  InsertKnotParameter | 20
  IsSingleSelection | 1
  KeepAllContinuity | 0
  LockPoles | 1
  LockRegionUEndFlexibility | 0
  LockRegionUStartFlexibility | 0
  LockRegionVEndFlexibility | 0
  LockRegionVStartFlexibility | 0
  MovementMethod | View
  PlanarizeDirection | U
  PlanarizeMethod | AtPlaneLocation
  PlanarizeProjectionPlane | YZ
  PrincipalMovementDirection | Z
  PrincipalRotatingAxis | Z
  PrincipalScalingDirection | X
  ProportionalAllU | 1
  ProportionalAllV | 1
  ProportionalFallOffScale (deprecated) | 0.5
  ProportionalMoveAfterU | 0
  ProportionalMoveAfterV | 0
  ProportionalMoveBeforeU | 0
  ProportionalMoveBeforeV | 0
  RotatingAxis | WCS
  ScalingDirection | View
  SurfaceRange.AnchorPosition | Vertex1

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AdvancedMethod | Returns or sets the advanced method
AdvancedMethodOption | Returns or sets the advanced method
CanUseFaceFinder | Returns or sets the using face finder flag
ContinuityUMax | Returns the continuity at U maximum
ContinuityUMin | Returns the continuity at U minimum
ContinuityVMax | Returns the continuity at V maximum
ContinuityVMin | Returns the continuity at V minimum
ControlPoleManager | Returns the control pole manager
CurveRange | Returns the curve range
DegreesAndSegmentsOrPatches | Returns the degrees and segments or patches
ExtractMethod | Returns or sets the b-surface extraction method
ExtractTolerance | Returns or sets the value indicating a tolerance to be used to extract a b-surface from a selection face
FaceFinder | Returns the face finder
FallOffScale | Returns or sets the fall off scale
FeatureSaveMethod | Returns or sets the feature save method
InsertKnotDirection | Returns or sets the insert knot direction
InsertKnotParameter | Returns or sets the parameter where to insert knots
IsSingleSelection | Returns or sets the single selection flag
KeepAllContinuity | Returns or sets a value indicating whether to keep all continuity
LockPoles | Returns or sets a value indicating whether to lock poles in boundary constraints
LockRegionUEndFlexibility | Returns or sets the lock region flexibility at U end
LockRegionUStartFlexibility | Returns or sets the lock region flexibility at U start
LockRegionVEndFlexibility | Returns or sets the lock region flexibility at V end
LockRegionVStartFlexibility | Returns or sets the lock region flexibility at V start
MovementArbitraryPlane | Returns or sets the movement arbitrary plane
MovementArbitraryVector | Returns or sets the movement arbitrary vector
MovementMethod | Returns or sets the movement method
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
PlanarizeArbitraryPlane | Returns or sets the planarize arbitrary plane
PlanarizeDirection | Returns or sets the planarize direction
PlanarizeMethod | Returns or sets the planarize method
PlanarizeProjectionPlane | Returns or sets the planarize projection plane
PrincipalMovementDirection | Returns or sets the principal movement direction
PrincipalRotatingAxis | Returns or sets the principal rotating axis
PrincipalScalingDirection | Returns or sets the principal scaling direction
ProportionalAllU | Returns or sets a value indicating whether to use all poles in U direction during the proportional movement
ProportionalAllV | Returns or sets a value indicating whether to use all poles in V direction during the proportional movement
ProportionalFallOffScale | Returns or sets the proportional fall off scale
ProportionalMoveAfterU | Returns or sets a value indicating the pole number after u to participate in the proportional movement
ProportionalMoveAfterV | Returns or sets a value indicating the pole number after v to participate in the proportional movement
ProportionalMoveBeforeU | Returns or sets a value indicating the pole number before u to participate in the proportional movement
ProportionalMoveBeforeV | Returns or sets a value indicating the pole number before v to participate in the proportional movement
ProportionalPoleControlOption | Returns or sets the proportional pole control type
RotatingArbitraryPlane | Returns or sets the rotating arbitrary plane
RotatingArbitraryVector | Returns or sets the rotating arbitrary vector
RotatingAxis | Returns or sets the rotating axis
RotatingPivot | Returns or sets the rotating pivot
RotatingPivotPoint | Returns or sets the rotating pivot point
ScalingArbitraryPlane | Returns or sets the scaling arbitrary plane
ScalingArbitraryVector | Returns or sets the scaling arbitrary vector
ScalingCenter | Returns or sets the scaling center
ScalingCenterPoint | Returns or sets the scaling center point
ScalingDirection | Returns or sets the scaling direction
SurfaceRange | Returns the surface range
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the editing type
XformOX | Returns the orient express object
XformObjects | Returns the object to be transformed.

# Methods

Method | Description
--- | ---
ChangeDegree | Changes degree of the selected xform object
ChangeDegreeWithParameters | Changes degree of the selected xform object with desired parameters
ChangeFlexibility | Changes flexibility of the selected xform object
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
ConvertParameters | Converts parameters of the feature that owns selected xform object.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
EndLockRegion | End Lock Region operation to the selected xform object
FallOffReset | Reset the fall off scale
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.
InsertKnot | Inserts knot in the selected xform object
InsertKnots | Insert knots
InsertPole | Inserts a pole in the selected xform object
LockRegionNextObject | Move to next object in Lock Region method when more than one objected are in editing
ProportionalReset | Reset the proportional scale
RebaseOriginalGeometry | Replaces the original geometry data of an entity with the current deformed geometry data
RemovePole | Inserts a pole in the selected xform object
RestoreParentFace | Restore the parent face of a selection face
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetPoleEditType | Update pole status of the selected BSpine curve
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
UpdateLockRegionGeometry | Update lock region geometry with current geometry
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

StudioXformBuilderExAdvancedMethodOptionType Enumeration | Represents the advanced method option type
StudioXformBuilderExAdvancedMethodType Enumeration | Represents the advanced method type
StudioXformBuilderExExtrationMethodType Enumeration | B-surface extraction method
StudioXformBuilderExFeatureType Enumeration | Represents the feature type
StudioXformBuilderExInsertKnotDirectionType Enumeration | Represents the insert knot direction type
StudioXformBuilderExInsertPoleType Enumeration | Represents the insert pole type
StudioXformBuilderExMovementMethodType Enumeration | Represents the Xform movement type
StudioXformBuilderExPlanarizeDirectionType Enumeration | Represents the planarize direction type
StudioXformBuilderExPlanarizeMethodType Enumeration | Represents the planarize method type
StudioXformBuilderExPlanarizeProjectionPlaneType Enumeration | Represents the planarize projection plane type
StudioXformBuilderExPoleEditType Enumeration | Editing types of a pole of spline belonging to a Studio Spline feature
StudioXformBuilderExPrincipalMovementDirectionType Enumeration | Represents the principal movement direction type
StudioXformBuilderExPrincipalRotatingAxisType Enumeration | Represents the principal rotation axis type
StudioXformBuilderExPrincipalScalingDirectionType Enumeration | Represents the principal scaling direction type
StudioXformBuilderExProportionalPoleControlType Enumeration | Represents the pole control type in proportional method
StudioXformBuilderExRotatingAxisType Enumeration | Represents the rotation axis type
StudioXformBuilderExRotatingPivotType Enumeration | Represents the rotating pivot type
StudioXformBuilderExScalingCenterType Enumeration | Represents the scaling center type
StudioXformBuilderExScalingDirectionType Enumeration | Represents the scaling direction type
StudioXformBuilderExSurfaceDirectionType Enumeration | Represents the U or V direction of a B-Surface
StudioXformBuilderExTypes Enumeration | Represents the Xform editing type

# Property Detail

## AdvancedMethod

`StudioXformBuilderEx.``AdvancedMethod`

  Returns or sets the advanced method

  `-------------------------------------`

  Getter Method

  Signature `AdvancedMethod`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExAdvancedMethodType`

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.AdvancedMethodOption()` instead.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AdvancedMethod`

  Parameters: | advancedMethod (`NXOpen.Features.StudioXformBuilderExAdvancedMethodType`) –

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.AdvancedMethodOption()` instead.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## AdvancedMethodOption

`StudioXformBuilderEx.``AdvancedMethodOption`

  Returns or sets the advanced method

  `-------------------------------------`

  Getter Method

  Signature `AdvancedMethodOption`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExAdvancedMethodOptionType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AdvancedMethodOption`

  Parameters: | advancedMethod (`NXOpen.Features.StudioXformBuilderExAdvancedMethodOptionType`) –

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## CanUseFaceFinder

`StudioXformBuilderEx.``CanUseFaceFinder`

  Returns or sets the using face finder flag

  `-------------------------------------`

  Getter Method

  Signature `CanUseFaceFinder`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CanUseFaceFinder`

  Parameters: | canUseFaceFinder (bool) –

  New in version NX7.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ContinuityUMax

`StudioXformBuilderEx.``ContinuityUMax`

  Returns the continuity at U maximum

  `-------------------------------------`

  Getter Method

  Signature `ContinuityUMax`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.Continuity`

  New in version NX6.0.0.

  License requirements: None.

## ContinuityUMin

`StudioXformBuilderEx.``ContinuityUMin`

  Returns the continuity at U minimum

  `-------------------------------------`

  Getter Method

  Signature `ContinuityUMin`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.Continuity`

  New in version NX6.0.0.

  License requirements: None.

## ContinuityVMax

`StudioXformBuilderEx.``ContinuityVMax`

  Returns the continuity at V maximum

  `-------------------------------------`

  Getter Method

  Signature `ContinuityVMax`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.Continuity`

  New in version NX6.0.0.

  License requirements: None.

## ContinuityVMin

`StudioXformBuilderEx.``ContinuityVMin`

  Returns the continuity at V minimum

  `-------------------------------------`

  Getter Method

  Signature `ContinuityVMin`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.Continuity`

  New in version NX6.0.0.

  License requirements: None.

## ControlPoleManager

`StudioXformBuilderEx.``ControlPoleManager`

  Returns the control pole manager

  `-------------------------------------`

  Getter Method

  Signature `ControlPoleManager`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.ControlPoleManagerData`

  New in version NX6.0.0.

  License requirements: None.

## CurveRange

`StudioXformBuilderEx.``CurveRange`

  Returns the curve range

  `-------------------------------------`

  Getter Method

  Signature `CurveRange`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.CurveRangeBuilder`

  New in version NX6.0.0.

  License requirements: None.

## DegreesAndSegmentsOrPatches

`StudioXformBuilderEx.``DegreesAndSegmentsOrPatches`

  Returns the degrees and segments or patches

  `-------------------------------------`

  Getter Method

  Signature `DegreesAndSegmentsOrPatches`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.DegreesAndSegmentsOrPatchesBuilder`

  New in version NX6.0.0.

  License requirements: None.

## ExtractMethod

`StudioXformBuilderEx.``ExtractMethod`

  Returns or sets the b-surface extraction method

  `-------------------------------------`

  Getter Method

  Signature `ExtractMethod`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExExtrationMethodType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ExtractMethod`

  Parameters: | extractMethod (`NXOpen.Features.StudioXformBuilderExExtrationMethodType`) –

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ExtractTolerance

`StudioXformBuilderEx.``ExtractTolerance`

  Returns or sets the value indicating a tolerance to be used to extract a b-surface from a selection face

  `-------------------------------------`

  Getter Method

  Signature `ExtractTolerance`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ExtractTolerance`

  Parameters: | extractTolerance (float) –

  New in version NX7.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## FaceFinder

`StudioXformBuilderEx.``FaceFinder`

  Returns the face finder

  `-------------------------------------`

  Getter Method

  Signature `FaceFinder`

  Returns: |
  Return type: | `NXOpen.Features.FaceRecognitionBuilder`

  New in version NX7.5.0.

  License requirements: None.

## FallOffScale

`StudioXformBuilderEx.``FallOffScale`

  Returns or sets the fall off scale

  `-------------------------------------`

  Getter Method

  Signature `FallOffScale`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FallOffScale`

  Parameters: | fallOffScale (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## FeatureSaveMethod

`StudioXformBuilderEx.``FeatureSaveMethod`

  Returns or sets the feature save method

  `-------------------------------------`

  Getter Method

  Signature `FeatureSaveMethod`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExFeatureType`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FeatureSaveMethod`

  Parameters: | featureSaveMethod (`NXOpen.Features.StudioXformBuilderExFeatureType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InsertKnotDirection

`StudioXformBuilderEx.``InsertKnotDirection`

  Returns or sets the insert knot direction

  `-------------------------------------`

  Getter Method

  Signature `InsertKnotDirection`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExInsertKnotDirectionType`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InsertKnotDirection`

  Parameters: | insertKnotDirection (`NXOpen.Features.StudioXformBuilderExInsertKnotDirectionType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InsertKnotParameter

`StudioXformBuilderEx.``InsertKnotParameter`

  Returns or sets the parameter where to insert knots

  `-------------------------------------`

  Getter Method

  Signature `InsertKnotParameter`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InsertKnotParameter`

  Parameters: | insertKnotSlider (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsSingleSelection

`StudioXformBuilderEx.``IsSingleSelection`

  Returns or sets the single selection flag

  `-------------------------------------`

  Getter Method

  Signature `IsSingleSelection`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsSingleSelection`

  Parameters: | singleSelectionFlag (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## KeepAllContinuity

`StudioXformBuilderEx.``KeepAllContinuity`

  Returns or sets a value indicating whether to keep all continuity

  `-------------------------------------`

  Getter Method

  Signature `KeepAllContinuity`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `KeepAllContinuity`

  Parameters: | keepAllContinuity (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockPoles

`StudioXformBuilderEx.``LockPoles`

  Returns or sets a value indicating whether to lock poles in boundary constraints

  `-------------------------------------`

  Getter Method

  Signature `LockPoles`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LockPoles`

  Parameters: | lockPoles (bool) –

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockRegionUEndFlexibility

`StudioXformBuilderEx.``LockRegionUEndFlexibility`

  Returns or sets the lock region flexibility at U end

  `-------------------------------------`

  Getter Method

  Signature `LockRegionUEndFlexibility`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LockRegionUEndFlexibility`

  Parameters: | lockRegionUEndFlexibility (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockRegionUStartFlexibility

`StudioXformBuilderEx.``LockRegionUStartFlexibility`

  Returns or sets the lock region flexibility at U start

  `-------------------------------------`

  Getter Method

  Signature `LockRegionUStartFlexibility`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LockRegionUStartFlexibility`

  Parameters: | lockRegionUStartFlexibility (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockRegionVEndFlexibility

`StudioXformBuilderEx.``LockRegionVEndFlexibility`

  Returns or sets the lock region flexibility at V end

  `-------------------------------------`

  Getter Method

  Signature `LockRegionVEndFlexibility`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LockRegionVEndFlexibility`

  Parameters: | lockRegionVEndFlexibility (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockRegionVStartFlexibility

`StudioXformBuilderEx.``LockRegionVStartFlexibility`

  Returns or sets the lock region flexibility at V start

  `-------------------------------------`

  Getter Method

  Signature `LockRegionVStartFlexibility`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LockRegionVStartFlexibility`

  Parameters: | lockRegionVStartFlexibility (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MovementArbitraryPlane

`StudioXformBuilderEx.``MovementArbitraryPlane`

  Returns or sets the movement arbitrary plane

  `-------------------------------------`

  Getter Method

  Signature `MovementArbitraryPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MovementArbitraryPlane`

  Parameters: | movementArbitraryPlane (`NXOpen.Plane`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MovementArbitraryVector

`StudioXformBuilderEx.``MovementArbitraryVector`

  Returns or sets the movement arbitrary vector

  `-------------------------------------`

  Getter Method

  Signature `MovementArbitraryVector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MovementArbitraryVector`

  Parameters: | movementArbitraryVector (`NXOpen.Direction`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MovementMethod

`StudioXformBuilderEx.``MovementMethod`

  Returns or sets the movement method

  `-------------------------------------`

  Getter Method

  Signature `MovementMethod`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExMovementMethodType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MovementMethod`

  Parameters: | movementMethod (`NXOpen.Features.StudioXformBuilderExMovementMethodType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PlanarizeArbitraryPlane

`StudioXformBuilderEx.``PlanarizeArbitraryPlane`

  Returns or sets the planarize arbitrary plane

  `-------------------------------------`

  Getter Method

  Signature `PlanarizeArbitraryPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlanarizeArbitraryPlane`

  Parameters: | planarizeArbitraryPlane (`NXOpen.Plane`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PlanarizeDirection

`StudioXformBuilderEx.``PlanarizeDirection`

  Returns or sets the planarize direction

  `-------------------------------------`

  Getter Method

  Signature `PlanarizeDirection`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPlanarizeDirectionType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlanarizeDirection`

  Parameters: | planarizeDirection (`NXOpen.Features.StudioXformBuilderExPlanarizeDirectionType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PlanarizeMethod

`StudioXformBuilderEx.``PlanarizeMethod`

  Returns or sets the planarize method

  `-------------------------------------`

  Getter Method

  Signature `PlanarizeMethod`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPlanarizeMethodType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlanarizeMethod`

  Parameters: | planarizeMethod (`NXOpen.Features.StudioXformBuilderExPlanarizeMethodType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PlanarizeProjectionPlane

`StudioXformBuilderEx.``PlanarizeProjectionPlane`

  Returns or sets the planarize projection plane

  `-------------------------------------`

  Getter Method

  Signature `PlanarizeProjectionPlane`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPlanarizeProjectionPlaneType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlanarizeProjectionPlane`

  Parameters: | planarizeProjectionPlane (`NXOpen.Features.StudioXformBuilderExPlanarizeProjectionPlaneType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PrincipalMovementDirection

`StudioXformBuilderEx.``PrincipalMovementDirection`

  Returns or sets the principal movement direction

  `-------------------------------------`

  Getter Method

  Signature `PrincipalMovementDirection`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPrincipalMovementDirectionType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PrincipalMovementDirection`

  Parameters: | principalMovementDirection (`NXOpen.Features.StudioXformBuilderExPrincipalMovementDirectionType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PrincipalRotatingAxis

`StudioXformBuilderEx.``PrincipalRotatingAxis`

  Returns or sets the principal rotating axis

  `-------------------------------------`

  Getter Method

  Signature `PrincipalRotatingAxis`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPrincipalRotatingAxisType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PrincipalRotatingAxis`

  Parameters: | principalRotatingAxis (`NXOpen.Features.StudioXformBuilderExPrincipalRotatingAxisType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PrincipalScalingDirection

`StudioXformBuilderEx.``PrincipalScalingDirection`

  Returns or sets the principal scaling direction

  `-------------------------------------`

  Getter Method

  Signature `PrincipalScalingDirection`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExPrincipalScalingDirectionType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PrincipalScalingDirection`

  Parameters: | principalScalingDirection (`NXOpen.Features.StudioXformBuilderExPrincipalScalingDirectionType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalAllU

`StudioXformBuilderEx.``ProportionalAllU`

  Returns or sets a value indicating whether to use all poles in U direction during the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalAllU`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalAllU`

  Parameters: | proportionalAllU (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalAllV

`StudioXformBuilderEx.``ProportionalAllV`

  Returns or sets a value indicating whether to use all poles in V direction during the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalAllV`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalAllV`

  Parameters: | proportionalAllV (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalFallOffScale

`StudioXformBuilderEx.``ProportionalFallOffScale`

  Returns or sets the proportional fall off scale

  `-------------------------------------`

  Getter Method

  Signature `ProportionalFallOffScale`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.FallOffScale()` instead.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalFallOffScale`

  Parameters: | proportionalFallOffScale (float) –

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.FallOffScale()` instead.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalMoveAfterU

`StudioXformBuilderEx.``ProportionalMoveAfterU`

  Returns or sets a value indicating the pole number after u to participate in the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalMoveAfterU`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalMoveAfterU`

  Parameters: | proportionalMoveAfterU (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalMoveAfterV

`StudioXformBuilderEx.``ProportionalMoveAfterV`

  Returns or sets a value indicating the pole number after v to participate in the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalMoveAfterV`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalMoveAfterV`

  Parameters: | proportionalMoveAfterV (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalMoveBeforeU

`StudioXformBuilderEx.``ProportionalMoveBeforeU`

  Returns or sets a value indicating the pole number before u to participate in the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalMoveBeforeU`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalMoveBeforeU`

  Parameters: | proportionalMoveBeforeU (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalMoveBeforeV

`StudioXformBuilderEx.``ProportionalMoveBeforeV`

  Returns or sets a value indicating the pole number before v to participate in the proportional movement

  `-------------------------------------`

  Getter Method

  Signature `ProportionalMoveBeforeV`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalMoveBeforeV`

  Parameters: | proportionalMoveBeforeV (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalPoleControlOption

`StudioXformBuilderEx.``ProportionalPoleControlOption`

  Returns or sets the proportional pole control type

  `-------------------------------------`

  Getter Method

  Signature `ProportionalPoleControlOption`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExProportionalPoleControlType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProportionalPoleControlOption`

  Parameters: | poleControlOption (`NXOpen.Features.StudioXformBuilderExProportionalPoleControlType`) –

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RotatingArbitraryPlane

`StudioXformBuilderEx.``RotatingArbitraryPlane`

  Returns or sets the rotating arbitrary plane

  `-------------------------------------`

  Getter Method

  Signature `RotatingArbitraryPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotatingArbitraryPlane`

  Parameters: | rotatingArbitraryPlane (`NXOpen.Plane`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RotatingArbitraryVector

`StudioXformBuilderEx.``RotatingArbitraryVector`

  Returns or sets the rotating arbitrary vector

  `-------------------------------------`

  Getter Method

  Signature `RotatingArbitraryVector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotatingArbitraryVector`

  Parameters: | rotatingArbitraryVector (`NXOpen.Direction`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RotatingAxis

`StudioXformBuilderEx.``RotatingAxis`

  Returns or sets the rotating axis

  `-------------------------------------`

  Getter Method

  Signature `RotatingAxis`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExRotatingAxisType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotatingAxis`

  Parameters: | rotatingAxis (`NXOpen.Features.StudioXformBuilderExRotatingAxisType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RotatingPivot

`StudioXformBuilderEx.``RotatingPivot`

  Returns or sets the rotating pivot

  `-------------------------------------`

  Getter Method

  Signature `RotatingPivot`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExRotatingPivotType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotatingPivot`

  Parameters: | rotatingPivot (`NXOpen.Features.StudioXformBuilderExRotatingPivotType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RotatingPivotPoint

`StudioXformBuilderEx.``RotatingPivotPoint`

  Returns or sets the rotating pivot point

  `-------------------------------------`

  Getter Method

  Signature `RotatingPivotPoint`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotatingPivotPoint`

  Parameters: | rotatingPivotPoint (`NXOpen.Point`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ScalingArbitraryPlane

`StudioXformBuilderEx.``ScalingArbitraryPlane`

  Returns or sets the scaling arbitrary plane

  `-------------------------------------`

  Getter Method

  Signature `ScalingArbitraryPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScalingArbitraryPlane`

  Parameters: | scalingArbitraryPlane (`NXOpen.Plane`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ScalingArbitraryVector

`StudioXformBuilderEx.``ScalingArbitraryVector`

  Returns or sets the scaling arbitrary vector

  `-------------------------------------`

  Getter Method

  Signature `ScalingArbitraryVector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScalingArbitraryVector`

  Parameters: | scalingArbitraryVector (`NXOpen.Direction`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ScalingCenter

`StudioXformBuilderEx.``ScalingCenter`

  Returns or sets the scaling center

  `-------------------------------------`

  Getter Method

  Signature `ScalingCenter`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExScalingCenterType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScalingCenter`

  Parameters: | scalingCenter (`NXOpen.Features.StudioXformBuilderExScalingCenterType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ScalingCenterPoint

`StudioXformBuilderEx.``ScalingCenterPoint`

  Returns or sets the scaling center point

  `-------------------------------------`

  Getter Method

  Signature `ScalingCenterPoint`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScalingCenterPoint`

  Parameters: | scalingCenterPoint (`NXOpen.Point`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ScalingDirection

`StudioXformBuilderEx.``ScalingDirection`

  Returns or sets the scaling direction

  `-------------------------------------`

  Getter Method

  Signature `ScalingDirection`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExScalingDirectionType`

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScalingDirection`

  Parameters: | scalingDirection (`NXOpen.Features.StudioXformBuilderExScalingDirectionType`) –

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SurfaceRange

`StudioXformBuilderEx.``SurfaceRange`

  Returns the surface range

  `-------------------------------------`

  Getter Method

  Signature `SurfaceRange`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.SurfaceRangeBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Type

`StudioXformBuilderEx.``Type`

  Returns or sets the editing type

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.StudioXformBuilderExTypes`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.StudioXformBuilderExTypes`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## XformOX

`StudioXformBuilderEx.``XformOX`

  Returns the orient express object

  `-------------------------------------`

  Getter Method

  Signature `XformOX`

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

  New in version NX7.0.0.

  License requirements: None.

## XformObjects

`StudioXformBuilderEx.``XformObjects`

  Returns the object to be transformed.

  Any face having b-surface type geometry or curve having b-curve geometry can be transformed.

  `-------------------------------------`

  Getter Method

  Signature `XformObjects`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## ChangeDegree

`StudioXformBuilderEx.``ChangeDegree`

  Changes degree of the selected xform object

  Signature `ChangeDegree(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to change degree of

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.ChangeDegreeWithParameters()` instead.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ChangeDegreeWithParameters

`StudioXformBuilderEx.``ChangeDegreeWithParameters`

  Changes degree of the selected xform object with desired parameters

  Signature `ChangeDegreeWithParameters(xformObject, uDegree, vDegree, uPatch, vPatch)`

  Parameters:

  - xformObject (`NXOpen.NXObject`) – the selected face or curve to change degree of
  - uDegree (int) – the U degree to change to, valid range is [1, 24]
  - vDegree (int) – the V degree to change to, valid range is [1, 24]
  - uPatch (int) – the U patch to change to, valid value is greater than 1
  - vPatch (int) – the V patch to change to, valid value is greater than 1

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ChangeFlexibility

`StudioXformBuilderEx.``ChangeFlexibility`

  Changes flexibility of the selected xform object

  Signature `ChangeFlexibility(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to change flexibility of

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ConvertParameters

`StudioXformBuilderEx.``ConvertParameters`

  Converts parameters of the feature that owns selected xform object.

  Converts through points studio spline feature to by poles feature, otherwise removes parameters of the feature.

  Signature `ConvertParameters(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to convert pameters from

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## EndLockRegion

`StudioXformBuilderEx.``EndLockRegion`

  End Lock Region operation to the selected xform object

  Signature `EndLockRegion(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to end Lock Region operation of

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## FallOffReset

`StudioXformBuilderEx.``FallOffReset`

  Reset the fall off scale

  Signature `FallOffReset()`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InsertKnot

`StudioXformBuilderEx.``InsertKnot`

  Inserts knot in the selected xform object

  Signature `InsertKnot(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to insert knot in

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InsertKnots

`StudioXformBuilderEx.``InsertKnots`

  Insert knots

  Signature `InsertKnots()`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InsertPole

`StudioXformBuilderEx.``InsertPole`

  Inserts a pole in the selected xform object

  Signature `InsertPole(xformObject, poleIndex, insertType, direction, location)`

  Parameters:

  - xformObject (`NXOpen.NXObject`) – the selected face or curve to insert pole to
  - poleIndex (int) – which pole index to begin insert to
  - insertType (`NXOpen.Features.StudioXformBuilderExInsertPoleType`) – Insert type
  - direction (`NXOpen.Features.StudioXformBuilderExSurfaceDirectionType`) – U or V direction a pole row on a surface is inserted, pass U direction for a curve
  - location (float) – a point between 2 poles to indicate where a pole should be inserted, express as %

  New in version NX8.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## LockRegionNextObject

`StudioXformBuilderEx.``LockRegionNextObject`

  Move to next object in Lock Region method when more than one objected are in editing

  Signature `LockRegionNextObject()`

  New in version NX8.5.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ProportionalReset

`StudioXformBuilderEx.``ProportionalReset`

  Reset the proportional scale

  Signature `ProportionalReset()`

  New in version NX6.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Features.StudioXformBuilderEx.FallOffReset()` instead.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RebaseOriginalGeometry

`StudioXformBuilderEx.``RebaseOriginalGeometry`

  Replaces the original geometry data of an entity with the current deformed geometry data

  Signature `RebaseOriginalGeometry(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to rebase the geometry data of

  New in version NX8.0.1.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RemovePole

`StudioXformBuilderEx.``RemovePole`

  Inserts a pole in the selected xform object

  Signature `RemovePole(xformObject, poleIndex, direction)`

  Parameters:

  - xformObject (`NXOpen.NXObject`) – the selected face or curve to remove pole from
  - poleIndex (int) – which pole index to remove
  - direction (`NXOpen.Features.StudioXformBuilderExSurfaceDirectionType`) – U or V direction a pole row on a surface is removed, pass U direction for a curve

  New in version NX8.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## RestoreParentFace

`StudioXformBuilderEx.``RestoreParentFace`

  Restore the parent face of a selection face

  Signature `RestoreParentFace()`

  New in version NX7.5.2.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SetPoleEditType

`StudioXformBuilderEx.``SetPoleEditType`

  Update pole status of the selected BSpine curve

  Signature `SetPoleEditType(xformObject, index, poleEditType)`

  Parameters:

  - xformObject (`NXOpen.NXObject`) – spline being edited
  - index (int) – index of a pole being edited
  - poleEditType (`NXOpen.Features.StudioXformBuilderExPoleEditType`) – the pole edit type

  New in version NX7.5.4.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## UpdateLockRegionGeometry

`StudioXformBuilderEx.``UpdateLockRegionGeometry`

  Update lock region geometry with current geometry

  Signature `UpdateLockRegionGeometry(xformObject)`

  Parameters: | xformObject (`NXOpen.NXObject`) – the selected face or curve to change flexibility of

  New in version NX6.0.2.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## Validate

`StudioXformBuilderEx.``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.