GridCollection Class

class NXOpen.Display.GridCollection

Bases: object

Represents a collection of plane grid objects

To obtain an instance of this class, refer to NXOpen.BasePart

New in version NX6.0.0.

Methods

Method	Description
CreateDatumPlaneGridBuilder	Creates a NXOpen.Display.DatumPlaneGridBuilder object used to edit the supplied datum plane grid.
CreatePlanarShipGridBuilder	Creates a NXOpen.Display.PlanarShipGridBuilder object used to build a planar ship grid on a datum plane.
CreatePlaneGridBuilder	Creates a NXOpen.Display.PlaneGridBuilder object used to build a bounded grid on a plane.
FindObject	Finds the NXOpen.Display.Grid with the given identifier as recorded in a journal.
GetDatumPlaneGrid	Finds the datum grid associated with the specified datum plane.

Method Detail

CreateDatumPlaneGridBuilder

GridCollection.CreateDatumPlaneGridBuilder

Overloaded method CreateDatumPlaneGridBuilder

• CreateDatumPlaneGridBuilder(grid)
• CreateDatumPlaneGridBuilder(datumPlanes)

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

Creates a NXOpen.Display.DatumPlaneGridBuilder object used to edit the supplied datum plane grid.

Signature CreateDatumPlaneGridBuilder(grid)

Parameters:grid (NXOpen.Display.DatumPlaneGrid) – If grid is not None, then this object will be edited Returns:datum plane grid builder Return type:NXOpen.Display.DatumPlaneGridBuilder

New in version NX6.0.0.

License requirements: None.

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

Creates a NXOpen.Display.DatumPlaneGridBuilder object used to build datum plane grids based on the supplied datum plane list.

Signature CreateDatumPlaneGridBuilder(datumPlanes)

Parameters:datumPlanes (list of NXOpen.DatumPlane) – datum plane list Returns:datum plane grid builder Return type:NXOpen.Display.DatumPlaneGridBuilder

New in version NX6.0.0.

License requirements: None.

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

CreatePlanarShipGridBuilder

GridCollection.CreatePlanarShipGridBuilder

Creates a NXOpen.Display.PlanarShipGridBuilder object used to build a planar ship grid on a datum plane.

If the grid is not None, the planar ship grid object will be edited.

Signature CreatePlanarShipGridBuilder(grid)

Parameters:grid (NXOpen.Display.PlanarShipGrid) – If grid is not None, this object will be edited Returns:planar ship grid builder Return type:NXOpen.Display.PlanarShipGridBuilder

New in version NX8.0.0.

License requirements: nx_ship_concept (“Ship Concept”)

CreatePlaneGridBuilder

GridCollection.CreatePlaneGridBuilder

Creates a NXOpen.Display.PlaneGridBuilder object used to build a bounded grid on a plane.

If the grid is not None, the planar grid object will be edited.

Signature CreatePlaneGridBuilder(grid)

Parameters:grid (NXOpen.Display.PlaneGrid) – If grid is not None, then this object will be edited Returns:plane grid builder Return type:NXOpen.Display.PlaneGridBuilder

New in version NX6.0.0.

License requirements: None.

FindObject

GridCollection.FindObject

Finds the NXOpen.Display.Grid with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general,this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Identifier to be found Returns:Grid found Return type:NXOpen.Display.Grid

New in version NX6.0.0.

License requirements: None.

GetDatumPlaneGrid

GridCollection.GetDatumPlaneGrid

Finds the datum grid associated with the specified datum plane.

Signature GetDatumPlaneGrid(datumPlane)

Parameters:datumPlane (NXOpen.DatumPlane) – datum plane Returns:Datum plane grid. None indicates no grid is associated

with the datum plane. :rtype: NXOpen.Display.DatumPlaneGrid

New in version NX6.0.0.

License requirements: None.