gameforge - v0.1.39
    Preparing search index...

    Class FederatedPointerEvent

    A PIXI.FederatedEvent for pointer events.

    PIXI

    Hierarchy (View Summary)

    Implements

    • PointerEvent
    Index

    Constructors

    Properties

    altitudeAngle: number

    The angle in radians of a pointer or stylus measuring the vertical angle between the device's surface to the pointer or stylus. A stylus at 0 degrees would be directly parallel whereas at π/2 degrees it would be perpendicular.

    altKey: boolean

    Whether the "alt" key was pressed when this mouse event occurred.

    AT_TARGET: 2
    azimuthAngle: number

    The angle in radians of a pointer or stylus measuring an arc from the X axis of the device to the pointer or stylus projected onto the screen's plane. A stylus at 0 degrees would be pointing to the "0 o'clock" whereas at π/2 degrees it would be pointing at "6 o'clock".

    bubbles: boolean

    Flags whether this event bubbles. This will take effect only if it is set before propagation.

    BUBBLING_PHASE: 3
    button: number

    The specific button that was pressed in this mouse event.

    buttons: number

    The button depressed when this event occurred.

    cancelable: false

    Flags whether this event can be canceled using PIXI.FederatedEvent.preventDefault. This is always false (for now).

    cancelBubble: boolean

    since 7.0.0

    CAPTURING_PHASE: 1
    client: Point

    The coordinates of the mouse event relative to the canvas.

    composed: false

    Flag added for compatibility with DOM {@code Event}. It is not used in the Federated Events API.

    ctrlKey: boolean

    Whether the "control" key was pressed when this mouse event occurred.

    currentTarget: FederatedEventTarget

    The listeners of the event target that are being notified.

    defaultPrevented: boolean

    Flags whether the default response of the user agent was prevent through this event.

    detail: number

    This is the number of clicks that occurs in 200ms/click of each other.

    eventPhase: number

    The propagation phase.

    PIXI.FederatedEvent.NONE

    global: Point

    The pointer coordinates in world space.

    height: number

    The height of the pointer's contact along the y-axis, measured in CSS pixels. radiusY of TouchEvents will be represented by this value.

    isPrimary: boolean

    Indicates whether or not the pointer device that created the event is the primary pointer.

    isTrusted: boolean

    Flags whether this is a user-trusted event

    layer: Point

    The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property.

    manager: EventBoundary

    The PIXI.EventBoundary that manages this event. Null for root events.

    metaKey: boolean

    Whether the "meta" key was pressed when this mouse event occurred.

    movement: Point

    The movement in this pointer relative to the last mousemove event.

    nativeEvent: MouseEvent | PointerEvent | PixiTouch

    The native event that caused the foremost original event.

    NONE: 0
    offset: Point

    The offset of the pointer coordinates w.r.t. target DisplayObject in world space. This is not supported at the moment.

    originalEvent: FederatedEvent<MouseEvent | PointerEvent | PixiTouch>

    The original event that caused this event, if any.

    page: Point

    The coordinates of the event relative to the DOM document. This is a non-standard property.

    The composed path of the event's propagation. The {@code target} is at the end.

    pointerId: number

    The unique identifier of the pointer.

    pointerType: string

    The type of pointer that triggered the event.

    pressure: number

    Pressure applied by the pointing device during the event. s A Touch's force property will be represented by this value.

    propagationImmediatelyStopped: boolean

    Flags whether propagation was immediately stopped.

    propagationStopped: boolean

    Flags whether propagation was stopped.

    relatedTarget: EventTarget

    This is currently not implemented in the Federated Events API.

    returnValue: boolean

    since 7.0.0

    screen: Point

    The pointer coordinates in the renderer's PIXI.Renderer.screen screen. This has slightly different semantics than native PointerEvent screenX/screenY.

    shiftKey: boolean

    Whether the "shift" key was pressed when this mouse event occurred.

    srcElement: EventTarget

    since 7.0.0

    tangentialPressure: number

    Barrel pressure on a stylus pointer.

    The event target that this will be dispatched to.

    tiltX: number

    The angle, in degrees, between the pointer device and the screen.

    tiltY: number

    The angle, in degrees, between the pointer device and the screen.

    timeStamp: number

    The timestamp of when the event was created.

    twist: number

    Twist of a stylus pointer.

    type: string

    The type of event, e.g. {@code "mouseup"}.

    view: Window

    The global Window object.

    which: number

    Not supported.

    since 7.0.0

    width: number

    The width of the pointer's contact along the x-axis, measured in CSS pixels. radiusX of TouchEvents will be represented by this value.

    Accessors

    • get clientX(): number

      Returns number

    • get clientY(): number

      Returns number

    • get data(): this

      Fallback for the deprecated @code{PIXI.InteractionEvent.data}.

      Returns this

      since 7.0.0

    • get globalX(): number

      Returns number

    • get globalY(): number

      Returns number

    • get layerX(): number

      Returns number

    • get layerY(): number

      Returns number

    • get movementX(): number

      Returns number

    • get movementY(): number

      Returns number

    • get offsetX(): number

      Returns number

    • get offsetY(): number

      Returns number

    • get pageX(): number

      Returns number

    • get pageY(): number

      Returns number

    • get screenX(): number

      The pointer coordinates in the renderer's screen. Alias for {@code screen.x}.

      Returns number

    • get screenY(): number

      The pointer coordinates in the renderer's screen. Alias for {@code screen.y}.

      Returns number

    • get x(): number

      Alias for PIXI.FederatedMouseEvent.clientX this.clientX.

      Returns number

    • get y(): number

      Alias for PIXI.FederatedMouseEvent.clientY this.clientY.

      Returns number

    Methods

    • The getCoalescedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that were coalesced (merged) into a single pointermove or pointerrawupdate event. Instead of a stream of many pointermove events, user agents coalesce multiple updates into a single event. This helps with performance as the user agent has less event handling to perform, but there is a reduction in the granularity and accuracy when tracking, especially with fast and large movements. Available only in secure contexts.

      MDN Reference

      Returns PointerEvent[]

    • This will return the local coordinates of the specified displayObject for this InteractionData

      Type Parameters

      Parameters

      • displayObject: DisplayObject

        The DisplayObject that you would like the local coords off

      • Optionalpoint: P

        A Point object in which to store the value, optional (otherwise will create a new point)

      • OptionalglobalPos: IPointData

        A Point object containing your custom global coords, optional (otherwise will use the current global coords)

      Returns P

      • A point containing the coordinates of the InteractionData position relative to the DisplayObject
    • Whether the modifier key was pressed when this event natively occurred.

      Parameters

      • key: string

        The modifier key.

      Returns boolean

    • The getPredictedEvents() method of the PointerEvent interface returns a sequence of PointerEvent instances that are estimated future pointer positions. How the predicted positions are calculated depends on the user agent, but they are based on past points, current velocity, and trajectory.

      MDN Reference

      Returns PointerEvent[]

    • Unimplemented method included for implementing the DOM interface {@code Event}. It will throw an {@code Error}.

      Parameters

      • _type: string
      • Optional_bubbles: boolean
      • Optional_cancelable: boolean

      Returns void

    • Not supported.

      Parameters

      • _typeArg: string
      • _canBubbleArg: boolean
      • _cancelableArg: boolean
      • _viewArg: Window
      • _detailArg: number
      • _screenXArg: number
      • _screenYArg: number
      • _clientXArg: number
      • _clientYArg: number
      • _ctrlKeyArg: boolean
      • _altKeyArg: boolean
      • _shiftKeyArg: boolean
      • _metaKeyArg: boolean
      • _buttonArg: number
      • _relatedTargetArg: EventTarget

      Returns void

      since 7.0.0

    • Unimplemented method included for implementing the DOM interface {@code UIEvent}. It will throw an {@code Error}.

      Parameters

      • _typeArg: string
      • Optional_bubblesArg: boolean
      • Optional_cancelableArg: boolean
      • Optional_viewArg: Window | null
      • Optional_detailArg: number

      Returns void

    • Prevent default behavior of PixiJS and the user agent.

      Returns void

    • Stop this event from propagating to any addition listeners, including on the PIXI.FederatedEventTarget.currentTarget currentTarget and also the following event targets on the propagation path.

      Returns void

    • Stop this event from propagating to the next PIXI.FederatedEventTarget. The rest of the listeners on the PIXI.FederatedEventTarget.currentTarget currentTarget will still be notified.

      Returns void