# class ImageDataImporter

Class for loading image data from different file formats.

# Properties

Property Description
CapToPowerOfTwo Set/Get CapToPowerOfTwo. If set, the width and height of the loaded image will be capped to the closest power of two below the size of the image.
ExtensionOverride The override file extension. This is specified including the dot, eg ".tga".
ImportFilePath The main import file path. This must always be set.
ImportOnlyHeader Set/Get ImportOnlyHeader. If set to true only gets header information from the image, and does not load the actual file into memory.
MaxHeight Set/Get MaxHeight. If set to a value above 0, the image that is higher will be rescaled to MaxHeight.
MaxWidth Set/Get MaxWidth. If set to a value above 0, the image that is wider will be rescaled to MaxWidth.

# Methods

Method Description
Clear Close any open file or stream, release any allocated data.
GetBitsPerPixel After RunImport(), returns the BitsPerPixel (8bpp-64bpp). If divided by NumberOfChannels, will give the number of bits per channel.
GetClass Get the name of the ImageDataImporter class.
GetImage The imported image data.
GetImageFileFormat Return the format of the image.
GetNumberOfChannels After RunImport(), returns the NumberOfChannels (1, 3, 4) in the source image.
IsA Returns true if ImageDataImporter is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ImageDataImporter object is invalid.
RunImport Runs the import. Note that all parameters must be setup before importing.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spImageDataImporter, and if this is the case, returns the object cast into spImageDataImporter.

# Properties details

# CapToPowerOfTwo

Set/Get CapToPowerOfTwo. If set, the width and height of the loaded image will be capped to the closest power of two below the size of the image.

    # ExtensionOverride

    The override file extension. This is specified including the dot, eg ".tga".

      # ImportFilePath

      The main import file path. This must always be set.

        # ImportOnlyHeader

        Set/Get ImportOnlyHeader. If set to true only gets header information from the image, and does not load the actual file into memory.

          # MaxHeight

          Set/Get MaxHeight. If set to a value above 0, the image that is higher will be rescaled to MaxHeight.

            # MaxWidth

            Set/Get MaxWidth. If set to a value above 0, the image that is wider will be rescaled to MaxWidth.

              # Methods details

              # Clear

              Close any open file or stream, release any allocated data.

                # GetBitsPerPixel

                After RunImport(), returns the BitsPerPixel (8bpp-64bpp). If divided by NumberOfChannels, will give the number of bits per channel.

                  # GetClass

                  Get the name of the ImageDataImporter class.

                    # GetImage

                    The imported image data.

                      # GetImageFileFormat

                      Return the format of the image.

                        # GetNumberOfChannels

                        After RunImport(), returns the NumberOfChannels (1, 3, 4) in the source image.

                          # IsA

                          Returns true if ImageDataImporter is a or is a descendant of the class named as the type parameter.

                            # IsNull

                            Returns true if the ImageDataImporter object is invalid.

                              # RunImport

                              Runs the import. Note that all parameters must be setup before importing.

                                # Static methods details

                                # IsClassA

                                Returns true if the class is a or is a descendant of the class named as the type parameter.

                                  # SafeCast

                                  SafeCast makes sure the input object is of a class that can be cast into spImageDataImporter, and if this is the case, returns the object cast into spImageDataImporter.