Class ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>

Controls for a shape.

Template: DocumentClass

Template: ObjectClass

Template: LayerClass

Template: ShapeClass

Type Parameters

DocumentClass extends Document
ObjectClass extends PlaceableObject
LayerClass extends PlaceablesLayer
ShapeClass extends BaseShapeData = BaseShapeData

Hierarchy (View Summary)

ShapeControls

Index

Constructors

constructor

new ShapeControls<
    DocumentClass extends Document<object, DocumentConstructionContext>,
    ObjectClass extends PlaceableObject,
    LayerClass extends PlaceablesLayer,
    ShapeClass extends BaseShapeData = BaseShapeData,
>(
    shape: ShapeClass,
): ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>
Type Parameters
- DocumentClass extends Document<object, DocumentConstructionContext>
- ObjectClass extends PlaceableObject
- LayerClass extends PlaceablesLayer
- ShapeClass extends BaseShapeData = BaseShapeData
Parameters
- shape: ShapeClass
  The shape.
Returns ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>
Overrides RenderFlagsMixin(PIXI.Container).constructor

Properties

editable

editable: boolean = true

Are the controls editable?

Default Value

true

renderFlags

renderFlags: RenderFlags

Status flags which are applied at render-time to update the PlaceableObject. If an object defines RenderFlags, it should at least include flags for "redraw" and "refresh".

`Static`RENDER_FLAG_PRIORITY

RENDER_FLAG_PRIORITY: string = "INTERFACE"

`Static`RENDER_FLAGS

RENDER_FLAGS: { redraw: { propagate: string[] }; refresh: {} } = ...

Accessors

border

get border(): Graphics
The border of the shape.

Returns Graphics

dashed

get dashed(): boolean
Is the border dashed?

Returns boolean
Default Value
```
false
```

document

get document(): DocumentClass
The Document of this shape.

Returns DocumentClass

handles

get handles(): Container<ShapeControlsHandle>
The handles of the shape.

Returns Container<ShapeControlsHandle>

layer

get layer(): LayerClass
The PlaceableLayer of this shape.

Returns LayerClass

object

get object(): ObjectClass
The PlaceableObject of this shape.

Returns ObjectClass

shape

get shape(): ShapeClass
The shape.

Returns ShapeClass

tint

get tint(): number
The tint applied to these controls.

Returns number
Default Value
```
0xFFFFFF
```

Methods

_onDragDrop

_onDragDrop(event: any): void
Parameters
- event: any
Returns void
Inherit Doc

applyRenderFlags

applyRenderFlags(): void
Returns void
Overrides RenderFlagsMixin(PIXI.Container).applyRenderFlags

destroy

destroy(options: any): void
Parameters
- options: any
Returns void
Inherit Doc

draw

draw(): Promise<
ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>,
>
Draw the visualization of these controls.

Returns Promise<ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>>

refresh

refresh(): void
Refresh the visualization of these controls.

Returns void

`Protected`_canDragStart

_canDragStart(
event: FederatedEvent<UIEvent | PixiTouch>,
options?: { notify: boolean },
): boolean
Protected
Can the handle be dragged?
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event
- Optionaloptions: { notify: boolean }
  Options, used internally
Returns boolean

`Protected`_clear

_clear(): void
Protected
Clear these controls.

Returns void

`Protected`_draw

_draw(): Promise<void>
Protected
Draw these controls.

Returns Promise<void>

`Protected`_drawShape

_drawShape(graphics: Graphics): void
Protected
Draw the shape.
Parameters
- graphics: Graphics
Returns void

`Protected`_onClick2

_onClick2(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle the double left-click event of a handle.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns void

`Protected`_onDragCancel

_onDragCancel(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle the drag cancel event of a handle.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns void

`Protected`_onDragMove

_onDragMove(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle the drag move event of a handle.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns void

`Protected`_onDragStart

_onDragStart(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle the drag start event of a handle.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns void

`Protected`_prepareDragDropUpdate

_prepareDragDropUpdate(
event: FederatedEvent<UIEvent | PixiTouch>,
): object | [data: object, options?: object]
Protected
Prepare the database update that should occur as the result of a drop operation.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns object | [data: object, options?: object]
The update data and options (optional)

`Protected`_refresh

_refresh(): void
Protected
Refresh the visualization of these controls.

Returns void

`Protected`_updateDragPreview

_updateDragPreview(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Update the drag preview. Called when the shape has changed.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer event.
Returns void

`Static`_createDragPreview

_createDragPreview(object: ObjectClass): ObjectClass
Internal
Create and draw the drag preview for a placeable object.
Parameters
- object: ObjectClass
  The original placeable object
Returns ObjectClass
The preview of the placeable object.

Class ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>

Template: DocumentClass

Template: ObjectClass

Template: LayerClass

Template: ShapeClass

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>

Properties

editable

Default Value

renderFlags

StaticRENDER_FLAG_PRIORITY

StaticRENDER_FLAGS

Accessors

border

Returns Graphics

dashed

Returns boolean

Default Value

document

Returns DocumentClass

handles

Returns Container<ShapeControlsHandle>

layer

Returns LayerClass

object

Returns ObjectClass

shape

Returns ShapeClass

tint

Returns number

Default Value

Methods

_onDragDrop

Parameters

Returns void

Inherit Doc

applyRenderFlags

Returns void

destroy

Parameters

Returns void

Inherit Doc

draw

Returns Promise<ShapeControls<DocumentClass, ObjectClass, LayerClass, ShapeClass>>

refresh

Returns void

Protected_canDragStart

Parameters

Returns boolean

Protected_clear

Returns void

Protected_draw

Returns Promise<void>

Protected_drawShape

Parameters

Returns void

Protected_onClick2

Parameters

Returns void

Protected_onDragCancel

Parameters

Returns void

Protected_onDragMove

Parameters

Returns void

Protected_onDragStart

Parameters

Returns void

Protected_prepareDragDropUpdate

`Static`RENDER_FLAG_PRIORITY

`Static`RENDER_FLAGS

`Protected`_canDragStart

`Protected`_clear

`Protected`_draw

`Protected`_drawShape

`Protected`_onClick2

`Protected`_onDragCancel

`Protected`_onDragMove

`Protected`_onDragStart

`Protected`_prepareDragDropUpdate

`Protected`_refresh

`Protected`_updateDragPreview

`Static`_createDragPreview