# `class` BinaryImporter

BinaryImporter loads the geometry data from a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.

# Properties

Property	Description
ImportFilePath	The main import file path. This must always be set. Some importers, such as WavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer. (Inherited from GraphicsImporter)
Name	The name of the BinaryImporter 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. (Inherited from GraphicsImporter)
GetClass	Get the name of the BinaryImporter class. (Inherited from Object)
GetScene	The the scene loaded from the importer. (Inherited from GraphicsImporter)
IsA	Returns true if BinaryImporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the BinaryImporter object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the BinaryImporter object is valid. (Inherited from Object)
NonNull	Returns true if the BinaryImporter object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the BinaryImporter 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. (Inherited from GraphicsImporter)

# 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 spBinaryImporter, and if this is the case, returns the object cast into spBinaryImporter. (Inherited from Object)

# Properties details

# ImportFilePath

The main import file path. This must always be set. Some importers, such as WavefrontImporter, also have secondary files that may be set. For info regarding these secondary files, please see the documentation for the specific importer.

# Syntax

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

// Getter
spString GetImportFilePath() const;

# SetImportFilePath parameters

Type	Name	Min	Max	Description
`const char *`	value			The desired ImportFilePath string.

# GetImportFilePath return value

Type: spString

Type	Name	Min	Max	Description
`string`	value			The desired ImportFilePath string.

Name	Type	Min	Max	Description
value	`str`			The desired ImportFilePath string.

# Name

The name of the BinaryImporter object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

# GetName return value

Type: spString

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

# Return value

Type: rid

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

# Clear

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

# Syntax

void Clear() const;

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the BinaryImporter class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetScene

The the scene loaded from the importer.

# Syntax

spScene GetScene() const;

# Parameters

GetScene takes no parameters.

# Return value

Type: Scene

# IsA

Returns true if BinaryImporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if BinaryImporter is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if BinaryImporter is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if BinaryImporter is, or is a descendant of.

# IsNull

Returns true if the BinaryImporter object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the BinaryImporter object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

# Return value

Type: bool

Name	Type	Min	Max	Description
object	Object			Object to compare with.

# NonNull

Returns true if the BinaryImporter object is valid. (Inherited from Object)

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

Prints the content/info of the BinaryImporter object to the log. (Inherited from Object)

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

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

bool RunImport() const;

# 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

static bool IsClassA( const char * type ) const;

# 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

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spBinaryImporter, and if this is the case, returns the object cast into spBinaryImporter. (Inherited from Object)

# Syntax

static spBinaryImporter SafeCast( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

# Return value

Type: BinaryImporter

Name	Type	Min	Max	Description
object	Object			Object to cast.

← WavefrontExporter FBXImporter →

# class BinaryImporter

# Properties

# Methods

# Static methods

# Properties details

# ImportFilePath

# Syntax

# SetImportFilePath parameters

# GetImportFilePath return value

# Name

# Syntax

# SetName parameters

# GetName return value

# Methods details

# AddObserver

# Syntax

# Parameters

# Return value

# Clear

# Syntax

# Parameters

# GetClass

# Syntax

# Parameters

# Return value

# GetScene

# Syntax

# Parameters

# Return value

# IsA

# Syntax

# Parameters

# Return value

# IsNull

# Syntax

# Parameters

# Return value

# IsSameObjectAs

# Syntax

# Parameters

# Return value

# NonNull

# Syntax

# Parameters

# Return value

# PrintInfo

# Syntax

# Parameters

# RemoveObserver

# Syntax

# Parameters

# RunImport

# Syntax

# Parameters

# Return value

# Static methods details

# IsClassA

# Syntax

# Parameters

# Return value

# SafeCast

# Syntax

# Parameters

# Return value

# `class` BinaryImporter