Class ParticleEmitterWindow

Particle Emitter window allows to view and edit ParticleEmitter asset.

Namespace: FlaxEditor.Windows.Assets
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class ParticleEmitterWindow : VisjectSurfaceWindow<ParticleEmitter, ParticleEmitterSurface, ParticleEmitterPreview>, IComparable, IDrawable, IEditable, IContentItemOwner, IVisjectSurfaceWindow, IVisjectSurfaceOwner, ISurfaceContext, ISearchWindow

Constructors

ParticleEmitterWindow(Editor, AssetItem)

Declaration
public ParticleEmitterWindow(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

CanEditSurfaceOnAssetLoadError

Gets a value indicating whether this window can edit asset surface on asset load error (eg. to fix asset loading issue due to graph problem).

Declaration
protected override bool CanEditSurfaceOnAssetLoadError { get; }
Property Value
System.Boolean

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.CanEditSurfaceOnAssetLoadError

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.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.NewParameterTypes

SurfaceData

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

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.SurfaceData

SurfaceName

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

Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.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.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.LoadSurface()

OnAssetLinked()

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

Declaration
protected override void OnAssetLinked()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.OnAssetLinked()

OnParamAddUndo()

Called when parameter add undo action is performed.

Declaration
public override void OnParamAddUndo()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.OnParamAddUndo()

OnParamRemoveUndo()

Called when parameter remove undo action is performed.

Declaration
public override void OnParamRemoveUndo()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.OnParamRemoveUndo()

OnParamRenameUndo()

Called when parameter rename undo action is performed.

Declaration
public override void OnParamRenameUndo()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.OnParamRenameUndo()

OnSurfaceEditingStart()

Called when surface gets loaded and user can edit it.

Declaration
protected override void OnSurfaceEditingStart()
Overrides
FlaxEditor.Surface.VisjectSurfaceWindow<FlaxEngine.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.OnSurfaceEditingStart()

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.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.SaveSurface()

SaveToOriginal()

Saves the copy of the asset to the original location. This action cannot be undone!

Declaration
protected override bool SaveToOriginal()
Returns
System.Boolean

True if failed, otherwise false.
Overrides
FlaxEditor.Windows.Assets.ClonedAssetEditorWindowBase<FlaxEngine.ParticleEmitter>.SaveToOriginal()

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.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.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.ParticleEmitter, FlaxEditor.Surface.ParticleEmitterSurface, FlaxEditor.Viewport.Previews.ParticleEmitterPreview>.UnlinkItem()

Extension Methods

See Also

FlaxEditor.Surface.ParticleEmitterSurface