Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Assets.IAssetImporter Interface Reference

Imports a raw asset into the asset system. More...

Inheritance diagram for SiliconStudio.Assets.IAssetImporter:
SiliconStudio.Assets.AssetImporterBase SiliconStudio.Paradox.Assets.Audio.RawMusicAssetImporter SiliconStudio.Paradox.Assets.Audio.RawSoundAssetImporter SiliconStudio.Paradox.Assets.Model.ModelAssetImporter SiliconStudio.Paradox.Assets.Texture.TextureImporter SiliconStudio.Paradox.Assets.Model.AssimpAssetImporter SiliconStudio.Paradox.Assets.Model.FbxAssetImporter

Public Member Functions

AssetImporterParameters GetDefaultParameters (bool isForReImport)
 Gets the default parameters for this importer. More...
 
IEnumerable< AssetItemImport (UFile rawAssetPath, AssetImporterParameters importParameters)
 Imports a raw assets from the specified path into the specified package. More...
 

Properties

Guid Id [get]
 Gets an unique identifier to identify the importer. See remarks. More...
 
string Name [get]
 Gets the name of this importer. More...
 
string Description [get]
 Gets the description of this importer. More...
 
string SupportedFileExtensions [get]
 Gets the supported file extensions (separated by ',' for multiple extensions) by this importer. More...
 
int DisplayRank [get]
 Gets the rank of this importer, higher is the value, higher the importer is important or commonly used. Default is 100. More...
 

Detailed Description

Imports a raw asset into the asset system.

Definition at line 13 of file IAssetImporter.cs.

Member Function Documentation

AssetImporterParameters SiliconStudio.Assets.IAssetImporter.GetDefaultParameters ( bool  isForReImport)
IEnumerable<AssetItem> SiliconStudio.Assets.IAssetImporter.Import ( UFile  rawAssetPath,
AssetImporterParameters  importParameters 
)

Imports a raw assets from the specified path into the specified package.

Parameters
rawAssetPathThe path to a raw asset on the disk.
importParametersThe parameters. It is mandatory to call GetDefaultParameters and pass the parameters instance here

Implemented in SiliconStudio.Paradox.Assets.Model.ModelAssetImporter, SiliconStudio.Paradox.Assets.Audio.RawMusicAssetImporter, SiliconStudio.Paradox.Assets.Audio.RawSoundAssetImporter, SiliconStudio.Paradox.Assets.Texture.TextureImporter, and SiliconStudio.Assets.AssetImporterBase.

Property Documentation

string SiliconStudio.Assets.IAssetImporter.Description
get

Gets the description of this importer.

The description.

Definition at line 35 of file IAssetImporter.cs.

int SiliconStudio.Assets.IAssetImporter.DisplayRank
get

Gets the rank of this importer, higher is the value, higher the importer is important or commonly used. Default is 100.

The rank.

Definition at line 55 of file IAssetImporter.cs.

Guid SiliconStudio.Assets.IAssetImporter.Id
get

Gets an unique identifier to identify the importer. See remarks.

The identifier.

This identifier is used to recover the importer used for a particular asset. This Guid must be unique and stored statically in the definition of an importer. It is used to reimport an existing asset with the same importer.

Definition at line 23 of file IAssetImporter.cs.

Referenced by SiliconStudio.Assets.AssetRegistry.RegisterImporter().

string SiliconStudio.Assets.IAssetImporter.Name
get

Gets the name of this importer.

The name.

Definition at line 29 of file IAssetImporter.cs.

Referenced by SiliconStudio.Assets.AssetImportSession.AddFile().

string SiliconStudio.Assets.IAssetImporter.SupportedFileExtensions
get

Gets the supported file extensions (separated by ',' for multiple extensions) by this importer.

Returns
Returns a list of supported file extensions handled by this importer.

Definition at line 41 of file IAssetImporter.cs.


The documentation for this interface was generated from the following file: