ImageCollection Class

class NXOpen.Display.ImageCollection

Bases: object

Represents a collection of image objects

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

New in version NX9.0.0.

Methods

Method	Description
CreateRasterImageBuilder	Creates a NXOpen.Display.RasterImageBuilder object used to build an image.
FindObject	Finds the NXOpen.Display.ImageBase with the given identifier as recorded in a journal.

Method Detail

CreateRasterImageBuilder

ImageCollection.CreateRasterImageBuilder

Creates a NXOpen.Display.RasterImageBuilder object used to build an image.

If the image is not None, the image object will be edited.

Signature CreateRasterImageBuilder(image)

Parameters:image (NXOpen.Display.RasterImage) – If image is not None, this object will be edited Returns:raster image builder Return type:NXOpen.Display.RasterImageBuilder

New in version NX9.0.0.

License requirements: None.

FindObject

ImageCollection.FindObject

Finds the NXOpen.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.

Signature FindObject(journalIdentifier)

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

New in version NX9.0.0.

License requirements: None.