class AssimpModelFormat in Tinman.AddOns.Assimp

A ModelFormat implementation for:
Open Asset Import Library v3 / v4 (http://assimp.sourceforge.net)

sealed class AssimpModelFormat extends ModelFormat

Remarks

The AssimpModelFormat is available if any of the following native libraries are present in the search path of the process:

'assimp4.x32': 32-bit dynamic link library, major version 4
'assimp4.x64': 64-bit dynamic link library, major version 4
'assimp4': dynamic link library, major version 4
'assimp3.x32': 32-bit dynamic link library, major version 3
'assimp3.x64': 64-bit dynamic link library, major version 3
'assimp3': dynamic link library, major version 3
'assimp.x32': 32-bit dynamic link library, any supported version
'assimp.x64': 64-bit dynamic link library, any supported version
'assimp': dynamic link library, any supported version

This class assumes that the library interfaces of all major versions binary compatible.

Public / Constants

Instance

Singleton instance of AssimpModelFormat (any supported version).

`public static readonly field`	`Instance`
`type`	`ModelFormat`

Instance3

Singleton instance of AssimpModelFormat (major version 3).

`public static readonly field`	`Instance3`
`type`	`ModelFormat`

Instance4

Singleton instance of AssimpModelFormat (major version 4).

`public static readonly field`	`Instance4`
`type`	`ModelFormat`

Public / Attributes

Description

Long description of this file format.

`public override property`	`Description { get }`
`type`	`string`
`value`	`[not-null]`	The description string.
`overrides`	`FileFormat.Description`

Name

The file format name.

`public property`	`Name { get }`
`type`	`string`
`value`	`[not-null]`	The file format name.
`inherited`	`FileFormat.Name`

Returns the next file format.

`[ThreadSafe]`
`public property`	`Next { get }`
`type`	`IFileFormat`
`value`		The next file format or `null`.
`inherited`	`FileFormat.Next`

Remarks:

The first file format can be obtained from implementing classes. This property can be used to cycle all available file formats of the same type.

Type

The type of this file format (e.g. images, shapes, 3D models).

`public property`	`Type { get }`
`type`	`string`
`value`	`[not-null]`	The human-readable type name.
`inherited`	`FileFormat.Type`

Public / Methods

CanRead

Can this file format object be used to read the given path?

`public override method`	`CanRead (string suffix, bool directory = false)`
`type`	`bool`
`params`	`suffix`	`[not-null]`	The lower-case pathname suffix (without `'.'`). Will be empty if the path does not have a pathname suffix.
	`directory`		Does the path refer to a directory (`true`) or to a file (`false`)? Defaults to `false`.
`returns`			`true` if this file format can be used, `false` if not.
`overrides`	`FileFormat.CanRead`

CanReadFind

Returns the first file format in the chain (see IFileFormat) that can read the given path.

`public method`	`CanReadFind (string suffix, bool directory = false)`
`type`	`IFileFormat`
`params`	`suffix`	`[not-null]`	The lower-case pathname suffix (without `'.'`). Will be empty if the path does not have a pathname suffix.
	`directory`		Does the path refer to a directory (`true`) or to a file (`false`)? Defaults to `false`.
`returns`			The found file format or `null`.
`inherited`	`FileFormat.CanReadFind`

CanWrite

Can this file format object be used to write the given path?

`public virtual method`	`CanWrite (string suffix)`
`type`	`bool`
`params`	`suffix`	`[not-null]`	The lower-case pathname suffix (without `'.'`). Will be empty if the path does not have a pathname suffix.
`returns`			`true` if this file format can be used, `false` if not.
`inherited`	`FileFormat.CanWrite`

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

`public override method`	`PleaseIncludeInBinaryThanks ()`
`overrides`	`FileFormat.PleaseIncludeInBinaryThanks`