RuledBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RuledBuilder Class

class `NXOpen.Features.``RuledBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.Ruled` builder

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

  Default values.

  Property | Value
  --- | ---
  AlignmentMethod.AlignType | Parameter
  IsShapePreserved | True

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AlignmentMethod | Returns the alignment method
BodyPreference | Returns or sets the body type options
FirstSection | Returns or sets the first section
IsShapePreserved | Returns or sets the preserve shape flag.
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
PositionTolerance | Returns or sets the position tolerance
SecondSection | Returns or sets the second section
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# 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.

# Property Detail

## AlignmentMethod

`RuledBuilder.``AlignmentMethod`

  Returns the alignment method

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

  Getter Method

  Signature `AlignmentMethod`

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

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## BodyPreference

`RuledBuilder.``BodyPreference`

  Returns or sets the body type options

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

  Getter Method

  Signature `BodyPreference`

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

  New in version NX7.5.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `BodyPreference`

  Parameters: | featureOptions (`NXOpen.GeometricUtilities.FeatureOptions`) –

  New in version NX7.5.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

## FirstSection

`RuledBuilder.``FirstSection`

  Returns or sets the first section

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

  Getter Method

  Signature `FirstSection`

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

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `FirstSection`

  Parameters: | section (`NXOpen.Section`) –

  New in version NX7.5.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

## IsShapePreserved

`RuledBuilder.``IsShapePreserved`

  Returns or sets the preserve shape flag.

  When preserve shape is used, the input curves will not be approximated in constructing the ruled surface. Only Parameter and By Points alignment options are allowed if preserve shape is used.

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

  Getter Method

  Signature `IsShapePreserved`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `IsShapePreserved`

  Parameters: | isShapePreserved (bool) –

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

## PositionTolerance

`RuledBuilder.``PositionTolerance`

  Returns or sets the position tolerance

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

  Getter Method

  Signature `PositionTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `PositionTolerance`

  Parameters: | positionTolerance (float) –

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SecondSection

`RuledBuilder.``SecondSection`

  Returns or sets the second section

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

  Getter Method

  Signature `SecondSection`

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

  New in version NX6.0.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `SecondSection`

  Parameters: | section (`NXOpen.Section`) –

  New in version NX7.5.0.

  License requirements: features_modeling (“FEATURES MODELING”) OR nx_freeform_1 (“basic freeform modeling”)

# Method Detail

## Validate

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