Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Button3D

Class used to create a button in 3D

Hierarchy

Implements

Index

Constructors

constructor

  • Creates a new button

    Parameters

    • Optional name: string

      defines the control name

    Returns Button3D

Properties

Optional nameSearch playground for name

name: string | undefined

Defines the control name

onPointerClickObservableSearch playground for onPointerClickObservable

onPointerClickObservable: Observable<Vector3WithInfo>

An event triggered when a control is clicked on (with a mouse)

onPointerDownObservableSearch playground for onPointerDownObservable

onPointerDownObservable: Observable<Vector3WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservableSearch playground for onPointerEnterObservable

onPointerEnterObservable: Observable<Control3D>

An event triggered when pointer enters the control

onPointerMoveObservableSearch playground for onPointerMoveObservable

onPointerMoveObservable: Observable<Vector3>

An event triggered when the pointer move over the control

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer move out of the control

onPointerUpObservableSearch playground for onPointerUpObservable

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

parentSearch playground for parent

Gets or sets the parent container

pointerDownAnimationSearch playground for pointerDownAnimation

pointerDownAnimation: () => void

Callback used to start pointer down animation

Type declaration

    • (): void
    • Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

pointerEnterAnimation: () => void

Callback used to start pointer enter animation

Type declaration

    • (): void
    • Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

pointerOutAnimation: () => void

Callback used to start pointer out animation

Type declaration

    • (): void
    • Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

pointerUpAnimation: () => void

Callback used to start pointer up animation

Type declaration

    • (): void
    • Returns void

Accessors

behaviors

content

  • Gets or sets the GUI 2D content used to display the button's facade

    Returns Control

  • Gets or sets the GUI 2D content used to display the button's facade

    Parameters

    Returns any

contentResolution

  • get contentResolution(): int
  • set contentResolution(value: int): any
  • Gets or sets the texture resolution used to render content (512 by default)

    Returns int

  • Gets or sets the texture resolution used to render content (512 by default)

    Parameters

    Returns any

contentScaleRatio

  • get contentScaleRatio(): number
  • set contentScaleRatio(value: number): any
  • Gets or sets the texture scale ratio used to render content (2 by default)

    Returns number

  • Gets or sets the texture scale ratio used to render content (2 by default)

    Parameters

    • value: number

    Returns any

isVisible

  • get isVisible(): boolean
  • set isVisible(value: boolean): any
  • Gets or sets a boolean indicating if the control is visible

    Returns boolean

  • Gets or sets a boolean indicating if the control is visible

    Parameters

    • value: boolean

    Returns any

mesh

node

position

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns any

scaling

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns any

typeName

  • get typeName(): string
  • Gets a string representing the class name

    Returns string

Methods

addBehaviorSearch playground for addBehavior

disposeSearch playground for dispose

  • dispose(): void

getBehaviorByNameSearch playground for getBehaviorByName

getClassNameSearch playground for getClassName

  • getClassName(): string
  • Get the current class name of the control.

    Returns string

    current class name

linkToTransformNodeSearch playground for linkToTransformNode

removeBehaviorSearch playground for removeBehavior

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static method