Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIButtonPicture

Implemented by

Index

Properties

scale

scale: Vec2<Scale>

theme

theme: Theme

Methods

dispose

  • dispose(): this
  • Returns this

    Object itself for fluent interface

fitTo

  • fitTo(bounds: Point): this
  • Parameters

    Returns this

    Object itself

getDraggingMode

getFillStyle

getFillStyleHighlight

  • getFillStyleHighlight(): FillStyle | undefined
  • Returns FillStyle | undefined

    Highlight FillStyle of the object or undefined for auto assignment

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    True for highlighted state of object and false for basic

getIsUnderMouse

  • getIsUnderMouse(): boolean
  • Returns boolean

    Boolean for is object under mouse currently

getMargin

  • Returns Margin

    Margin datastructure

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getMouseStyle

  • Returns UIMouseStyle

    Interface for defining how mouse should look when hovering over UI object

getOrigin

  • Returns Point

    Vec2 with each plane in range [-1, 1], where 0 is middle

getPixelSize

getPosition

  • Parameters

    • Default value relativePosition: Point
    • Default value spaceOfInterest: UISpace

    Returns Point

    Object itself for fluent itself

getSize

  • Parameters

    • Default value spaceOfInterest: UISpace

    Returns Point

    Object size in pixels

getStrokeStyle

  • getStrokeStyle(): LineStyle
  • Returns LineStyle

getStrokeStyleHighlight

  • getStrokeStyleHighlight(): LineStyle | undefined
  • Returns LineStyle | undefined

    Highlight LineStyle of the object or undefined for auto assignment

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if all sub elements are disposed, false if not.

offMouseClick

  • offMouseClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDown

  • offMouseDown(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseMove

  • offMouseMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseUp

  • offMouseUp(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchMove

  • offTouchMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchStart

  • offTouchStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

onMouseClick

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseDoubleClick

onMouseDown

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseLeave

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseMove

onMouseUp

onMouseWheel

onTouchEnd

onTouchMove

onTouchStart

restore

  • restore(): this
  • Returns this

    Object itself itself for fluent interface

setDraggingMode

  • Parameters

    Returns this

    Object itself

setFillStyle

setFillStyleHighlight

setHighlighted

  • setHighlighted(isHighlighted: boolean): this
  • Parameters

    • isHighlighted: boolean

    Returns this

    Object itself for fluent interface

setMargin

  • setMargin(margin: Partial<MMargin> | number): this
  • Parameters

    • margin: Partial<MMargin> | number

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setMouseStyle

  • Parameters

    Returns this

    Object itself

setOrigin

  • setOrigin(origin: Point): this
  • Parameters

    Returns this

    Object itself

setPosition

  • setPosition(position: Point): this
  • Parameters

    Returns this

    Object itself

setStrokeStyle

  • Parameters

    Returns this

    Object itself for fluent interface

setStrokeStyleHighlight

  • setStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this
  • Parameters

    Returns this

    Object itself for fluent interface