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

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

Syntax

# Setter
None SetCapToPowerOfTwo(value: bool)

# Getter
bool GetCapToPowerOfTwo()

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

// 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

Syntax

// Setter
void SetExtensionOverride(string value);

// Getter
string GetExtensionOverride();

SetExtensionOverride parameters

Type	Name	Min	Max	Description
string	value			The desired override file extension.

GetExtensionOverride return value

Type: string

Syntax

# Setter
None SetExtensionOverride(value: str)

# Getter
str GetExtensionOverride()

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

// 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

Syntax

// Setter
void SetImportFilePath(string value);

// Getter
string GetImportFilePath();

SetImportFilePath parameters

Type	Name	Min	Max	Description
string	value			The desired main import file path.

GetImportFilePath return value

Type: string

Syntax

# Setter
None SetImportFilePath(value: str)

# Getter
str GetImportFilePath()

SetImportFilePath parameters

Name	Type	Min	Max	Description
value	str			The desired main import file path.

GetImportFilePath return value

Type: str

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

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

Syntax

# Setter
None SetImportOnlyHeader(value: bool)

# Getter
bool GetImportOnlyHeader()

SetImportOnlyHeader parameters

Name	Type	Min	Max	Description
value	bool			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

Syntax

// Setter
void SetMaxHeight(uint value);

// Getter
uint GetMaxHeight();

SetMaxHeight parameters

Type	Name	Min	Max	Description
uint	value			The desired MaxHeight.

GetMaxHeight return value

Type: uint

Syntax

# Setter
None SetMaxHeight(value: int)

# Getter
int GetMaxHeight()

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

// 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

Syntax

// Setter
void SetMaxWidth(uint value);

// Getter
uint GetMaxWidth();

SetMaxWidth parameters

Type	Name	Min	Max	Description
uint	value			The desired MaxWidth.

GetMaxWidth return value

Type: uint

Syntax

# Setter
None SetMaxWidth(value: int)

# Getter
int GetMaxWidth()

SetMaxWidth parameters

Name	Type	Min	Max	Description
value	int			The desired MaxWidth.

GetMaxWidth return value

Type: int

Methods details

Clear

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

Syntax

void Clear();

Parameters

Clear takes no parameters.

Syntax

void Clear();

Parameters

Clear takes no parameters.

Syntax

None 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

Syntax

uint GetBitsPerPixel();

Parameters

GetBitsPerPixel takes no parameters.

Return value

Type: uint

Syntax

int GetBitsPerPixel()

Parameters

GetBitsPerPixel takes no parameters.

Return value

Type: int

GetClass

Get the name of the ImageDataImporter class.

Syntax

spString GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetImage

The imported image data.

Syntax

spImageData GetImage();

Parameters

GetImage takes no parameters.

Return value

Type: ImageData

Syntax

spImageData GetImage();

Parameters

GetImage takes no parameters.

Return value

Type: ImageData

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

Syntax

 GetImageFileFormat();

Parameters

GetImageFileFormat takes no parameters.

Return value

Type: ``````

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

EImageInputFormat_* GetImageFileFormat()

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

unsigned int GetNumberOfChannels();

Parameters

GetNumberOfChannels takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetNumberOfChannels();

Parameters

GetNumberOfChannels takes no parameters.

Return value

Type: uint

Syntax

int GetNumberOfChannels()

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.

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

Syntax

bool IsA(string type);

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

bool IsA(type: str)

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.

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

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

Syntax

bool RunImport();

Parameters

RunImport takes no parameters.

Return value

Type: bool

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

Syntax

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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.

Syntax

static spImageDataImporter SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ImageDataImporter

Syntax

static spImageDataImporter SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ImageDataImporter

Syntax

@staticmethod
spImageDataImporter SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ImageDataImporter