Scripting API

Scripting API

SceneEditHandles

Class in Abyss.Core, from Abyss.Core.

A component's handles in the editor's Scene view while it is edited there, as an editor-only plugin says they are (Schedule.EditInScene): the dots a person drags, the lines a dot can be added on, and whether a dot can be deleted, each in the entity's own units on its XY plane, where its Transform puts it; and the points a person moves anywhere, in its own units, by the Move tool's arrows and squares.

public sealed class SceneEditHandles

Remarks

Given afresh, empty, each time the editor asks: a frame drawn, a press, a step of a drag.

Properties

Dots

public IReadOnlyList<Vector2> Dots { get; }

The dots, in the order they were said: a dot's index is its place here.

Points

public IReadOnlyList<Vector3> Points { get; }

The points, those that slide among them, in the order they were said: a point's index is its place here.

Ways

public IReadOnlyList<Vector3> Ways { get; }

The line each of SceneEditHandles.Points slides along, in the entity's own units; none for one a Move handle moves anywhere.

Lines

public IReadOnlyList<(Vector2 From, Vector2 To)> Lines { get; }

The lines a dot can be added on, in the order they were said: a line's index is its place here.

Spans

public IReadOnlyList<(Vector3 From, Vector3 To)> Spans { get; }

The lines a point can be added on, in 3D, in the order they were said: a line's index is its place here.

PickOne

public bool PickOne { get; set; }

Whether its points are picked one at a time: each drawn as a dot, a click on which picks it, and the one picked moved by the Move tool's handle; with Ctrl held a click on a dot deletes it, where SceneEditHandles.Deletable says one can be. A Line's points in 3D.

InWorld

public bool InWorld { get; set; }

Whether its dots, lines and points are in the world's units, rather than its entity's own: a Line's in World Space.

Deletable

public bool Deletable { get; set; }

Whether a click on a dot with Ctrl held deletes it: false where there are as few as there may be.

Color

public Vector4 Color { get; set; }

What the dots and lines are drawn in, red, green, blue and alpha from 0 to 1.

Methods

Dot

public void Dot(Vector2 at)

A dot at at, in the entity's own units.

Parameters

  • at

Line

public void Line(Vector2 from, Vector2 to)

A line from from to to, a dot added on which the plugin is told of.

Parameters

  • from
  • to

Span

public void Span(Vector3 from, Vector3 to)

A line in 3D from from to to, a point added on which is told of as SceneEditKind.PointAdded.

Parameters

  • from
  • to

Point

public void Point(Vector3 at)

A point at at, in the entity's own units, moved anywhere by a handle of the Move tool's — its arrows, its squares, and with Shift its middle — turned as the Scene row's Local or Global says, and snapped as the Move tool is: a joint's anchor.

Parameters

  • at

Slide

public void Slide(Vector3 at, Vector3 along)

A point at at, in the entity's own units, drawn as a dot and dragged along the line through it the way along goes alone, the pointer's place taken on that line, and snapped to the Move tool's step along it: a box collider's face. One that goes no way is a point a Move handle moves.

Parameters

  • at
  • along