Interface IVisjectSurfaceWindow

The base interface for editor windows that use FlaxEditor.Surface.VisjectSurface for content editing.

Namespace: FlaxEditor.Surface
Assembly: FlaxEngine.CSharp.dll
Syntax
public interface IVisjectSurfaceWindow : IVisjectSurfaceOwner, ISurfaceContext

Properties

NewParameterTypes

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

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

VisjectAsset

Gets the asset edited by the window.

Declaration
Asset VisjectAsset { get; }
Property Value
Asset

VisjectSurface

Gets the Visject surface editor.

Declaration
VisjectSurface VisjectSurface { get; }
Property Value
FlaxEditor.Surface.VisjectSurface

Methods

GetParameter(Int32)

Gets the asset parameter.

Declaration
object GetParameter(int index)
Parameters
System.Int32 index

The zero-based parameter index.
Returns
System.Object

The value.

OnParamAddUndo()

Called when parameter add undo action is performed.

Declaration
void OnParamAddUndo()

OnParamEditAttributesUndo()

Called when parameter edit attributes undo action is performed.

Declaration
void OnParamEditAttributesUndo()

OnParamRemoveUndo()

Called when parameter remove undo action is performed.

Declaration
void OnParamRemoveUndo()

OnParamRenameUndo()

Called when parameter rename undo action is performed.

Declaration
void OnParamRenameUndo()

SetParameter(Int32, Object)

Sets the asset parameter.

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

The zero-based parameter index.
System.Object value

The value to set.

Events

SurfaceLoaded

Event called when surface gets loaded (eg. after opening the window).

Declaration
event Action SurfaceLoaded
Event Type
System.Action

Extension Methods

See Also

FlaxEditor.Surface.IVisjectSurfaceOwner