Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | Properties | List of all members
SiliconStudio.Assets.AssetImporterBase Class Referenceabstract
Inheritance diagram for SiliconStudio.Assets.AssetImporterBase:
SiliconStudio.Assets.IAssetImporter 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

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

Properties

abstract Guid Id [get]
 
virtual string Name [get]
 
abstract string Description [get]
 
abstract string SupportedFileExtensions [get]
 
virtual int DisplayRank [get]
 
- Properties inherited from SiliconStudio.Assets.IAssetImporter
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

Definition at line 9 of file AssetImporterBase.cs.

Member Function Documentation

abstract AssetImporterParameters SiliconStudio.Assets.AssetImporterBase.GetDefaultParameters ( bool  isForReImport)
pure virtual

Gets the default parameters for this importer.

Parameters
isForReImport

The supported types.

Implements SiliconStudio.Assets.IAssetImporter.

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

abstract IEnumerable<AssetItem> SiliconStudio.Assets.AssetImporterBase.Import ( UFile  rawAssetPath,
AssetImporterParameters  importParameters 
)
pure virtual

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

Implements SiliconStudio.Assets.IAssetImporter.

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

Property Documentation

abstract string SiliconStudio.Assets.AssetImporterBase.Description
get

Definition at line 21 of file AssetImporterBase.cs.

virtual int SiliconStudio.Assets.AssetImporterBase.DisplayRank
get

Definition at line 26 of file AssetImporterBase.cs.

abstract Guid SiliconStudio.Assets.AssetImporterBase.Id
get

Definition at line 11 of file AssetImporterBase.cs.

virtual string SiliconStudio.Assets.AssetImporterBase.Name
get

Definition at line 14 of file AssetImporterBase.cs.

abstract string SiliconStudio.Assets.AssetImporterBase.SupportedFileExtensions
get

Definition at line 23 of file AssetImporterBase.cs.

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