# 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.

# Syntax

// Setter
void SetCapToPowerOfTwo( bool value );

// Getter
bool GetCapToPowerOfTwo();

# SetCapToPowerOfTwo parameters

Type Name Min Max Description
bool value The desired CapToPowerOfTwo flag.

# GetCapToPowerOfTwo return value

Type: bool

# ExtensionOverride

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

# Syntax

// Setter
void SetExtensionOverride( const char * value );

// Getter
spString GetExtensionOverride();

# SetExtensionOverride parameters

Type Name Min Max Description
const char * value The desired override file extension.

# GetExtensionOverride return value

Type: spString

# ImportFilePath

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

# Syntax

// Setter
void SetImportFilePath( const char * value );

// Getter
spString GetImportFilePath();

# SetImportFilePath parameters

Type Name Min Max Description
const char * value The desired main import file path.

# GetImportFilePath return value

Type: spString

# ImportOnlyHeader

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

# Syntax

// Setter
void SetImportOnlyHeader( bool value );

// Getter
bool GetImportOnlyHeader();

# SetImportOnlyHeader parameters

Type Name Min Max Description
bool value The desired ImportOnlyHeader value.

# GetImportOnlyHeader return 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

// Setter
void SetMaxHeight( unsigned int value );

// Getter
unsigned int GetMaxHeight();

# SetMaxHeight parameters

Type Name Min Max Description
unsigned int value The desired MaxHeight.

# GetMaxHeight return value

Type: unsigned int

# MaxWidth

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

# Syntax

// Setter
void SetMaxWidth( unsigned int value );

// Getter
unsigned int GetMaxWidth();

# SetMaxWidth parameters

Type Name Min Max Description
unsigned int value The desired MaxWidth.

# GetMaxWidth return value

Type: unsigned int

# Methods details

# Clear

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

# Syntax

void Clear();

# 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

unsigned int GetBitsPerPixel();

# Parameters

GetBitsPerPixel takes no parameters.

# Return value

Type: unsigned int

# GetClass

Get the name of the ImageDataImporter class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetImage

The imported image data.

# Syntax

spImageData GetImage();

# Parameters

GetImage takes no parameters.

# Return value

Type: ImageData

# GetImageFileFormat

Return the format of the image.

# Syntax

Simplygon::EImageInputFormat GetImageFileFormat();

# 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

# GetNumberOfChannels

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

# Syntax

unsigned int GetNumberOfChannels();

# Parameters

GetNumberOfChannels takes no parameters.

# Return value

Type: unsigned int

# IsA

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

# Syntax

bool IsA( const char * type );

# 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

# IsNull

Returns true if the ImageDataImporter object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RunImport

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

# Syntax

bool RunImport();

# 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.

# Syntax

static bool IsClassA( const char * type );

# 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

# 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.

# Syntax

static spImageDataImporter SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ImageDataImporter