Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class AmbientSound

    An AmbientSound is an implementation of PlaceableObject which represents a dynamic audio source within the Scene.

    Index

    Constructors

    constructor

    Properties

    _hoveredHandle _previewType controlIcon controls document field mouseInteractionManager renderFlags scene sound source tooltip _measurementDashLineStyle _measurementLabels _measurementLines _measurementSolidLineStyle embeddedName RENDER_FLAG_PRIORITY RENDER_FLAGS

    Accessors

    _original bounds center controlled hasActiveHUD hasPreview hover hoveredHandle id interactionState isAudible isInteractable isOwner isPreview isVisible layer objectId previewType radius sheet sourceId implementation

    Methods

    _applyRenderFlags _canConfigure _canDragLeftStart _canHUD _clear _destroy _draw _finalizeDragLeft _getMeasuredShapes _getShiftedPosition _getTargetAlpha _initializeDragLeft _initializeDragShape _onClickLeft _onClickLeft2 _onClickRight _onControl _onCreate _onDelete _onDragLeftCancel _onDragLeftDrop _onDragLeftMove _onDragLeftStart _onRelease _onUpdate _overlapsSelection _partialDraw _pasteObject _prepareDragLeftDropUpdates _refreshState _updateDragPreviews _updateQuadtree _updateRotation activateListeners applyEffects applyRenderFlags can clone control destroy draw getSnappedPosition initializeSoundSource refresh release rotate sync _canControl _canCreate _canDelete _canDrag _canHover _canUpdate _canView _createInteractionManager _createSound _finalizeDragRight _formatMeasuredDistance _getMeasurementTextStyle _getSoundSourceData _getTextStyle _getTooltipText _initializeDragRight _onClickRight2 _onDragEnd _onDragRightCancel _onDragRightDrop _onDragRightMove _onDragRightStart _onDragStart _onHoverIn _onHoverOut _onLongPress _onUnclickLeft _onUnclickRight _propagateLeftClick _propagateRightClick _refreshField _refreshMeasurements _refreshPosition _refreshSize _refreshTooltip _refreshVisibility #onDragRightStart _getCopiedObjectsOrigin _getShiftedPosition

    Constructors

    Properties

    Internal_hoveredHandle

    _hoveredHandle: ShapeControlsHandle | null = null

    Internal_previewType

    _previewType:
        | "wheel"
        | "controls"
        | "dragging"
        | "creation"
        | "config"
        | "api"
        | null

    The preview type, if any.

    controlIcon: ControlIcon | null

    A control icon for interacting with the object

    controls: AmbientSoundShapeControls

    The shape controls.

    document: CanvasDocument

    A reference to the Scene embedded Document instance which this object represents

    field: Graphics

    The area that is affected by this ambient sound.

    mouseInteractionManager: MouseInteractionManager | null

    A mouse interaction manager instance which handles mouse workflows related to this object.

    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".

    scene: documents.Scene

    Retain a reference to the Scene within which this Placeable Object resides

    sound: any

    The Sound which manages playback for this AmbientSound effect

    source: PointSoundSource

    A SoundSource object which manages the area of effect for this ambient sound

    tooltip: PreciseText

    The tooltip text of this AmbientSound, which contains its elevation.

    Protected_measurementDashLineStyle

    _measurementDashLineStyle: ILineStyleOptions

    The dashed measurement line style.

    Protected_measurementLabels

    _measurementLabels: Container<DisplayObject>

    The measurement labels.

    Protected_measurementLines

    _measurementLines: Graphics

    The measurement lines.

    Protected_measurementSolidLineStyle

    _measurementSolidLineStyle: ILineStyleOptions

    The solid measurement line style.

    embeddedName: string = "AmbientSound"
    RENDER_FLAG_PRIORITY: string = "OBJECTS"

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

    RENDER_FLAGS: {
        redraw: { propagate: string[] };
        refresh: { alias: boolean; propagate: string[] };
        refreshElevation: {
            alias: boolean;
            deprecated: { since: number; until: number };
            propagate: string[];
        };
        refreshField: {};
        refreshMeasurements: {};
        refreshPosition: { propagate: string[] };
        refreshSize: { propagate: string[] };
        refreshState: { propagate: string[] };
        refreshTooltip: {};
        refreshTransform: { alias: boolean; propagate: string[] };
        refreshVisibility: {};
    } = ...

    Type Declaration

    • redraw: { propagate: string[] }
    • refresh: { alias: boolean; propagate: string[] }
    • refreshElevation: {
          alias: boolean;
          deprecated: { since: number; until: number };
          propagate: string[];
      }

      since v14

    • refreshField: {}
    • refreshMeasurements: {}
    • refreshPosition: { propagate: string[] }
    • refreshSize: { propagate: string[] }
    • refreshState: { propagate: string[] }
    • refreshTooltip: {}
    • refreshTransform: { alias: boolean; propagate: string[] }
    • refreshVisibility: {}

    Accessors

    _original

    • get _original(): PlaceableObject | undefined

      The object that this object is a preview of if this object is a preview.

      Returns PlaceableObject | undefined

    • get bounds(): any

      Returns any

    • get center(): Point

      Returns Point

    • get controlled(): boolean

      An indicator for whether the object is currently controlled

      Returns boolean

    • get hasActiveHUD(): boolean

      Is the HUD display active for this Placeable?

      Returns boolean

    • get hasPreview(): boolean

      Does there exist a temporary preview of this placeable object?

      Returns boolean

    • get hover(): boolean

      An indicator for whether the object is currently a hover target

      Returns boolean

    • get hoveredHandle(): ShapeControlsHandle | null

      The controls handle that is currently hovered, if any.

      Returns ShapeControlsHandle | null

    • get id(): string

      The id of the corresponding Document which this PlaceableObject represents.

      Returns string

    • get interactionState(): | {
          CLICKED: number;
          DRAG: number;
          DROP: number;
          GRABBED: number;
          HOVER: number;
          NONE: number;
      }
      | undefined

      The mouse interaction state of this placeable.

      Returns
          | {
              CLICKED: number;
              DRAG: number;
              DROP: number;
              GRABBED: number;
              HOVER: number;
              NONE: number;
          }
          | undefined

    • get isAudible(): boolean

      Is this ambient sound is currently audible based on its hidden state and the darkness level of the Scene?

      Returns boolean

    • get isInteractable(): boolean

      Is the placeable currently interactable?

      Returns boolean

    • get isOwner(): boolean

      A convenient reference for whether the current User has full control over the document.

      Returns boolean

    • get isPreview(): boolean

      Is this placeable object a temporary preview?

      Returns boolean

    • get isVisible(): boolean

      Is this placeable currently visible?

      Returns boolean

    • get layer(): PlaceablesLayer

      Provide a reference to the CanvasLayer which contains this PlaceableObject.

      Returns PlaceablesLayer

    • get objectId(): string

      A unique identifier which is used to uniquely identify elements on the canvas related to this object.

      Returns string

    • get previewType(): "dragging" | "controls|"

      The preview type, if any.

      Returns "dragging" | "controls|"

    • get radius(): number

      A convenience accessor for the sound radius in pixels

      Returns number

    • get sheet(): DocumentSheetV2

      A document sheet used to configure the properties of this Placeable Object or the Document it represents.

      Returns DocumentSheetV2

    • get sourceId(): string

      The named identified for the source object associated with this PlaceableObject. This differs from the objectId because the sourceId is the same for preview objects as for the original.

      Returns string

    • get implementation(): typeof PlaceableObject

      Return a reference to the configured subclass of this base PlaceableObject type.

      Returns typeof PlaceableObject

    Methods

    _applyRenderFlags

    • _applyRenderFlags(flags: any): void

      Parameters

      • flags: any

      Returns void

    _canConfigure

    • _canConfigure(user: any, event: any): boolean

      Parameters

      • user: any
      • event: any

      Returns boolean

    _canDragLeftStart

    • _canDragLeftStart(user: any, event: any, options: any): any

      Parameters

      • user: any
      • event: any
      • options: any

      Returns any

    _canHUD

    • _canHUD(user: any, event: any): any

      Parameters

      • user: any
      • event: any

      Returns any

    _clear

    • _clear(): void

      Returns void

    _destroy

    • _destroy(options: any): void

      Parameters

      • options: any

      Returns void

    _draw

    • _draw(options: any): Promise<void>

      Parameters

      • options: any

      Returns Promise<void>

    _finalizeDragLeft

    • _finalizeDragLeft(event: any): void

      Parameters

      • event: any

      Returns void

    _getMeasuredShapes

    _getShiftedPosition

    • _getShiftedPosition(dx: -1 | 0 | 1, dy: -1 | 0 | 1, dz: -1 | 0 | 1): object
      Internal

      Obtain a shifted position for the Placeable Object.

      Parameters

      • dx: -1 | 0 | 1

        The number of grid units to shift along the X-axis

      • dy: -1 | 0 | 1

        The number of grid units to shift along the Y-axis

      • dz: -1 | 0 | 1

        The number of grid units to shift along the Z-axis

      Returns object

      The shifted target coordinates

    _getTargetAlpha

    • _getTargetAlpha(): number

      Returns number

    _initializeDragLeft

    • _initializeDragLeft(event: any): void

      Parameters

      • event: any

      Returns void

    _initializeDragShape

    • _initializeDragShape(event: FederatedEvent<UIEvent | PixiTouch>): BaseShapeData

      Initialize the shape for dragging.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The pointer event

      Returns BaseShapeData

      The shape that is dragged

    _onClickLeft

    • _onClickLeft(event: any): false | undefined

      Parameters

      • event: any

      Returns false | undefined

    _onClickLeft2

    • _onClickLeft2(event: any): any

      Parameters

      • event: any

      Returns any

    _onClickRight

    • _onClickRight(event: any): void

      Parameters

      • event: any

      Returns void

    _onControl

    • _onControl(options: any): void

      Parameters

      • options: any

      Returns void

    _onCreate

    • _onCreate(data: any, options: any, userId: any): void

      Parameters

      • data: any
      • options: any
      • userId: any

      Returns void

    _onDelete

    • _onDelete(options: any, userId: any): void

      Parameters

      • options: any
      • userId: any

      Returns void

    _onDragLeftCancel

    • _onDragLeftCancel(event: any): any

      Parameters

      • event: any

      Returns any

    _onDragLeftDrop

    • _onDragLeftDrop(event: any): any

      Parameters

      • event: any

      Returns any

    _onDragLeftMove

    • _onDragLeftMove(event: any): any

      Parameters

      • event: any

      Returns any

    _onDragLeftStart

    • _onDragLeftStart(event: any): any

      Parameters

      • event: any

      Returns any

    _onRelease

    • _onRelease(options: any): void

      Parameters

      • options: any

      Returns void

    _onUpdate

    • _onUpdate(changed: any, options: any, userId: any): void

      Parameters

      • changed: any
      • options: any
      • userId: any

      Returns void

    _overlapsSelection

    • _overlapsSelection(rectangle: any): any

      Parameters

      • rectangle: any

      Returns any

    _partialDraw

    • _partialDraw(fn: () => Promise<void>): Promise<PlaceableObject>
      Internal

      Execute a partial draw.

      Parameters

      • fn: () => Promise<void>

        The draw function

      Returns Promise<PlaceableObject>

      The drawn object

    _pasteObject

    • _pasteObject(
          offset: Point,
          options?: { cut?: boolean; hidden?: boolean; snap?: boolean },
      ): object
      Internal

      Get the data of the copied object pasted at the position given by the offset. Called by foundry.canvas.layers.PlaceablesLayer#pasteObjects for each copied object.

      Parameters

      • offset: Point

        The offset relative from the current position to the destination

      • Optionaloptions: { cut?: boolean; hidden?: boolean; snap?: boolean } = {}

        Options of foundry.canvas.layers.PlaceablesLayer#pasteObjects

        • Optionalcut?: boolean

          Is cut operation?

        • Optionalhidden?: boolean

          Paste in a hidden state, if applicable. Default is false.

        • Optionalsnap?: boolean

          Snap to the grid. Default is true.

      Returns object

      The create or update data

    _prepareDragLeftDropUpdates

    • _prepareDragLeftDropUpdates(
          event: any,
      ): (
          | {
              _id: any;
              shape?: undefined;
              shapes: any;
              x?: undefined;
              y?: undefined;
          }
          | {
              _id: any;
              shape: any;
              shapes?: undefined;
              x?: undefined;
              y?: undefined;
          }
          | { _id: any; shape?: undefined; shapes?: undefined; x: any; y: any }
      )[]

      Parameters

      • event: any

      Returns (
          | {
              _id: any;
              shape?: undefined;
              shapes: any;
              x?: undefined;
              y?: undefined;
          }
          | {
              _id: any;
              shape: any;
              shapes?: undefined;
              x?: undefined;
              y?: undefined;
          }
          | { _id: any; shape?: undefined; shapes?: undefined; x: any; y: any }
      )[]

    _refreshState

    • _refreshState(): void

      Returns void

    _updateDragPreviews

    • _updateDragPreviews(event: any): void

      Parameters

      • event: any

      Returns void

    _updateQuadtree

    • _updateQuadtree(): void
      Internal

      Update the quadtree.

      Returns void

    _updateRotation

    • _updateRotation(
          options?: { angle?: number; delta?: number; snap?: number },
      ): number
      Internal

      Determine a new angle of rotation for a PlaceableObject either from an explicit angle or from a delta offset.

      Parameters

      • options: { angle?: number; delta?: number; snap?: number } = {}

        An object which defines the rotation update parameters

        • Optionalangle?: number

          An explicit angle, either this or delta must be provided

        • Optionaldelta?: number

          A relative angle delta, either this or the angle must be provided

        • Optionalsnap?: number

          A precision (in degrees) to which the resulting angle should snap. Default is 0.

      Returns number

      The new rotation angle for the object

    • Activate interactivity for the Placeable Object

      Returns void

    • Update the set of effects which are applied to the managed Sound.

      Parameters

      • Optionaloptions: { muffled?: boolean } = {}
        • Optionalmuffled?: boolean

          Is the sound currently muffled?

      Returns void

    • Returns void

    • Test whether a user can perform a certain interaction regarding a Placeable Object

      Parameters

      • user: documents.User

        The User performing the action. Must be equal to game.user.

      • action:
            | "view"
            | "create"
            | "update"
            | "delete"
            | "control"
            | "hover"
            | "drag"
            | "configure"
            | "HUD"

        The named action being attempted

      Returns boolean

      Does the User have rights to perform the action?

    • Clone the placeable object, returning a new object with identical attributes. The returned object is non-interactive, and has no assigned ID. If you plan to use it permanently you should call the create method.

      Returns PlaceableObject

      A new object with identical data

    • Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors

      Parameters

      • Optionaloptions: {
            force?: boolean;
            isNew?: boolean;
            releaseOthers?: boolean;
            renderSidebar?: boolean;
        } = {}

        Additional options which modify the control request

        • Optionalforce?: boolean

          Control the object even if it is not interactable?

        • OptionalisNew?: boolean

          Was this object just created?

        • OptionalreleaseOthers?: boolean

          Release any other controlled objects first

        • OptionalrenderSidebar?: boolean

          Re-render the sidebar.

      Returns boolean

      A flag denoting whether control was successful

    • Parameters

      • options: any

      Returns any

    • Draw the placeable object into its parent container

      Parameters

      • Optionaloptions: object = {}

        Options which may modify the draw and refresh workflow

      Returns Promise<PlaceableObject>

      The drawn object

    • Get the snapped position for a given position or the current position.

      Parameters

      • Optionalposition: any

        The position to be used instead of the current position

      Returns Point

      The snapped position

    • Compute the field-of-vision for an object, determining its effective line-of-sight and field-of-vision polygons

      Parameters

      • Optionaloptions: { deleted?: boolean } = {}

        Options which modify how the audio source is updated

        • Optionaldeleted?: boolean

          Indicate that this SoundSource has been deleted.

      Returns void

    • Refresh all incremental render flags for the PlaceableObject. This method is no longer used by the core software but provided for backwards compatibility.

      Parameters

      • Optionaloptions: object = {}

        Options which may modify the refresh workflow

      Returns PlaceableObject

      The refreshed object

    • Release control over a PlaceableObject, removing it from the controlled set

      Parameters

      • options: { renderSidebar?: boolean } = {}

        Options which modify the releasing workflow

        • OptionalrenderSidebar?: boolean

          Re-render the sidebar.

      Returns boolean

      A Boolean flag confirming the object was released.

    • Rotate the PlaceableObject to a certain angle of facing

      Parameters

      • angle: number

        The desired angle of rotation

      • snap: number

        Snap the angle of rotation to a certain target degree increment

      Returns Promise<PlaceableObject>

      The rotated object

    • Toggle playback of the sound depending on whether it is audible.

      Parameters

      • isAudible: boolean

        Is the sound audible?

      • Optionalvolume: number

        The target playback volume

      • Optionaloptions: { fade?: number; muffled?: boolean } = {}

        Additional options which affect sound synchronization

        • Optionalfade?: number

          A duration in milliseconds to fade volume transition

        • Optionalmuffled?: boolean

          Is the sound current muffled?

      Returns Promise<void>

      A promise which resolves once sound playback is synchronized

    Protected_canControl

    • _canControl(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to control the Placeable Object?

      Parameters

      Returns boolean

    Protected_canCreate

    • _canCreate(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to create the underlying Document?

      Parameters

      Returns boolean

    Protected_canDelete

    • _canDelete(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to delete the underlying Document?

      Parameters

      Returns boolean

    Protected_canDrag

    • _canDrag(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to drag this Placeable Object?

      Parameters

      Returns boolean

    Protected_canHover

    • _canHover(
          user: documents.User,
          event?: Event | FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to hover on this Placeable Object?

      Parameters

      Returns boolean

    Protected_canUpdate

    • _canUpdate(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to update the underlying Document?

      Parameters

      Returns boolean

    Protected_canView

    • _canView(
          user: documents.User,
          event?: FederatedEvent<UIEvent | PixiTouch>,
      ): boolean
      Protected

      Does the User have permission to view details of the Placeable Object?

      Parameters

      Returns boolean

    Protected_createInteractionManager

    • _createInteractionManager(): MouseInteractionManager | null
      Protected

      Create a standard MouseInteractionManager for the PlaceableObject

      Returns MouseInteractionManager | null

    Protected_createSound

    • _createSound(): any
      Protected

      Create a Sound used to play this AmbientSound object

      Returns any

    Protected_finalizeDragRight

    • _finalizeDragRight(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Finalize the right-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering mouse click event

      Returns void

    Protected_formatMeasuredDistance

    • _formatMeasuredDistance(distance: number): string
      Protected

      Format a distance that is displayed in a measurement label.

      Parameters

      • distance: number

        The distance

      Returns string

      The distance label

    Protected_getMeasurementTextStyle

    • _getMeasurementTextStyle(): TextStyle
      Protected

      Define a PIXI TextStyle object which is used for the measurement labels.

      Returns TextStyle

    Protected_getSoundSourceData

    • _getSoundSourceData(): BaseEffectSourceData
      Protected

      Get the sound source data.

      Returns BaseEffectSourceData

    Protected_getTextStyle

    • _getTextStyle(): TextStyle
      Protected

      Get the text style that should be used for the tooltip.

      Returns TextStyle

    Protected_getTooltipText

    • _getTooltipText(): string
      Protected

      Return the text which should be displayed in the tooltip.

      Returns string

    Protected_initializeDragRight

    • _initializeDragRight(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Initialize the right-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_onClickRight2

    • _onClickRight2(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Callback actions which occur on a double right-click event to configure properties of the object

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_onDragEnd

    • _onDragEnd(): void
      Protected

      Conclude a drag operation from the perspective of the preview clone. Modify the appearance of both the clone (this) and the original (_original) object.

      Returns void

    Protected_onDragRightCancel

    • _onDragRightCancel(event: FederatedEvent<UIEvent | PixiTouch>): boolean | void
      Protected

      Callback actions which occur on a right mouse-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering mouse click event

      Returns boolean | void

      If false, the cancellation is prevented

    Protected_onDragRightDrop

    • _onDragRightDrop(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Callback actions which occur on a right mouse-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_onDragRightMove

    • _onDragRightMove(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Callback actions which occur on a right mouse-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_onDragRightStart

    • _onDragRightStart(event: FederatedEvent<UIEvent | PixiTouch>): false | void
      Protected

      Callback actions which occur on a right mouse-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering mouse click event

      Returns false | void

      If false, the start if prevented

    Protected_onDragStart

    • _onDragStart(): void
      Protected

      Begin a drag operation from the perspective of the preview clone. Modify the appearance of both the clone (this) and the original (_original) object.

      Returns void

    Protected_onHoverIn

    • _onHoverIn(
          event: Event | FederatedEvent<UIEvent | PixiTouch>,
          options?: { hoverOutOthers?: boolean; updateLegend?: boolean },
      ): boolean | void
      Protected

      Actions that should be taken for this Placeable Object when a mouseover event occurs. Hover events on PlaceableObject instances allow event propagation by default.

      Parameters

      • event: Event | FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas or DOM interaction event

      • Optionaloptions: { hoverOutOthers?: boolean; updateLegend?: boolean } = {}

        Options which customize event handling

        • OptionalhoverOutOthers?: boolean

          Trigger hover-out behavior on sibling objects

        • OptionalupdateLegend?: boolean

          Highlight corresponding entry in the sidebar legend.

      Returns boolean | void

    Protected_onHoverOut

    • _onHoverOut(
          event: Event | FederatedEvent<UIEvent | PixiTouch>,
          options?: { updateLegend?: boolean },
      ): void
      Protected

      Actions that should be taken for this Placeable Object when a mouseout event occurs

      Parameters

      • event: Event | FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas or DOM interaction event

      • Optionaloptions: { updateLegend?: boolean } = {}

        Options which customize event handling

        • OptionalupdateLegend?: boolean

          Highlight corresponding entry in the sidebar legend.

      Returns void

    Protected_onLongPress

    • _onLongPress(event: FederatedEvent<UIEvent | PixiTouch>, origin: Point): any
      Protected

      Callback action which occurs on a long press.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      • origin: Point

        The local canvas coordinates of the mousepress.

      Returns any

    Protected_onUnclickLeft

    • _onUnclickLeft(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Callback actions which occur on a single left-unclick event to assume control of the object

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_onUnclickRight

    • _onUnclickRight(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Callback actions which occur on a single right-unclick event

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering canvas interaction event

      Returns void

    Protected_propagateLeftClick

    • _propagateLeftClick(event: FederatedEvent<UIEvent | PixiTouch>): boolean
      Protected

      Should the placeable propagate left click downstream?

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

      Returns boolean

    Protected_propagateRightClick

    • _propagateRightClick(event: FederatedEvent<UIEvent | PixiTouch>): boolean
      Protected

      Should the placeable propagate right click downstream?

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

      Returns boolean

    Protected_refreshField

    • _refreshField(): void
      Protected

      Refresh the shape of the sound field-of-effect. This is refreshed when the SoundSource fov polygon changes.

      Returns void

    Protected_refreshMeasurements

    • _refreshMeasurements(): void
      Protected

      Refresh the measurements.

      Returns void

    Protected_refreshPosition

    • _refreshPosition(): void
      Protected

      Refresh the position of the AmbientSound. Called with the coordinates change.

      Returns void

    Protected_refreshSize

    • _refreshSize(): void
      Protected

      Refresh the size of the AmbientSound.

      Returns void

    Protected_refreshTooltip

    • _refreshTooltip(): void
      Protected

      Refresh the tooltip.

      Returns void

    Protected_refreshVisibility

    • _refreshVisibility(): void
      Protected

      Refresh the visibility of the placeable.

      Returns void

    • Protected

      Callback actions which occur on a right mouse-drag operation.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The triggering mouse click event

      Returns false | void

      If false, the start if prevented

    Static_getCopiedObjectsOrigin

    • _getCopiedObjectsOrigin(copies: PlaceableObject[]): Point
      Internal

      Get the origin used for pasting the copied objects.

      Parameters

      Returns Point

      The offset

    Static_getShiftedPosition

    • _getShiftedPosition(
          dx: -1 | 0 | 1,
          dy: -1 | 0 | 1,
          dz: -1 | 0 | 1,
          position: ElevatedPoint,
          snapped: ElevatedPoint,
          grid: BaseGrid<GridCoordinates2D, GridCoordinates3D>,
      ): ElevatedPoint
      Internal

      Obtain the shifted position.

      Parameters

      • dx: -1 | 0 | 1

        The number of grid units to shift along the X-axis

      • dy: -1 | 0 | 1

        The number of grid units to shift along the Y-axis

      • dz: -1 | 0 | 1

        The number of grid units to shift along the Z-axis

      • position: ElevatedPoint

        The unsnapped position

      • snapped: ElevatedPoint

        The snapped position

      • grid: BaseGrid<GridCoordinates2D, GridCoordinates3D>

        The grid

      Returns ElevatedPoint

      The shifted target coordinates

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    _applyRenderFlags_canConfigure_canDragLeftStart_canHUD_clear_destroy_draw_finalizeDragLeft_getMeasuredShapes_getShiftedPosition_getTargetAlpha_initializeDragLeft_initializeDragShape_onClickLeft_onClickLeft2_onClickRight_onControl_onCreate_onDelete_onDragLeftCancel_onDragLeftDrop_onDragLeftMove_onDragLeftStart_onRelease_onUpdate_overlapsSelection_partialDraw_pasteObject_prepareDragLeftDropUpdates_refreshState_updateDragPreviews_updateQuadtree_updateRotationactivateListenersapplyEffectsapplyRenderFlagscanclonecontroldestroydrawgetSnappedPositioninitializeSoundSourcerefreshreleaserotatesync_canControl_canCreate_canDelete_canDrag_canHover_canUpdate_canView_createInteractionManager_createSound_finalizeDragRight_formatMeasuredDistance_getMeasurementTextStyle_getSoundSourceData_getTextStyle_getTooltipText_initializeDragRight_onClickRight2_onDragEnd_onDragRightCancel_onDragRightDrop_onDragRightMove_onDragRightStart_onDragStart_onHoverIn_onHoverOut_onLongPress_onUnclickLeft_onUnclickRight_propagateLeftClick_propagateRightClick_refreshField_refreshMeasurements_refreshPosition_refreshSize_refreshTooltip_refreshVisibility#onDragRightStart_getCopiedObjectsOrigin_getShiftedPosition