Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource Class Reference

Captures provenance details for an animation definition. More...

Static Public Member Functions
static AnimationDefinitionSource	LooseDefinitionFile (string ganiFilePath)
	Creates provenance for a definition stored in a loose file.
static AnimationDefinitionSource	PackedDefinitionFile (string assetsFilePath, string assetEntryName)
	Creates provenance for a definition stored inside an assets file.
static AnimationDefinitionSource	Generated ()
	Creates provenance for a definition generated from runtime state.
static AnimationDefinitionSource	None ()
	Creates an empty definition-source descriptor.

Properties
AnimationDefinitionSourceKind	Kind [get]
	Gets the high-level source kind.
string?	GaniFilePath [get]
	Gets the .gani path when loaded from a loose definition file.
string?	AssetsFilePath [get]
	Gets the .gaf path when loaded from a packed definition file.
string?	AssetEntryName [get]
	Gets the packed entry name when loaded from a packed definition file.

Detailed Description

Captures provenance details for an animation definition.

Definition at line 8 of file AnimationDefinitionSource.cs.

Member Function Documentation

Generated()

AnimationDefinitionSource Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.Generated ( )

static

Creates provenance for a definition generated from runtime state.

Returns

A source descriptor identifying runtime-generated content.

LooseDefinitionFile()

AnimationDefinitionSource Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.LooseDefinitionFile ( string ganiFilePath )

static

Creates provenance for a definition stored in a loose file.

Parameters

ganiFilePath

The path to the loose GANI animation definition.

Returns

A source descriptor containing the loose definition file path.

Definition at line 42 of file AnimationDefinitionSource.cs.

None()

AnimationDefinitionSource Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.None ( )

static

Creates an empty definition-source descriptor.

Returns

A descriptor with no persisted source.

PackedDefinitionFile()

AnimationDefinitionSource Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.PackedDefinitionFile ( string assetsFilePath, string assetEntryName )

static

Creates provenance for a definition stored inside an assets file.

Parameters

assetsFilePath	The path to the assets file.
assetEntryName	The entry name inside the assets file.

Returns

A source descriptor containing the assets file path and entry name.

Definition at line 60 of file AnimationDefinitionSource.cs.

Property Documentation

AssetEntryName

string? Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.AssetEntryName

get

Gets the packed entry name when loaded from a packed definition file.

Definition at line 35 of file AnimationDefinitionSource.cs.

AssetsFilePath

string? Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.AssetsFilePath

get

Gets the .gaf path when loaded from a packed definition file.

Definition at line 29 of file AnimationDefinitionSource.cs.

GaniFilePath

string? Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.GaniFilePath

get

Gets the .gani path when loaded from a loose definition file.

Definition at line 23 of file AnimationDefinitionSource.cs.

Kind

AnimationDefinitionSourceKind Gondwana.Drawing.Animation.GANI.AnimationDefinitionSource.Kind

get

Gets the high-level source kind.

Definition at line 17 of file AnimationDefinitionSource.cs.