Class AssetsImportingManager

Assets Importing service allows to import or create new assets

AssetsImportingManager
Assembly: FlaxEngine.dll
File: Engine/ContentImporters/AssetsImportingManager.h
Syntax
public class AssetsImportingManager

Fields

CreateAnimationGraphFunctionTag

The create animation graph function asset tag.

Declaration
public static String CreateAnimationGraphFunctionTag
Field Value
String

CreateAnimationGraphTag

The create animation graph asset tag.

Declaration
public static String CreateAnimationGraphTag
Field Value
String

CreateAnimationTag

The create animation asset tag.

Declaration
public static String CreateAnimationTag
Field Value
String

CreateBehaviorTreeTag

The create Behavior Tree asset tag.

Declaration
public static String CreateBehaviorTreeTag
Field Value
String

CreateCollisionDataTag

The create collision data asset tag.

Declaration
public static String CreateCollisionDataTag
Field Value
String

CreateCubeTextureTag

The create cube texture tag. Argument must be TextureData*.

Declaration
public static String CreateCubeTextureTag
Field Value
String

CreateMaterialFunctionTag

The create material function asset tag.

Declaration
public static String CreateMaterialFunctionTag
Field Value
String

CreateMaterialInstanceTag

The create material tag.

Declaration
public static String CreateMaterialInstanceTag
Field Value
String

CreateMaterialTag

The create material tag.

Declaration
public static String CreateMaterialTag
Field Value
String

CreateModelTag

The create model tag. Argument must be ModelData*.

Declaration
public static String CreateModelTag
Field Value
String

CreateParticleEmitterFunctionTag

The create particle graph function asset tag.

Declaration
public static String CreateParticleEmitterFunctionTag
Field Value
String

CreateParticleEmitterTag

The create particle emitter asset tag.

Declaration
public static String CreateParticleEmitterTag
Field Value
String

CreateParticleSystemTag

The create particle system asset tag.

Declaration
public static String CreateParticleSystemTag
Field Value
String

CreateRawDataTag

The create raw data asset tag. Argument must be BytesContainer*.

Declaration
public static String CreateRawDataTag
Field Value
String

CreateSceneAnimationTag

The create scene animation asset tag.

Declaration
public static String CreateSceneAnimationTag
Field Value
String

CreateSkeletonMaskTag

The create skeleton mask asset tag.

Declaration
public static String CreateSkeletonMaskTag
Field Value
String

CreateTextureAsInitDataTag

The create texture from raw data. Argument must be TextureBase::InitData*.

Declaration
public static String CreateTextureAsInitDataTag
Field Value
String

CreateTextureAsTextureDataTag

The create texture from raw data. Argument must be TextureData*.

Declaration
public static String CreateTextureAsTextureDataTag
Field Value
String

CreateTextureTag

The create texture tag (using internal import pipeline to crate texture asset from custom image source).

Declaration
public static String CreateTextureTag
Field Value
String

CreateVisualScriptTag

The create visual script asset tag.

Declaration
public static String CreateVisualScriptTag
Field Value
String

Creators

The asset creators.

Declaration
public static Array<AssetCreator> Creators
Field Value
Array<AssetCreator>

Importers

The asset importers.

Declaration
public static Array<AssetImporter> Importers
Field Value
Array<AssetImporter>

UseImportPathRelative

If true store asset import path relative to the current workspace, otherwise will store absolute path.

Declaration
public static bool UseImportPathRelative
Field Value
bool

Methods

Create(const CreateAssetFunction& importFunc, const StringView& outputPath, Guid& assetId, void* arg=nullptr)

Creates new asset.

Declaration
public static bool Create(const CreateAssetFunction& importFunc, const StringView& outputPath, Guid& assetId, void* arg=nullptr)
Parameters
CreateAssetFunction importFunc

The import function.
StringView outputPath

The output path.
Guid assetId

The asset identifier. If valid then used as new asset id. Set to the actual asset id after import.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

Create(const CreateAssetFunction& importFunc, const StringView& outputPath, void* arg=nullptr)

Creates new asset.

Declaration
public static bool Create(const CreateAssetFunction& importFunc, const StringView& outputPath, void* arg=nullptr)
Parameters
CreateAssetFunction importFunc

The import function.
StringView outputPath

The output path.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

Create(const String& tag, const StringView& outputPath, Guid& assetId, void* arg=nullptr)

Creates new asset.

Declaration
public static bool Create(const String& tag, const StringView& outputPath, Guid& assetId, void* arg=nullptr)
Parameters
String tag

The asset type tag.
StringView outputPath

The output path.
Guid assetId

The asset identifier.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

Create(const String& tag, const StringView& outputPath, void* arg=nullptr)

Creates new asset.

Declaration
public static bool Create(const String& tag, const StringView& outputPath, void* arg=nullptr)
Parameters
String tag

The asset type tag.
StringView outputPath

The output path.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

GetCreator(const String& tag)

Gets the asset creator by tag.

Declaration
public static AssetCreator* GetCreator(const String& tag)
Parameters
String tag

The tag.
Returns
AssetCreator

Creator or null if not found.

GetImporter(const String& extension)

Gets the asset importer by file extension.

Declaration
public static AssetImporter* GetImporter(const String& extension)
Parameters
String extension

The file extension.
Returns
AssetImporter

Importer or null if not found.

GetImportPath(const String& path)

Declaration
public static String GetImportPath(const String& path)
Parameters
String path

Returns
String

Import(const StringView& inputPath, const StringView& outputPath, Guid& assetId, void* arg=nullptr)

Imports file and creates asset. If asset already exists overwrites it's contents.

Declaration
public static bool Import(const StringView& inputPath, const StringView& outputPath, Guid& assetId, void* arg=nullptr)
Parameters
StringView inputPath

The input path.
StringView outputPath

The output path.
Guid assetId

The asset identifier. If valid then used as new asset id. Set to the actual asset id after import.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

Import(const StringView& inputPath, const StringView& outputPath, void* arg=nullptr)

Imports file and creates asset. If asset already exists overwrites it's contents.

Declaration
public static bool Import(const StringView& inputPath, const StringView& outputPath, void* arg=nullptr)
Parameters
StringView inputPath

The input path.
StringView outputPath

The output path.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

ImportIfEdited(const StringView& inputPath, const StringView& outputPath, Guid& assetId, void* arg=nullptr)

Imports file and creates asset only if source file has been modified. If asset already exists overwrites it's contents.

Declaration
public static bool ImportIfEdited(const StringView& inputPath, const StringView& outputPath, Guid& assetId, void* arg=nullptr)
Parameters
StringView inputPath

The input path.
StringView outputPath

The output path.
Guid assetId

The asset identifier. If valid then used as new asset id. Set to the actual asset id after import.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.

ImportIfEdited(const StringView& inputPath, const StringView& outputPath, void* arg=nullptr)

Imports file and creates asset only if source file has been modified. If asset already exists overwrites it's contents.

Declaration
public static bool ImportIfEdited(const StringView& inputPath, const StringView& outputPath, void* arg=nullptr)
Parameters
StringView inputPath

The input path.
StringView outputPath

The output path.
void arg

The custom argument.
Returns
bool

True if fails, otherwise false.