Interface IOperator

Namespace: Unity.Muse.Common

Syntax

public interface IOperator

Properties

Hidden

Whether the operator should be hidden from the UI.

Declaration

bool Hidden { get; set; }

Property Value

Type	Description
Boolean

Label

Human-readable label for the operator.

Declaration

string Label { get; }

Property Value

Type	Description
String

OperatorName

Declaration

string OperatorName { get; }

Property Value

Type	Description
String

Methods

Clone()

Declaration

IOperator Clone()

Returns

Type	Description
IOperator

Enable(Boolean)

Declaration

void Enable(bool enable)

Parameters

Type	Name	Description
Boolean	enable

Enabled()

Declaration

bool Enabled()

Returns

Type	Description
Boolean

GetCanvasView()

Declaration

VisualElement GetCanvasView()

Returns

Type	Description
VisualElement

GetOperatorData()

Declaration

OperatorData GetOperatorData()

Returns

Type	Description
OperatorData

GetOperatorView(Model)

Declaration

VisualElement GetOperatorView(Model model)

Parameters

Type	Name	Description
Model	model

Returns

Type	Description
VisualElement

GetSettingsView()

Get the settings view for this operator.

Declaration

VisualElement GetSettingsView()

Returns

Type	Description
VisualElement	UI for the operator. Set to Null if the operator should not be displayed in the settings view. Disable the returned VisualElement if you want it to be displayed but not usable.

IsSavable()

Declaration

bool IsSavable()

Returns

Type	Description
Boolean

RegisterToEvents(Model)

Declaration

void RegisterToEvents(Model model)

Parameters

Type	Name	Description
Model	model

SetOperatorData(OperatorData)

Declaration

void SetOperatorData(OperatorData data)

Parameters

Type	Name	Description
OperatorData	data

UnregisterFromEvents(Model)

Declaration

void UnregisterFromEvents(Model model)

Parameters

Type	Name	Description
Model	model