SnipSurfaceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SnipSurfaceBuilder Class

class `NXOpen.Features.``SnipSurfaceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.SnipSurface` builder

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

  Default values.

  Property | Value
  --- | ---
  RefitControl.DegreesAndSegmentsOrPatches.Degree | 3
  RefitControl.DegreesAndSegmentsOrPatches.SegmentsOrPatches | 1
  RefitControl.DegreesAndSegmentsOrPatches.UDegree | 5
  RefitControl.DegreesAndSegmentsOrPatches.UPatches | 1
  RefitControl.DegreesAndSegmentsOrPatches.VDegree | 5
  RefitControl.DegreesAndSegmentsOrPatches.VPatches | 1

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
CutType | Returns or sets the cutting type
DivideSurface | Returns or sets a value indicating whether to divide the surface
EditCopy | Returns or sets a value indicating whether to keep the original surface intact
IsoparametricPosition | Returns the isoparametric position
KeepOppositeSurface | Returns or sets a value indicating whether to keep the opposite surface.
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
ProjectDirection | Returns the project direction
RefitControl | Returns the refit control
RegionPickPoint | Returns or sets the 3D point picked on surface in Select Face
SelectUV | Returns or sets the UV flag
SnippingCurve | Returns the snipping curve
SnippingObject | Returns the snipping object
SnippingPlane | Returns or sets the snipping plane
SurfacePointUV | Returns or sets the UV values of the picked point on surface
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TargetFace | Returns the target face
Type | Returns or sets the snipping method accessor

# 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.
GetCreateNewCopy | Returns the indicator for creating a new copy
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.
SetCreateNewCopy | Sets the indicator for creating a new copy
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

SnipSurfaceBuilderTypes Enumeration | Snip method added in v 7.

# Property Detail

## CutType

`SnipSurfaceBuilder.``CutType`

  Returns or sets the cutting type

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

  Getter Method

  Signature `CutType`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `CutType`

  Parameters: | cutType (int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## DivideSurface

`SnipSurfaceBuilder.``DivideSurface`

  Returns or sets a value indicating whether to divide the surface

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

  Getter Method

  Signature `DivideSurface`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `DivideSurface`

  Parameters: | divide (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## EditCopy

`SnipSurfaceBuilder.``EditCopy`

  Returns or sets a value indicating whether to keep the original surface intact

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

  Getter Method

  Signature `EditCopy`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `EditCopy`

  Parameters: | editCopy (bool) –

  New in version NX7.5.0.

  License requirements: None.

## IsoparametricPosition

`SnipSurfaceBuilder.``IsoparametricPosition`

  Returns the isoparametric position

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

  Getter Method

  Signature `IsoparametricPosition`

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

  New in version NX7.5.0.

  License requirements: None.

## KeepOppositeSurface

`SnipSurfaceBuilder.``KeepOppositeSurface`

  Returns or sets a value indicating whether to keep the opposite surface.

  This is applicable only when DivideSurface is false

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

  Getter Method

  Signature `KeepOppositeSurface`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `KeepOppositeSurface`

  Parameters: | switchRegion (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## ProjectDirection

`SnipSurfaceBuilder.``ProjectDirection`

  Returns the project direction

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

  Getter Method

  Signature `ProjectDirection`

  Returns: | Projection Options data
  Return type: | `NXOpen.GeometricUtilities.ProjectionOptions`

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## RefitControl

`SnipSurfaceBuilder.``RefitControl`

  Returns the refit control

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

  Getter Method

  Signature `RefitControl`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## RegionPickPoint

`SnipSurfaceBuilder.``RegionPickPoint`

  Returns or sets the 3D point picked on surface in Select Face

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

  Getter Method

  Signature `RegionPickPoint`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `RegionPickPoint`

  Parameters: | pnt (`NXOpen.Point3d`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SelectUV

`SnipSurfaceBuilder.``SelectUV`

  Returns or sets the UV flag

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

  Getter Method

  Signature `SelectUV`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectUV`

  Parameters: | selectUV (int) –

  New in version NX7.5.0.

  License requirements: None.

## SnippingCurve

`SnipSurfaceBuilder.``SnippingCurve`

  Returns the snipping curve

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

  Getter Method

  Signature `SnippingCurve`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SnippingObject

`SnipSurfaceBuilder.``SnippingObject`

  Returns the snipping object

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

  Getter Method

  Signature `SnippingObject`

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

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SnippingPlane

`SnipSurfaceBuilder.``SnippingPlane`

  Returns or sets the snipping plane

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

  Getter Method

  Signature `SnippingPlane`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `SnippingPlane`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SurfacePointUV

`SnipSurfaceBuilder.``SurfacePointUV`

  Returns or sets the UV values of the picked point on surface

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

  Getter Method

  Signature `SurfacePointUV`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `SurfacePointUV`

  Parameters: | surfacePointUV (`NXOpen.Point3d`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## TargetFace

`SnipSurfaceBuilder.``TargetFace`

  Returns the target face

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

  Getter Method

  Signature `TargetFace`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## Type

`SnipSurfaceBuilder.``Type`

  Returns or sets the snipping method accessor

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

  Getter Method

  Signature `Type`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

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

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## GetCreateNewCopy

`SnipSurfaceBuilder.``GetCreateNewCopy`

  Returns the indicator for creating a new copy

  Signature `GetCreateNewCopy()`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SetCreateNewCopy

`SnipSurfaceBuilder.``SetCreateNewCopy`

  Sets the indicator for creating a new copy

  Signature `SetCreateNewCopy(createNewCopy)`

  Parameters: | createNewCopy (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## Validate

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