BlendSetbackBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BlendSetbackBuilder Class

class `NXOpen.GeometricUtilities.``BlendSetbackBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  This class provides ability to define a setback curve on a blend face.

  To create a new instance of this class, use `NXOpen.Part.CreateEmptyBlendSetbackBuilder()`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
Direction | Returns or sets the direction type
Face | Returns the blend face collector.
HandlePoint | Returns or sets the handle point for u/v direction.
IsDirectionFlipped | Returns or sets the flag indicating if the setback curve direction is flipped.
Plane | Returns or sets the setback plane.
SetbackPoint | Returns or sets the setback point for u/v direction.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

BlendSetbackBuilderDirections Enumeration | Setback direction options

# Property Detail

## Direction

`BlendSetbackBuilder.``Direction`

  Returns or sets the direction type

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

  Getter Method

  Signature `Direction`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Direction`

  Parameters: | direction (`NXOpen.GeometricUtilities.BlendSetbackBuilderDirections`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Face

`BlendSetbackBuilder.``Face`

  Returns the blend face collector.

  The collector can include faces from different blends.

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

  Getter Method

  Signature `Face`

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

  New in version NX9.0.0.

  License requirements: None.

## HandlePoint

`BlendSetbackBuilder.``HandlePoint`

  Returns or sets the handle point for u/v direction.

  The setback curve will pass through the handle point.

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

  Getter Method

  Signature `HandlePoint`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HandlePoint`

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

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## IsDirectionFlipped

`BlendSetbackBuilder.``IsDirectionFlipped`

  Returns or sets the flag indicating if the setback curve direction is flipped.

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

  Getter Method

  Signature `IsDirectionFlipped`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsDirectionFlipped`

  Parameters: | flipDirection (bool) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Plane

`BlendSetbackBuilder.``Plane`

  Returns or sets the setback plane.

  The setback curve will be the intersection curve between plane and face collector.

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

  Getter Method

  Signature `Plane`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Plane`

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

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetbackPoint

`BlendSetbackBuilder.``SetbackPoint`

  Returns or sets the setback point for u/v direction.

  This point is optional. If specified, it will replace the handle point and establish the associativity between the point and the setback curve. Once the handle point is changed through dragging, the associativity will be lost.

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

  Getter Method

  Signature `SetbackPoint`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SetbackPoint`

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

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

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