Interface ICanvasTool

Common Interface for Canvas Tools

Namespace: Unity.Muse.Common

Syntax

public interface ICanvasTool

Methods

ActivateOperators()

Activate the Operators

Declaration

void ActivateOperators()

EvaluateEnableState(Artifact)

Evaluate the Enable State of the Tool

Declaration

bool EvaluateEnableState(Artifact artifact)

Parameters

Type	Name	Description
Artifact	artifact

Returns

Type	Description
Boolean	Is the tool enabled or not

GetSettings()

Get the Settings Visual Element

Declaration

VisualElement GetSettings()

Returns

Type	Description
VisualElement	Settings Visual Element

GetToolData()

Get the Tool Button Data

Declaration

ICanvasTool.ToolButtonData GetToolData()

Returns

Type	Description
ICanvasTool.ToolButtonData	Tool Button Data

GetToolManipulator()

Get the Canvas Manipulator

Declaration

CanvasManipulator GetToolManipulator()

Returns

Type	Description
CanvasManipulator	Canvas Manipulator

SetModel(Model)

Set the Model

Declaration

void SetModel(Model model)

Parameters

Type	Name	Description
Model	model