Represents a collection of plane grid objects
To obtain an instance of this class, refer to NXOpen::BasePart
Created in NX6.0.0.
More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
| iterator | begin () |
| Returns an iterator addressing the first element. More... | |
| NXOpen::Display::DatumPlaneGridBuilder * | CreateDatumPlaneGridBuilder (NXOpen::Display::DatumPlaneGrid *grid) |
| Creates a NXOpen::Display::DatumPlaneGridBuilder object used to edit the supplied datum plane grid. More... | |
| NXOpen::Display::DatumPlaneGridBuilder * | CreateDatumPlaneGridBuilder (const std::vector< NXOpen::DatumPlane * > &datumPlanes) |
| Creates a NXOpen::Display::DatumPlaneGridBuilder object used to build datum plane grids based on the supplied datum plane list. More... | |
| 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... | |
| NXOpen::Display::PlaneGridBuilder * | CreatePlaneGridBuilder (NXOpen::Display::PlaneGrid *grid) |
| Creates a NXOpen::Display::PlaneGridBuilder object used to build a bounded grid on a plane. More... | |
| iterator | end () |
| Returns an iterator addressing one past the last element. More... | |
| NXOpen::Display::Grid * | FindObject (const NXString &journalIdentifier) |
| Finds the NXOpen::Display::Grid with the given identifier as recorded in a journal. More... | |
| NXOpen::Display::Grid * | FindObject (const char *journalIdentifier) |
| Finds the NXOpen::Display::Grid with the given identifier as recorded in a journal. More... | |
| NXOpen::Display::DatumPlaneGrid * | GetDatumPlaneGrid (NXOpen::DatumPlane *datumPlane) |
| Finds the datum grid associated with the specified datum plane. More... | |
| tag_t | Tag () const |
| 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
| iterator NXOpen::Display::GridCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| 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.
- Returns
- datum plane grid builder
Created in NX6.0.0.
License requirements : None
- Parameters
-
grid If grid is not NULL, then this object will be edited
| NXOpen::Display::DatumPlaneGridBuilder* NXOpen::Display::GridCollection::CreateDatumPlaneGridBuilder | ( | const std::vector< NXOpen::DatumPlane * > & | datumPlanes | ) |
Creates a NXOpen::Display::DatumPlaneGridBuilder object used to build datum plane grids based on the supplied datum plane list.
- Returns
- datum plane grid builder
Created in NX6.0.0.
License requirements : None
- Parameters
-
datumPlanes datum plane list
| 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 NULL, the planar ship grid object will be edited.
- Returns
- planar ship grid builder
Created in NX8.0.0.
License requirements : nx_ship_concept ("Ship Concept")
- Parameters
-
grid If grid is not NULL, this object will be edited
| 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 NULL, the planar grid object will be edited.
- Returns
- plane grid builder
Created in NX6.0.0.
License requirements : None
- Parameters
-
grid If grid is not NULL, then this object will be edited
| iterator NXOpen::Display::GridCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Display::Grid* NXOpen::Display::GridCollection::FindObject | ( | const NXString & | 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.
- Returns
- Grid found
Created in NX6.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| NXOpen::Display::Grid* NXOpen::Display::GridCollection::FindObject | ( | const char * | 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.
- Returns
- Grid found
Created in NX6.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| NXOpen::Display::DatumPlaneGrid* NXOpen::Display::GridCollection::GetDatumPlaneGrid | ( | NXOpen::DatumPlane * | datumPlane | ) |
Finds the datum grid associated with the specified datum plane.
- Returns
- Datum plane grid. NULL indicates no grid is associated with the datum plane.
Created in NX6.0.0.
License requirements : None
- Parameters
-
datumPlane datum plane
| tag_t NXOpen::Display::GridCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Display_GridCollection.hxx