Class BaseRuler

The ruler that is used to measure distances on the Canvas.

Mixes

RenderFlagsMixin

Hierarchy (View Summary)

BaseRuler
- Ruler

Constructors

constructor

new BaseRuler(user: documents.User): BaseRuler
Parameters
- user: documents.User
  The User for whom to construct the Ruler instance
Returns BaseRuler
Overrides RenderFlagsMixin().constructor

Properties

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 = "OBJECTS"

The ticker priority when RenderFlags of this class are handled. Valid values are OBJECTS or PERCEPTION.

`Static`RENDER_FLAGS

RENDER_FLAGS: { refresh: {} } = ...

Accessors

active

get active(): boolean
Is this Ruler active? True, if the path of the Ruler is nonempty.

Returns boolean

destination

get destination(): ElevatedPoint | undefined
The last point of the path, or undefined if the path is empty.

Returns ElevatedPoint | undefined

hidden

get hidden(): boolean
Is this Ruler hidden? If true, only the User of the Ruler can see it.

Returns boolean
Default Value
```
false
```

origin

get origin(): ElevatedPoint | undefined
The first point of the path, or undefined if the path is empty.

Returns ElevatedPoint | undefined

path

get path(): readonly Readonly<ElevatedPoint>[]
The sequence of points that the Ruler measures.

Returns readonly Readonly<ElevatedPoint>[]
Default Value
```
[]
```
set path(value: readonly Readonly<ElevatedPoint>[]): void
Set the sequence of points that the Ruler measures.
Parameters
- value: readonly Readonly<ElevatedPoint>[]
Returns void

user

get user(): documents.User
The User who this Ruler belongs to.

Returns documents.User

visible

get visible(): boolean
The Ruler is visible if it is active and either not hidden or its User is the current User.

Returns boolean

`Static`canMeasure

get canMeasure(): boolean
Is the Ruler ready to measure?

Returns boolean

Methods

applyRenderFlags

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

`Abstract`destroy

destroy(): void
Destroy the Ruler.

Returns void

`Abstract`draw

draw(): Promise<void>
Draw the Ruler.

Returns Promise<void>

refresh

refresh(): void
Refresh the Ruler.

Returns void

reset

reset(): void
Reset the path and the hidden state of the Ruler.

Returns void

`Protected`_addDragWaypoint

_addDragWaypoint(point: Point, options?: { snap?: boolean }): void
Protected
Add a waypoint.
Parameters
- point: Point
  The (unsnapped) waypoint
- Optionaloptions: { snap?: boolean } = {}
  Additional options
  - Optionalsnap?: boolean
    Snap the added waypoint?
Returns void

`Protected`_changeDragElevation

_changeDragElevation(delta: number, options?: { precise?: boolean }): void
Protected
Change the elevation of the destination.
Parameters
- delta: number
  The number vertical steps
- Optionaloptions: { precise?: boolean } = {}
  Additional options
  - Optionalprecise?: boolean
    Round elevations to multiples of the grid distance divided by CONFIG.Canvas.elevationSnappingPrecision? If false, rounds to multiples of the grid distance.
Returns void

`Protected`_onClickLeft

_onClickLeft(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle left-click events on the Canvas during Ruler measurement.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer-down event
Returns void

`Protected`_onClickRight

_onClickRight(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle right-click events on the Canvas during Ruler measurement.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer-down event
Returns void

`Protected`_onDragCancel

_onDragCancel(event: FederatedEvent<UIEvent | PixiTouch>): boolean | void
Protected
Handle the end of the Ruler measurement workflow
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The drag cancel event
Returns boolean | void
If false, the cancellation of the drag workflow is prevented

`Protected`_onDragStart

_onDragStart(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Handle the beginning of a new Ruler measurement workflow.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The drag start event
Returns void

`Protected`_onHiddenChange

_onHiddenChange(): void
Protected
Called when the Ruler becomes hidden or unhidden.

Returns void

`Protected`_onMouseMove

_onMouseMove(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Continue a Ruler measurement workflow for left-mouse movements on the Canvas.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The mouse move event
Returns void

`Protected`_onMouseUp

_onMouseUp(event: FederatedEvent<UIEvent | PixiTouch>): void
Protected
Conclude a Ruler measurement workflow by releasing the left-mouse button.
Parameters
- event: FederatedEvent<UIEvent | PixiTouch>
  The pointer-up event
Returns void

`Protected`_onMouseWheel

_onMouseWheel(event: WheelEvent): void
Protected
Adjust the elevation of Ruler waypoints by scrolling up/down.
Parameters
- event: WheelEvent
  The mousewheel event
Returns void

`Protected`_onPathChange

_onPathChange(): void
Protected
Called when the Ruler's path has changed.

Returns void

`Protected` `Abstract`_refresh

_refresh(): void
Protected
Refresh the Ruler.

Returns void

`Protected`_removeDragWaypoint

_removeDragWaypoint(): void
Protected
Remove the second to last waypoint.

Returns void

`Static`getSnappedPoint

getSnappedPoint(point: Point): Point
Snaps the given point to the grid.
Parameters
- point: Point
  The point that is to be snapped
Returns Point
The snapped point

Class BaseRuler

Mixes

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseRuler

Properties

renderFlags

StaticRENDER_FLAG_PRIORITY

StaticRENDER_FLAGS

Accessors

active

Returns boolean

destination

Returns ElevatedPoint | undefined

hidden

Returns boolean

Default Value

origin

Returns ElevatedPoint | undefined

path

Returns readonly Readonly<ElevatedPoint>[]

Default Value

Parameters

Returns void

user

Returns documents.User

visible

Returns boolean

StaticcanMeasure

Returns boolean

Methods

applyRenderFlags

Returns void

Abstractdestroy

Returns void

Abstractdraw

Returns Promise<void>

refresh

Returns void

reset

Returns void

Protected_addDragWaypoint

Parameters

Optionalsnap?: boolean

Returns void

Protected_changeDragElevation

Parameters

Optionalprecise?: boolean

Returns void

Protected_onClickLeft

Parameters

Returns void

Protected_onClickRight

Parameters

Returns void

Protected_onDragCancel

Parameters

Returns boolean | void

Protected_onDragStart

Parameters

Returns void

Protected_onHiddenChange

Returns void

Protected_onMouseMove

Parameters

Returns void

Protected_onMouseUp

Parameters

Returns void

Protected_onMouseWheel

Parameters

Returns void

Protected_onPathChange

`Static`RENDER_FLAG_PRIORITY

`Static`RENDER_FLAGS

`Static`canMeasure

`Abstract`destroy

`Abstract`draw

`Protected`_addDragWaypoint

`Optional`snap?: boolean

`Protected`_changeDragElevation

`Optional`precise?: boolean

`Protected`_onClickLeft

`Protected`_onClickRight

`Protected`_onDragCancel

`Protected`_onDragStart

`Protected`_onHiddenChange

`Protected`_onMouseMove

`Protected`_onMouseUp

`Protected`_onMouseWheel

`Protected`_onPathChange

`Protected` `Abstract`_refresh

`Protected`_removeDragWaypoint

`Static`getSnappedPoint