Interface IAssetMetaFile
Interface that represents the asset metafile.
Namespace: Evergine.Assets.Exporters
Assembly: Evergine.Assets.dll
Syntax
public interface IAssetMetaFileProperties
DefaultProfile
Gets the default profile.
Declaration
AssetProfile DefaultProfile { get; }Property Value
| Type | Description |
|---|---|
| AssetProfile |
ExportAsRaw
Gets or sets a value indicating whether this asset will be exported as raw.
Declaration
bool ExportAsRaw { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Exporter
Gets the asset exporter.
Declaration
IAssetExporter Exporter { get; }Property Value
| Type | Description |
|---|---|
| IAssetExporter |
ExtensionExported
Gets the extension of the exported asset.
Declaration
string ExtensionExported { get; }Property Value
| Type | Description |
|---|---|
| string |
ExtensionMetafile
Gets the extension of the asset metadata file.
Declaration
string ExtensionMetafile { get; }Property Value
| Type | Description |
|---|---|
| string |
Id
Gets the asset ID.
Declaration
Guid Id { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Name
Gets or sets the asset name.
Declaration
string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Profiles
Gets the asset profiles.
Declaration
IReadOnlyDictionary<string, AssetProfile> Profiles { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyDictionary<string, AssetProfile> |
Methods
AddProfile(string, AssetProfile)
Adds a profile.
Declaration
void AddProfile(string name, AssetProfile profile)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the profile. |
| AssetProfile | profile | The instance of the profile. |
Export(ExportContext)
Exports the meta file.
Declaration
Task<ExportResult> Export(ExportContext exportContext)Parameters
| Type | Name | Description |
|---|---|---|
| ExportContext | exportContext | The export context. |
Returns
| Type | Description |
|---|---|
| Task<ExportResult> | An awaitable task for the operation, with the export result. |
GetExportOutputPath(ExportContext)
Retrieves the export output path.
Declaration
string GetExportOutputPath(ExportContext exportContext)Parameters
| Type | Name | Description |
|---|---|---|
| ExportContext | exportContext | The context for the export. |
Returns
| Type | Description |
|---|---|
| string | The export output path. |
GetProfileOrDefault(string)
Gets the specified profile from the metafile, or the default profile.
Declaration
AssetProfile GetProfileOrDefault(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The profile name. |
Returns
| Type | Description |
|---|---|
| AssetProfile | The specified profile or the default profile. |
RemoveProfile(string)
Removes a profile from the metafile.
Declaration
void RemoveProfile(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the profile. |