Class ButtonInteractionHandler<Value>

The ButtonInteractionHandler class is responsible for managing the interactions with button-like objects. Each button-like object can be represented as a ClickableMesh, ClickableSprite, or ClickableGroup, and can have an associated value. The ButtonInteractionHandler class handle the interaction events and update the state of the button-like object accordingly.

The generic parameter Value represents the type of the value property associated with this button.

Type Parameters

Value

Hierarchy (View Summary)

EventEmitter<ThreeMouseEventMap<Value>>
- ButtonInteractionHandler
  - ClickableObject
  - CheckBoxInteractionHandler

Constructors

constructor

new ButtonInteractionHandler<Value>(
parameters: ButtonInteractionHandlerParameters<Value>,
): ButtonInteractionHandler<Value>
コンストラクタ
Type Parameters
- Value
Parameters
- parameters: ButtonInteractionHandlerParameters<Value>
Returns ButtonInteractionHandler<Value>
Overrides EventEmitter< ThreeMouseEventMap<Value> >.constructor
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:76

Properties

`Protected`_alpha

_alpha: number = 1.0

`Protected`_enable

_enable: boolean = true

`Protected`_isOver

_isOver: boolean = false

`Protected`_isPress

_isPress: boolean = false

`Protected` `Optional`_materialSet

_materialSet?: StateMaterialSet

frozen

frozen: boolean = false

mouseEnabled

mouseEnabled: boolean = true

state

state: ClickableState = "normal"

value

value: undefined | Value

The value property represents an arbitrary value associated with this button. This value can be used by classes listening to events from multiple buttons to differentiate the operations based on this value.

`Readonly`view

view: ClickableView<Value>

`Static`prefixed

prefixed: string | boolean

Accessors

alpha

set alpha(number: number): void
Parameters
- number: number
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:126

Methods

addListener

addListener<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    fn: (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
          T,
          keyof ThreeMouseEventMap<Value>,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

`Protected`checkActivity

checkActivity(): Boolean
現在のボタンの有効、無効状態を取得する

Returns Boolean
ボタンが有効か否か
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:140

disable

disable(): void
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:148

emit

emit<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
        T,
        keyof ThreeMouseEventMap<Value>,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
  T,
  keyof ThreeMouseEventMap<Value>,
  >]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

enable

enable(): void
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:144

eventNames

eventNames(): (keyof ThreeMouseEventMap<Value>)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ThreeMouseEventMap<Value>)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof ThreeMouseEventMap<Value>): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ThreeMouseEventMap<Value>
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
): (
    (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    fn?: (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
          T,
          keyof ThreeMouseEventMap<Value>,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    fn: (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
          T,
          keyof ThreeMouseEventMap<Value>,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    fn: (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
          T,
          keyof ThreeMouseEventMap<Value>,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

onMouseClick

onMouseClick(): void
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:108

onMouseDownHandler

onMouseDownHandler(event: ThreeMouseEvent<Value>): void
Parameters
- event: ThreeMouseEvent<Value>
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:83

onMouseOutHandler

onMouseOutHandler(event: ThreeMouseEvent<Value>): void
Parameters
- event: ThreeMouseEvent<Value>
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:114

onMouseOverHandler

onMouseOverHandler(event: ThreeMouseEvent<Value>): void
Parameters
- event: ThreeMouseEvent<Value>
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:110

onMouseUpHandler

onMouseUpHandler(event: ThreeMouseEvent<Value>): void
Parameters
- event: ThreeMouseEvent<Value>
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:90

removeAllListeners

removeAllListeners(event?: keyof ThreeMouseEventMap<Value>): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof ThreeMouseEventMap<Value>
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof ThreeMouseEventMap<Value>>(
    event: T,
    fn?: (
        ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
            T,
            keyof ThreeMouseEventMap<Value>,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof ThreeMouseEventMap<Value>
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
          T,
          keyof ThreeMouseEventMap<Value>,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

switchEnable

switchEnable(bool: boolean): void
Parameters
- bool: boolean
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:169

`Protected`updateMaterial

updateMaterial(): void
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:152

`Protected`updateState

updateState(state: ClickableState): void
Parameters
- state: ClickableState
Returns void
- Defined in src/interactionHandler/ButtonInteractionHandler.ts:131

Class ButtonInteractionHandler<Value>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ButtonInteractionHandler<Value>

Properties

Protected_alpha

Protected_enable

Protected_isOver

Protected_isPress

Protected Optional_materialSet

frozen

mouseEnabled

state

value

Readonlyview

Staticprefixed

Accessors

alpha

Parameters

Returns void

isOver

Returns boolean

isPress

Returns boolean

materialSet

Returns undefined | StateMaterialSet

Parameters

Returns void

Methods

addListener

Type Parameters

Parameters

Returns this

ProtectedcheckActivity

Returns Boolean

disable

Returns void

emit

Type Parameters

Parameters

Returns boolean

enable

Returns void

eventNames

Returns (keyof ThreeMouseEventMap<Value>)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract< T, keyof ThreeMouseEventMap<Value>, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

onMouseClick

Returns void

onMouseDownHandler

Parameters

Returns void

onMouseOutHandler

Parameters

`Protected`_alpha

`Protected`_enable

`Protected`_isOver

`Protected`_isPress

`Protected` `Optional`_materialSet

`Readonly`view

`Static`prefixed

`Protected`checkActivity

Returns (
(
...args: ArgumentMap<ThreeMouseEventMap<Value>>[Extract<
T,
keyof ThreeMouseEventMap<Value>,
>],
) => void
)[]

`Protected`updateMaterial

`Protected`updateState