API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HolographicButton

Class used to create a holographic button in 3D

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates a new button

    Parameters

    • Optional name: string

      defines the control name

    • Optional shareMaterials: boolean

    Returns HolographicButton

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 moves over the control

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer moves out of the control

onPointerUpObservableSearch playground for onPointerUpObservable

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

parentSearch playground for parent

parent: Nullable<Container3D>

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

backMaterial

  • Gets the back material used by this button

    Returns FluentMaterial

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(): number
  • set contentResolution(value: number): any

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

    Returns number

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

    Parameters

    • value: number

    Returns any

frontMaterial

  • Gets the front material used by this button

    Returns FluentMaterial

imageUrl

  • get imageUrl(): string
  • set imageUrl(value: string): any

  • Gets or sets the image url for the button

    Returns string

  • Gets or sets the image url for the button

    Parameters

    • value: string

    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

plateMaterial

  • Gets the plate material used by this button

    Returns StandardMaterial

position

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns any

renderingGroupId

  • get renderingGroupId(): number
  • set renderingGroupId(id: number): any

  • Rendering ground id of all the mesh in the button

    Returns number

  • Rendering ground id of all the mesh in the button

    Parameters

    • id: number

    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

shareMaterials

  • get shareMaterials(): boolean

  • Gets a boolean indicating if this button shares its material with other HolographicButtons

    Returns boolean

text

  • get text(): string
  • set text(value: string): any

  • Gets or sets text for the button

    Returns string

  • Gets or sets text for the button

    Parameters

    • value: string

    Returns any

tooltipText

  • get tooltipText(): Nullable<string>
  • set tooltipText(text: Nullable<string>): any

  • Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)

    Returns Nullable<string>

  • Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)

    Parameters

    Returns any

typeName

  • get typeName(): string

  • Gets a string representing the class name

    Returns string

Methods

_prepareNodeSearch playground for _prepareNode

  • _prepareNode(scene: Scene): void

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 property
  • Static method