SketchEllipseBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SketchEllipseBuilder Class

class `NXOpen.``SketchEllipseBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.SketchEllipseBuilder` builder

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

  Default values.

  Property | Value
  --- | ---
  Closed | true
  EndAngle.Value | 360
  MajorRadius.Value | 50 (millimeters part), 2 (inches part)
  MinorRadius.Value | 25 (millimeters part), 1 (inches part)
  RotationAngle.Value | 0
  StartAngle.Value | 0

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
CenterPoint | Returns or sets the center point
Closed | Returns or sets the closed flag
EndAngle | Returns the end angle
MajorPoint | Returns or sets the point in major axis to calculate the major radius
MajorRadius | Returns the major radius
MinorPoint | Returns or sets the point in minor axis to calculate the minor radius
MinorRadius | Returns the minor radius
RotationAngle | Returns the rotation angle
StartAngle | Returns the start angle
Tag | Returns the Tag for this object.

# 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.
HandleComplement | Adjust the constraints and dimensions on ellipse vertices when we want to complement the ellipse
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

## CenterPoint

`SketchEllipseBuilder.``CenterPoint`

  Returns or sets the center point

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

  Getter Method

  Signature `CenterPoint`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CenterPoint`

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

  New in version NX6.0.0.

  License requirements: None.

## Closed

`SketchEllipseBuilder.``Closed`

  Returns or sets the closed flag

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

  Getter Method

  Signature `Closed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Closed`

  Parameters: | closed (bool) –

  New in version NX6.0.0.

  License requirements: None.

## EndAngle

`SketchEllipseBuilder.``EndAngle`

  Returns the end angle

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

  Getter Method

  Signature `EndAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## MajorPoint

`SketchEllipseBuilder.``MajorPoint`

  Returns or sets the point in major axis to calculate the major radius

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

  Getter Method

  Signature `MajorPoint`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MajorPoint`

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

  New in version NX6.0.0.

  License requirements: None.

## MajorRadius

`SketchEllipseBuilder.``MajorRadius`

  Returns the major radius

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

  Getter Method

  Signature `MajorRadius`

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

  New in version NX6.0.0.

  License requirements: None.

## MinorPoint

`SketchEllipseBuilder.``MinorPoint`

  Returns or sets the point in minor axis to calculate the minor radius

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

  Getter Method

  Signature `MinorPoint`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MinorPoint`

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

  New in version NX6.0.0.

  License requirements: None.

## MinorRadius

`SketchEllipseBuilder.``MinorRadius`

  Returns the minor radius

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

  Getter Method

  Signature `MinorRadius`

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

  New in version NX6.0.0.

  License requirements: None.

## RotationAngle

`SketchEllipseBuilder.``RotationAngle`

  Returns the rotation angle

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

  Getter Method

  Signature `RotationAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## StartAngle

`SketchEllipseBuilder.``StartAngle`

  Returns the start angle

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

  Getter Method

  Signature `StartAngle`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## HandleComplement

`SketchEllipseBuilder.``HandleComplement`

  Adjust the constraints and dimensions on ellipse vertices when we want to complement the ellipse

  Signature `HandleComplement()`

  New in version NX10.0.0.

  License requirements: None.

## Validate

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