NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Display.GridCollection Class Reference

Represents a collection of plane grid objects More...

Inheritance diagram for NXOpen.Display.GridCollection:

Public Member Functions

NXOpen.Display.Grid[] ToArray ()
 Returns an array of NXOpen.Display.Grid objects. More...
 
unsafe
NXOpen.Display.PlaneGridBuilder 
CreatePlaneGridBuilder (NXOpen.Display.PlaneGrid grid)
 Creates a NXOpen.Display.PlaneGridBuilder object used to build a bounded grid on a plane. More...
 
unsafe
NXOpen.Display.DatumPlaneGridBuilder 
CreateDatumPlaneGridBuilder (NXOpen.Display.DatumPlaneGrid grid)
 Creates a NXOpen.Display.DatumPlaneGridBuilder object used to edit the supplied datum plane grid. More...
 
unsafe
NXOpen.Display.DatumPlaneGridBuilder 
CreateDatumPlaneGridBuilder (NXOpen.DatumPlane[] datumPlanes)
 Creates a NXOpen.Display.DatumPlaneGridBuilder object used to build datum plane grids based on the supplied datum plane list. More...
 
unsafe NXOpen.Display.Grid FindObject (string journalIdentifier)
 Finds the NXOpen.Display.Grid with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.Display.DatumPlaneGrid 
GetDatumPlaneGrid (NXOpen.DatumPlane datumPlane)
 Finds the datum grid associated with the specified datum plane. More...
 
unsafe
NXOpen.Display.PlanarShipGridBuilder 
CreatePlanarShipGridBuilder (NXOpen.Display.PlanarShipGrid grid)
 Creates a NXOpen.Display.PlanarShipGridBuilder object used to build a planar ship grid on a datum plane. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of plane grid objects

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

Created in NX6.0.0

Member Function Documentation

unsafe NXOpen.Display.DatumPlaneGridBuilder NXOpen.Display.GridCollection.CreateDatumPlaneGridBuilder ( NXOpen.Display.DatumPlaneGrid  grid)

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

Created in NX6.0.0

License requirements: None.

Parameters
gridIf grid is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
datum plane grid builder
unsafe NXOpen.Display.DatumPlaneGridBuilder NXOpen.Display.GridCollection.CreateDatumPlaneGridBuilder ( NXOpen.DatumPlane[]  datumPlanes)

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

Created in NX6.0.0

License requirements: None.

Parameters
datumPlanesdatum plane list
Returns
datum plane grid builder
unsafe NXOpen.Display.PlanarShipGridBuilder NXOpen.Display.GridCollection.CreatePlanarShipGridBuilder ( NXOpen.Display.PlanarShipGrid  grid)

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

If the grid is not a null reference (Nothing in Visual Basic), the planar ship grid object will be edited.

Created in NX8.0.0

License requirements: nx_ship_concept ("Ship Concept")

Parameters
gridIf grid is not a null reference (Nothing in Visual Basic), this object will be edited
Returns
planar ship grid builder
unsafe NXOpen.Display.PlaneGridBuilder NXOpen.Display.GridCollection.CreatePlaneGridBuilder ( NXOpen.Display.PlaneGrid  grid)

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

If the grid is not a null reference (Nothing in Visual Basic), the planar grid object will be edited.

Created in NX6.0.0

License requirements: None.

Parameters
gridIf grid is not a null reference (Nothing in Visual Basic), then this object will be edited
Returns
plane grid builder
override int NXOpen.Display.GridCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.Display.Grid NXOpen.Display.GridCollection.FindObject ( string  journalIdentifier)

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.

Created in NX6.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier to be found
Returns
Grid found
unsafe NXOpen.Display.DatumPlaneGrid NXOpen.Display.GridCollection.GetDatumPlaneGrid ( NXOpen.DatumPlane  datumPlane)

Finds the datum grid associated with the specified datum plane.

Created in NX6.0.0

License requirements: None.

Parameters
datumPlanedatum plane
Returns
Datum plane grid. a null reference (Nothing in Visual Basic) indicates no grid is associated with the datum plane.
NXOpen.Display.Grid [] NXOpen.Display.GridCollection.ToArray ( )

Returns an array of NXOpen.Display.Grid objects.

Property Documentation

Tag NXOpen.Display.GridCollection.Tag
get

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.