Class AnimationGraphWindow

Animation Graph window allows to view and edit AnimationGraph asset.

Namespace: FlaxEditor.Windows.Assets
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class AnimationGraphWindow : VisjectSurfaceWindow<AnimationGraph, AnimGraphSurface, AnimatedModelPreview>, IComparable, IDrawable, IEditable, IContentItemOwner, IVisjectSurfaceWindow, IVisjectSurfaceOwner, ISurfaceContext, ISearchWindow

Constructors

AnimationGraphWindow(Editor, AssetItem)

Declaration
public AnimationGraphWindow(Editor editor, AssetItem item)
Parameters
Editor editor

FlaxEditor.Content.AssetItem item

Properties

AssetType

Gets the type of the asset for the search.

Declaration
public SearchAssetTypes AssetType { get; }
Property Value
SearchAssetTypes

Implements

NewParameterTypes

The new parameter types enum type to use. Null to disable adding new parameters.

Declaration
public override IEnumerable<ScriptType> NewParameterTypes { get; }
Property Value
System.Collections.Generic.IEnumerable<FlaxEditor.Scripting.ScriptType>

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.NewParameterTypes

PreviewActor

Gets the animated model actor used for the animation preview.

Declaration
public AnimatedModel PreviewActor { get; }
Property Value
AnimatedModel

SurfaceData

Declaration
public override byte[] SurfaceData { get; set; }
Property Value
System.Byte[]

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.SurfaceData

SurfaceName

Declaration
public override string SurfaceName { get; }
Property Value
System.String

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.SurfaceName

Methods

LoadSurface()

Loads the surface from the asset. Called during Update(Single) when asset is loaded and surface is missing.

Declaration
protected override bool LoadSurface()
Returns
System.Boolean

True if failed, otherwise false.
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.LoadSurface()

OnAssetLinked()

Called when asset gets linked and window can setup UI for it.

Declaration
protected override void OnAssetLinked()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.OnAssetLinked()

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.OnDestroy()

OnSurfaceEditingStart()

Called when surface gets loaded and user can edit it.

Declaration
protected override void OnSurfaceEditingStart()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.OnSurfaceEditingStart()

OnUpdate()

Called when every engine update. Note: Update(Single) may be called at the lower frequency than the engine updates.

Declaration
public override void OnUpdate()
Overrides

PerformLayoutBeforeChildren()

Perform layout for that container control before performing it for child controls.

Declaration
protected override void PerformLayoutBeforeChildren()
Overrides

SaveSurface()

Saves the surface to the asset. Called during Update(Single) when asset is loaded and surface is missing.

Declaration
protected override bool SaveSurface()
Returns
System.Boolean

True if failed, otherwise false.
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.SaveSurface()

SetBaseModel(SkinnedModel)

Sets the base model of the animation graph this window is editing.

Declaration
public void SetBaseModel(SkinnedModel baseModel)
Parameters
SkinnedModel baseModel

The new base model.

SetParameter(Int32, Object)

Sets the asset parameter.

Declaration
public override void SetParameter(int index, object value)
Parameters
System.Int32 index

The zero-based parameter index.
System.Object value

The value to set.
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.SetParameter(System.Int32, System.Object)

UnlinkItem()

Unlinks the item. Removes reference to it and unbinds all events.

Declaration
protected override void UnlinkItem()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.AnimationGraph, FlaxEditor.Surface.AnimGraphSurface, FlaxEditor.Viewport.Previews.AnimatedModelPreview>.UnlinkItem()

Extension Methods

See Also

FlaxEditor.Surface.AnimGraphSurface