PlaneGridBuilder Class

class NXOpen.Display.PlaneGridBuilder

Bases: NXOpen.Display.BoundedGridBuilder

Represents the builder for adding a bounded grid NXOpen.Display.PlaneGrid to a plane.

To create a new instance of this class, use NXOpen.Display.GridCollection.CreatePlaneGridBuilder()

Default values.

Property Value
Associative 1
LabelReference Local
MajorLineSpacing 100 (millimeters part), 1 (inches part)
MajorLineStyle Solid
MajorLineWeight Normal
MinorLineStyle Dashed
MinorLineWeight Thin
MinorLinesPerMajor 1
Show 1
ShowLabel Always
ShowMajorLines 1
ShowOnTop 0
SnapPointsPerMinor 1
SnapToGrid 0

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
Plane Returns or sets the plane
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.

Property Detail

Plane

PlaneGridBuilder.Plane

Returns or sets the plane

-------------------------------------

Getter Method

Signature Plane

Returns:
Return type:NXOpen.Plane

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Plane

Parameters:plane (NXOpen.Plane) –

New in version NX6.0.0.

License requirements: None.

Method Detail

Validate

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