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. |
| Name | The name of the ImageDataImporter object. (Inherited from Object) |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| 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. (Inherited from Object) |
| 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. (Inherited from Object) |
| IsNull | Returns true if the ImageDataImporter object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ImageDataImporter object is valid. (Inherited from Object) |
| NonNull | Returns true if the ImageDataImporter object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ImageDataImporter object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| 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. (Inherited from Object) |
| 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. (Inherited from Object) |
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.
Syntax
SetCapToPowerOfTwo parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired CapToPowerOfTwo flag. |
GetCapToPowerOfTwo return value
Type: bool
Syntax
SetCapToPowerOfTwo parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired CapToPowerOfTwo flag. |
GetCapToPowerOfTwo return value
Type: bool
Syntax
SetCapToPowerOfTwo parameters
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired CapToPowerOfTwo flag. |
GetCapToPowerOfTwo return value
Type: bool
ExtensionOverride
The override file extension. This is specified including the dot, eg ".tga".
Syntax
SetExtensionOverride parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired override file extension. |
GetExtensionOverride return value
Type: spString
Syntax
SetExtensionOverride parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired override file extension. |
GetExtensionOverride return value
Type: string
Syntax
SetExtensionOverride parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired override file extension. |
GetExtensionOverride return value
Type: str
ImportFilePath
The main import file path. This must always be set.
Syntax
SetImportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired main import file path. |
GetImportFilePath return value
Type: spString
Syntax
SetImportFilePath parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired main import file path. |
GetImportFilePath return value
Type: string
Syntax
SetImportFilePath parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired main import file path. |
GetImportFilePath return value
Type: str
Set/Get ImportOnlyHeader. If set to true only gets header information from the image, and does not load the actual file into memory.
Syntax
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired ImportOnlyHeader value. |
Type: bool
Syntax
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The desired ImportOnlyHeader value. |
Type: bool
Syntax
| Name | Type | Min | Max | Description |
|---|
| value | bool | | | The desired ImportOnlyHeader value. |
Type: bool
MaxHeight
Set/Get MaxHeight. If set to a value above 0, the image that is higher will be rescaled to MaxHeight.
Syntax
SetMaxHeight parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | | | The desired MaxHeight. |
GetMaxHeight return value
Type: unsigned int
Syntax
SetMaxHeight parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | | | The desired MaxHeight. |
GetMaxHeight return value
Type: uint
Syntax
SetMaxHeight parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The desired MaxHeight. |
GetMaxHeight return value
Type: int
MaxWidth
Set/Get MaxWidth. If set to a value above 0, the image that is wider will be rescaled to MaxWidth.
Syntax
SetMaxWidth parameters
| Type | Name | Min | Max | Description |
|---|
unsigned int | value | | | The desired MaxWidth. |
GetMaxWidth return value
Type: unsigned int
Syntax
SetMaxWidth parameters
| Type | Name | Min | Max | Description |
|---|
uint | value | | | The desired MaxWidth. |
GetMaxWidth return value
Type: uint
Syntax
SetMaxWidth parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | The desired MaxWidth. |
GetMaxWidth return value
Type: int
Name
The name of the ImageDataImporter object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
Clear
Close any open file or stream, release any allocated data.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
Syntax
Parameters
Clear takes no parameters.
GetBitsPerPixel
After RunImport(), returns the BitsPerPixel (8bpp-64bpp). If divided by NumberOfChannels, will give the number of bits per channel.
Syntax
Parameters
GetBitsPerPixel takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetBitsPerPixel takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetBitsPerPixel takes no parameters.
Return value
Type: int
GetClass
Get the name of the ImageDataImporter class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetImage
The imported image data.
Syntax
Parameters
GetImage takes no parameters.
Return value
Type: ImageData
Syntax
Parameters
GetImage takes no parameters.
Return value
Type: ImageData
Syntax
Parameters
GetImage takes no parameters.
Return value
Type: ImageData
Return the format of the image.
Syntax
Parameters
GetImageFileFormat takes no parameters.
Return value
Type: EImageInputFormat
| Key | Value | Comment |
|---|
| Unsupported | -1 | and unknown or unsupported file format |
| BMP | 0 | |
| DDS | 1 | |
| GIF | 2 | |
| JPEG | 3 | |
| PNG | 4 | |
| TGA | 5 | |
| TIFF | 6 | |
| PSD | 7 | |
Syntax
Parameters
GetImageFileFormat takes no parameters.
Return value
Type: EImageInputFormat
| Key | Value | Comment |
|---|
| Unsupported | -1 | and unknown or unsupported file format |
| BMP | 0 | |
| DDS | 1 | |
| GIF | 2 | |
| JPEG | 3 | |
| PNG | 4 | |
| TGA | 5 | |
| TIFF | 6 | |
| PSD | 7 | |
Syntax
Parameters
GetImageFileFormat takes no parameters.
Return value
Type: EImageInputFormat
| Key | Value | Comment |
|---|
| EImageInputFormat_Unsupported | -1 | and unknown or unsupported file format |
| EImageInputFormat_BMP | 0 | |
| EImageInputFormat_DDS | 1 | |
| EImageInputFormat_GIF | 2 | |
| EImageInputFormat_JPEG | 3 | |
| EImageInputFormat_PNG | 4 | |
| EImageInputFormat_TGA | 5 | |
| EImageInputFormat_TIFF | 6 | |
| EImageInputFormat_PSD | 7 | |
GetNumberOfChannels
After RunImport(), returns the NumberOfChannels (1, 3, 4) in the source image.
Syntax
Parameters
GetNumberOfChannels takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetNumberOfChannels takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetNumberOfChannels takes no parameters.
Return value
Type: int
IsA
Returns true if ImageDataImporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ImageDataImporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ImageDataImporter is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ImageDataImporter is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ImageDataImporter object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ImageDataImporter object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the ImageDataImporter object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ImageDataImporter object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
RunImport
Runs the import. Note that all parameters must be setup before importing.
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
Syntax
Parameters
RunImport takes no parameters.
Return value
Type: bool
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
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. (Inherited from Object)
