Represents a collection of image objects
To obtain an instance of this class, refer to BasePart
Created in NX9.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. | |
| NXOpen::Display::RasterImageBuilder * | CreateRasterImageBuilder (NXOpen::Display::RasterImage *image) |
| Creates a Display::RasterImageBuilder object used to build an image. | |
| iterator | end () |
| Returns an iterator addressing one past the last element. | |
| NXOpen::Display::ImageBase * | FindObject (const NXString &journalIdentifier) |
| Finds the Display::ImageBase with the given identifier as recorded in a journal. | |
| NXOpen::Display::ImageBase * | FindObject (const char *journalIdentifier) |
| Finds the Display::ImageBase with the given identifier as recorded in a journal. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
Represents a collection of image objects
To obtain an instance of this class, refer to BasePart
Created in NX9.0.0.
Member Function Documentation
| iterator NXOpen::Display::ImageCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Display::RasterImageBuilder* NXOpen::Display::ImageCollection::CreateRasterImageBuilder | ( | NXOpen::Display::RasterImage * | image | ) |
Creates a Display::RasterImageBuilder object used to build an image.
If the image is not NULL, the image object will be edited.
@return raster image builder
Created in NX9.0.0.
License requirements : None
- Parameters
-
image If image is not NULL, this object will be edited
| iterator NXOpen::Display::ImageCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Display::ImageBase* NXOpen::Display::ImageCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the Display::ImageBase 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
- Image found
Created in NX9.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| NXOpen::Display::ImageBase* NXOpen::Display::ImageCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the Display::ImageBase 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
- Image found
Created in NX9.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier to be found
| tag_t NXOpen::Display::ImageCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Display_ImageCollection.hxx