BoundedGridBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BoundedGridBuilder Class

class `NXOpen.Display.``BoundedGridBuilder`

  Bases: `NXOpen.Display.GridBuilder`

  Represents the builder for creating a bounded grid `NXOpen.Display.BoundedGrid`.

  This is an abstract class, and cannot be instantiated.

  Default values.

  Property | Value
  --- | ---
  SectionCurveSettings.ColorOption | Any
  SectionCurveSettings.Show | false

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the associative
LabelReference | Returns or sets the label reference
LineColor | Returns or sets the line color
LocalOrigin | Returns or sets the local origin
MajorLineSpacing | Returns or sets the major line spacing
MajorLineStyle | Returns or sets the major line style
MajorLineWeight | Returns or sets the major line weight
MinorLineStyle | Returns or sets the minor line style
MinorLineWeight | Returns or sets the minor line weight
MinorLinesPerMajor | Returns or sets the minor lines per major
SectionCurveSettings | Returns the curve settings builder
Show | Returns or sets the show
ShowLabel | Returns or sets the show labels
ShowMajorLines | Returns or sets the show major lines
ShowOnTop | Returns or sets the show on top
SnapPointsPerMinor | Returns or sets the snap points per minor
SnapToGrid | Returns or sets the snap to grid
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.
GetCornerPoints | Gets corner points of the grid
GetObject | Returns the object currently being edited by this builder.
InheritSettings | Inherits the settings from the specified grid.
SaveCurves | Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.
SetCornerPoints | Sets corner points of the grid
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.

# Enumerations

BoundedGridBuilderLabelReferenceType Enumeration | Specifies label reference.
BoundedGridBuilderShowLabelType Enumeration | Specifies label option to be used for grid label display.

# Property Detail

## Associative

`BoundedGridBuilder.``Associative`

  Returns or sets the associative

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX6.0.0.

  License requirements: None.

## LabelReference

`BoundedGridBuilder.``LabelReference`

  Returns or sets the label reference

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

  Getter Method

  Signature `LabelReference`

  Returns: |
  Return type: | `NXOpen.Display.BoundedGridBuilderLabelReferenceType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelReference`

  Parameters: | labelReference (`NXOpen.Display.BoundedGridBuilderLabelReferenceType`) –

  New in version NX6.0.0.

  License requirements: None.

## LocalOrigin

`BoundedGridBuilder.``LocalOrigin`

  Returns or sets the local origin

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

  Getter Method

  Signature `LocalOrigin`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LocalOrigin`

  Parameters: | localOrigin (`NXOpen.Point3d`) – Label origin

  New in version NX6.0.0.

  License requirements: None.

## SectionCurveSettings

`BoundedGridBuilder.``SectionCurveSettings`

  Returns the curve settings builder

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

  Getter Method

  Signature `SectionCurveSettings`

  Returns: |
  Return type: | `NXOpen.Display.SectionCurveSettingsBuilder`

  New in version NX6.0.0.

  License requirements: None.

## ShowLabel

`BoundedGridBuilder.``ShowLabel`

  Returns or sets the show labels

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

  Getter Method

  Signature `ShowLabel`

  Returns: |
  Return type: | `NXOpen.Display.BoundedGridBuilderShowLabelType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowLabel`

  Parameters: | showLabelType (`NXOpen.Display.BoundedGridBuilderShowLabelType`) –

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## GetCornerPoints

`BoundedGridBuilder.``GetCornerPoints`

  Gets corner points of the grid

  Signature `GetCornerPoints()`

  Returns: | a tuple
  Return type: | A tuple consisting of (validCornerPoints, point1, point2, point3, point4). validCornerPoints is a bool. Flag indicating whether the corner points are valid point1 is a `NXOpen.Point3d`. First corner point point2 is a `NXOpen.Point3d`. Second corner point point3 is a `NXOpen.Point3d`. Third corner point point4 is a `NXOpen.Point3d`. Fourth corner point

  New in version NX6.0.0.

  License requirements: None.

## SaveCurves

`BoundedGridBuilder.``SaveCurves`

  Creates curves by intersecting the bounded grid with all bodies in the part of the grid object.

  The bodies that are visible in the work view are intersected. The curves are added to the group created with the specified name. The group is displayed in the part navigator. The curves are created in the work part. These curves are not associated with the grid. These are just snapshot curves that can be used for modeling purposes. If the customer default “Load Solids/Sheets when Saving Section Curves” is enabled, the Save Copy of Section Curves command in the datum plane grid dialog will cause solid/sheet bodies to be loaded into memory for any visible lightweight bodies on the section plane. This may increase the time and memory used by the operation, but will ensure fully accurate section curves.

  Signature `SaveCurves(groupName)`

  Parameters: | groupName (str) – Name of the group containing curves. If None, a default name will be used.

  New in version NX6.0.0.

  License requirements: None.

## SetCornerPoints

`BoundedGridBuilder.``SetCornerPoints`

  Sets corner points of the grid

  Signature `SetCornerPoints(point1, point2, point3, point4)`

  Parameters:

  - point1 (`NXOpen.Point3d`) – First corner point
  - point2 (`NXOpen.Point3d`) – Second corner point
  - point3 (`NXOpen.Point3d`) – Third corner point
  - point4 (`NXOpen.Point3d`) – Fourth corner point

  Returns: | Flag indicating whether the

  corner points are valid :rtype: bool

  New in version NX6.0.0.

  License requirements: None.

## Validate

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