LawExtensionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LawExtensionBuilder Class

class `NXOpen.Features.``LawExtensionBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.LawExtension` builder

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

  Default values.

  Property | Value
  --- | ---
  AngleLaw.Function | ft
  AngleLaw.LawType | MultiTransition
  AngleLaw.Parameter | t
  LengthLaw.LawType | MultiTransition
  MergeFacesIfPossible | True
  OppositeSideLengthLaw.LawType | MultiTransition
  Rebuild.Degree | 3
  Rebuild.RebuildType | None

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AngleLaw | Returns the angle law
AngleTolerance | Returns or sets the angle tolerance
BaseProfile | Returns the base profile
DistanceTolerance | Returns or sets the distance tolerance
Faces | Returns the faces.
IsReferenceFaceNormalReversed | Returns or sets a value indicating whether to reverse the reference face normal.
LengthLaw | Returns the length law
MergeFacesIfPossible | Returns or sets a value indicating whether to merge the faces if possible
OppositeSideExtensionOption | Returns or sets the opposite side extension option
OppositeSideLengthLaw | Returns the opposite side length law.
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
Rebuild | Returns the rebuild data.
Spine | Returns the spine.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the type
Vector | Returns or sets the vector.

# 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

LawExtensionBuilderOppositeSideExtensionOptions Enumeration | Opposite side extension options
LawExtensionBuilderTypes Enumeration | Law extension creation types

# Property Detail

## AngleLaw

`LawExtensionBuilder.``AngleLaw`

  Returns the angle law

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

  Getter Method

  Signature `AngleLaw`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## AngleTolerance

`LawExtensionBuilder.``AngleTolerance`

  Returns or sets the angle tolerance

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

  Getter Method

  Signature `AngleTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `AngleTolerance`

  Parameters: | angleTolerance (float) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## BaseProfile

`LawExtensionBuilder.``BaseProfile`

  Returns the base profile

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

  Getter Method

  Signature `BaseProfile`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## DistanceTolerance

`LawExtensionBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | distanceTolerance (float) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## Faces

`LawExtensionBuilder.``Faces`

  Returns the faces.

  Faces are used only when `NXOpen.Features.LawExtensionBuilderTypes` is `NXOpen.Features.LawExtensionBuilderTypes.Faces`. The faces must be sew able to form a single sheet body. The normal of the sewed sheet body and base profile direction provide local reference co-ordinate system for the orientation of the surface rule lines.

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

  Getter Method

  Signature `Faces`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## IsReferenceFaceNormalReversed

`LawExtensionBuilder.``IsReferenceFaceNormalReversed`

  Returns or sets a value indicating whether to reverse the reference face normal.

  When `NXOpen.Features.LawExtensionBuilderTypes` is `NXOpen.Features.LawExtensionBuilderTypes.Faces`, the input faces are sewed to form a single sheet body. The normal of the sheet body is decided based on the face which is nearest to the parametric mid point of the base profile and acts as the reference face normal.

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

  Getter Method

  Signature `IsReferenceFaceNormalReversed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `IsReferenceFaceNormalReversed`

  Parameters: | reverseNormal (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## LengthLaw

`LawExtensionBuilder.``LengthLaw`

  Returns the length law

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

  Getter Method

  Signature `LengthLaw`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## MergeFacesIfPossible

`LawExtensionBuilder.``MergeFacesIfPossible`

  Returns or sets a value indicating whether to merge the faces if possible

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

  Getter Method

  Signature `MergeFacesIfPossible`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `MergeFacesIfPossible`

  Parameters: | mergeFacesIfPossible (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## OppositeSideExtensionOption

`LawExtensionBuilder.``OppositeSideExtensionOption`

  Returns or sets the opposite side extension option

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

  Getter Method

  Signature `OppositeSideExtensionOption`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `OppositeSideExtensionOption`

  Parameters: | oppositeSideExtension (`NXOpen.Features.LawExtensionBuilderOppositeSideExtensionOptions`) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## OppositeSideLengthLaw

`LawExtensionBuilder.``OppositeSideLengthLaw`

  Returns the opposite side length law.

  Opposite side extension law is required only when `NXOpen.Features.LawExtensionBuilderOppositeSideExtensionOptions` is `NXOpen.Features.LawExtensionBuilderOppositeSideExtensionOptions.Asymmetric`

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

  Getter Method

  Signature `OppositeSideLengthLaw`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## Rebuild

`LawExtensionBuilder.``Rebuild`

  Returns the rebuild data.

  This data is used to rebuild the surface in the base profile direction.

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

  Getter Method

  Signature `Rebuild`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## Spine

`LawExtensionBuilder.``Spine`

  Returns the spine.

  Spine is optional

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

  Getter Method

  Signature `Spine`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## Type

`LawExtensionBuilder.``Type`

  Returns or sets the type

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

  Getter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `Type`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

## Vector

`LawExtensionBuilder.``Vector`

  Returns or sets the vector.

  Vector is used only when `NXOpen.Features.LawExtensionBuilderTypes` is `NXOpen.Features.LawExtensionBuilderTypes.Vector`

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

  Getter Method

  Signature `Vector`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

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

  Setter Method

  Signature `Vector`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR free_form_modeling (“FREE-FORM MODELING”)

# Method Detail

## Validate

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