InferredConstraintsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# InferredConstraintsBuilder Class

class `NXOpen.``InferredConstraintsBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.InferredConstraintsBuilder`

  To create a new instance of this class, use `NXOpen.SketchCollection.CreateInferredConstraintsBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Coincident | Returns or sets the coincident infer-constraint setting.
Collinear | Returns or sets the collinear infer-constraint setting.
Concentric | Returns or sets the concentric infer-constraint setting.
DimensionalConstraint | Returns or sets the dimensional constraint infer-constraint setting.
EqualLength | Returns or sets the equal length infer-constraint setting.
EqualRadius | Returns or sets the equal radius infer-constraint setting.
Horizontal | Returns or sets the horizontal infer-constraint setting.
HorizontalAlignment | Returns or sets the horizontal alignment infer-constraint setting.
Midpoint | Returns or sets the midpoint infer-constraint setting.
Parallel | Returns or sets the parallel infer-constraint setting.
Perpendicular | Returns or sets the perpendicular infer-constraint setting.
PointOnCurve | Returns or sets the point on curve infer-constraint setting.
PointOnString | Returns or sets the point on string infer-constraint setting.
PreferStringConstraints | Returns or sets the prefer string constraints setting.
Tag | Returns the Tag for this object.
Tangent | Returns or sets the tangent infer-constraint setting.
Vertical | Returns or sets the vertical infer-constraint setting.
VerticalAlignment | Returns or sets the vertical alignment infer-constraint setting.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetObject | Returns the object currently being edited by this builder.
GetRules | Get the auto dimensioning rule list into an array
SetRules | Set the auto dimensioning rule list to builder
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## Coincident

`InferredConstraintsBuilder.``Coincident`

  Returns or sets the coincident infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all coincident entities created after this command.

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

  Getter Method

  Signature `Coincident`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Coincident`

  Parameters: | coincident (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Collinear

`InferredConstraintsBuilder.``Collinear`

  Returns or sets the collinear infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all collinear entities created after this command.

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

  Getter Method

  Signature `Collinear`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Collinear`

  Parameters: | collinear (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Concentric

`InferredConstraintsBuilder.``Concentric`

  Returns or sets the concentric infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all concentric entities created after this command.

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

  Getter Method

  Signature `Concentric`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Concentric`

  Parameters: | concentric (bool) –

  New in version NX5.0.0.

  License requirements: None.

## DimensionalConstraint

`InferredConstraintsBuilder.``DimensionalConstraint`

  Returns or sets the dimensional constraint infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create dimensional constraints automatically for entities created after this command.

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

  Getter Method

  Signature `DimensionalConstraint`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DimensionalConstraint`

  Parameters: | dimensionalConstraint (bool) –

  New in version NX5.0.0.

  License requirements: None.

## EqualLength

`InferredConstraintsBuilder.``EqualLength`

  Returns or sets the equal length infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all entities having equal length and created after this command.

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

  Getter Method

  Signature `EqualLength`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EqualLength`

  Parameters: | equalLength (bool) –

  New in version NX5.0.0.

  License requirements: None.

## EqualRadius

`InferredConstraintsBuilder.``EqualRadius`

  Returns or sets the equal radius infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all entities with equal radius and created after this command.

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

  Getter Method

  Signature `EqualRadius`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EqualRadius`

  Parameters: | equalRadius (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Horizontal

`InferredConstraintsBuilder.``Horizontal`

  Returns or sets the horizontal infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all horizonal entities created after this command.

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

  Getter Method

  Signature `Horizontal`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Horizontal`

  Parameters: | horizontal (bool) –

  New in version NX5.0.0.

  License requirements: None.

## HorizontalAlignment

`InferredConstraintsBuilder.``HorizontalAlignment`

  Returns or sets the horizontal alignment infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all horizontally aligned entities created after this command.

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

  Getter Method

  Signature `HorizontalAlignment`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `HorizontalAlignment`

  Parameters: | horizontalAlign (bool) –

  New in version NX11.0.0.

  License requirements: None.

## Midpoint

`InferredConstraintsBuilder.``Midpoint`

  Returns or sets the midpoint infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all midpoints created after this command.

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

  Getter Method

  Signature `Midpoint`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Midpoint`

  Parameters: | midpoint (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Parallel

`InferredConstraintsBuilder.``Parallel`

  Returns or sets the parallel infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all parallel entities created after this command.

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

  Getter Method

  Signature `Parallel`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Parallel`

  Parameters: | parallel (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Perpendicular

`InferredConstraintsBuilder.``Perpendicular`

  Returns or sets the perpendicular infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all perpendicular entities created after this command.

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

  Getter Method

  Signature `Perpendicular`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Perpendicular`

  Parameters: | perpendicular (bool) –

  New in version NX5.0.0.

  License requirements: None.

## PointOnCurve

`InferredConstraintsBuilder.``PointOnCurve`

  Returns or sets the point on curve infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all points on curves created after this command.

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

  Getter Method

  Signature `PointOnCurve`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointOnCurve`

  Parameters: | pointOnCurve (bool) –

  New in version NX5.0.0.

  License requirements: None.

## PointOnString

`InferredConstraintsBuilder.``PointOnString`

  Returns or sets the point on string infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all points on strings created after this command.

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

  Getter Method

  Signature `PointOnString`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  Deprecated since version NX11.0.0: Please use `NXOpen.InferredConstraintsBuilder.PreferStringConstraints`()`

  License requirements: None.

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

  Setter Method

  Signature `PointOnString`

  Parameters: | pointOnString (bool) –

  New in version NX5.0.0.

  Deprecated since version NX11.0.0: Please use `NXOpen.InferredConstraintsBuilder.PreferStringConstraints`()`

  License requirements: None.

## PreferStringConstraints

`InferredConstraintsBuilder.``PreferStringConstraints`

  Returns or sets the prefer string constraints setting.

  If this flag is switched ON, the sketcher will create constraint on string type constraints automatically for all point on curve, tangent, and perpendicular constraints inferred to a string of curves after this command.

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

  Getter Method

  Signature `PreferStringConstraints`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PreferStringConstraints`

  Parameters: | preferStringCons (bool) –

  New in version NX11.0.0.

  License requirements: None.

## Tangent

`InferredConstraintsBuilder.``Tangent`

  Returns or sets the tangent infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all tangent entities created after this command.

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

  Getter Method

  Signature `Tangent`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Tangent`

  Parameters: | tangent (bool) –

  New in version NX5.0.0.

  License requirements: None.

## Vertical

`InferredConstraintsBuilder.``Vertical`

  Returns or sets the vertical infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all vertical entities created after this command.

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

  Getter Method

  Signature `Vertical`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Vertical`

  Parameters: | vertical (bool) –

  New in version NX5.0.0.

  License requirements: None.

## VerticalAlignment

`InferredConstraintsBuilder.``VerticalAlignment`

  Returns or sets the vertical alignment infer-constraint setting.

  If this constraint flag is switched ON, sketcher will create this constraint automatically for all vertically aligned entities created after this command.

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

  Getter Method

  Signature `VerticalAlignment`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `VerticalAlignment`

  Parameters: | verticalAlign (bool) –

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## GetRules

`InferredConstraintsBuilder.``GetRules`

  Get the auto dimensioning rule list into an array

  Signature `GetRules()`

  Returns: |
  Return type: | list of `NXOpen.SketchAutoDimensioningRule`

  New in version NX7.5.0.

  License requirements: None.

## SetRules

`InferredConstraintsBuilder.``SetRules`

  Set the auto dimensioning rule list to builder

  Signature `SetRules(rules)`

  Parameters: | rules (list of `NXOpen.SketchAutoDimensioningRule`) – Auto Dimension Rules

  New in version NX7.5.0.

  License requirements: None.

## Validate

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