Options
All
  • Public
  • Public/Protected
  • All
Menu

Class used to create a holographic button in 3D

since

5.0.0

Hierarchy

Index

Constructors

Properties

name?: string

Defines the control name

onPointerClickObservable: Observable<Vector3WithInfo>

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

onPointerDownObservable: Observable<Vector3WithInfo>

An event triggered when the pointer taps the control

onPointerEnterObservable: Observable<Control3D>

An event triggered when pointer enters the control

onPointerMoveObservable: Observable<Vector3>

An event triggered when the pointer moves over the control

onPointerOutObservable: Observable<Control3D>

An event triggered when the pointer moves out of the control

onPointerUpObservable: Observable<Vector3WithInfo>

An event triggered when pointer is up

onToggleObservable: Observable<boolean>

An event triggered when the button is toggled. Only fired if 'isToggleButton' is true

Gets or sets the parent container

pointerDownAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer down animation

      Returns void

pointerEnterAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer enter animation

      Returns void

pointerOutAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer out animation

      Returns void

pointerUpAnimation: () => void

Type declaration

    • (): void
    • Callback used to start pointer up animation

      Returns void

MODEL_BASE_URL: string

Base Url for the button model.

MODEL_FILENAME: string

File name for the button model.

Accessors

  • Gets the back material used by this button

    Returns FluentMaterial

  • get collidableFrontDirection(): Vector3
  • set collidableFrontDirection(frontWorldDir: Vector3): void
  • Returns the front-facing direction of the button, or BABYLON.Vector3.Zero if there is no 'front'

    Returns Vector3

  • Sets the front-facing direction of the button. Pass in BABYLON.Vector3.Zero to allow interactions from any direction

    Parameters

    • frontWorldDir: Vector3

      the forward direction of the button

    Returns void

  • set collisionMesh(collisionMesh: Mesh): void
  • Sets the mesh used for testing input collision

    Parameters

    • collisionMesh: Mesh

      the new collision mesh for the button

    Returns void

  • 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 void

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

  • Gets the front material used by this button

    Returns FluentButtonMaterial

  • get imageUrl(): string
  • set imageUrl(value: string): void
  • Gets or sets the image url for the button

    Returns string

  • Gets or sets the image url for the button

    Parameters

    • value: string

    Returns void

  • get isActiveNearInteraction(): boolean
  • Whether the current interaction is caused by near interaction or not

    Returns boolean

  • set isBackplateVisible(isVisible: boolean): void
  • Sets whether the backplate is visible or hidden. Hiding the backplate is not recommended without some sort of replacement

    Parameters

    • isVisible: boolean

    Returns void

  • get isToggleButton(): boolean
  • set isToggleButton(value: boolean): void
  • Setter for if this TouchButton3D should be treated as a toggle button

    Returns boolean

  • Setter for if this TouchButton3D should be treated as a toggle button

    Parameters

    • value: boolean

      If this TouchHolographicButton should act like a toggle button

    Returns void

  • get isToggled(): boolean
  • set isToggled(newState: boolean): void
  • A public entrypoint to set the toggle state of the TouchHolographicButton. Only works if 'isToggleButton' is true

    Returns boolean

  • A public entrypoint to set the toggle state of the TouchHolographicButton. Only works if 'isToggleButton' is true

    Parameters

    • newState: boolean

      The new state to set the TouchHolographicButton's toggle state to

    Returns void

  • get isVisible(): boolean
  • set isVisible(value: boolean): void
  • 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 void

  • Gets the mesh used to render this control

    Returns Nullable<AbstractMesh>

  • Gets the transform node used by this control

    Returns Nullable<TransformNode>

  • Gets the plate material used by this button

    Returns StandardMaterial

  • Gets or sets the control position in world space

    Returns Vector3

  • Gets or sets the control position in world space

    Parameters

    Returns void

  • get renderingGroupId(): number
  • set renderingGroupId(id: number): void
  • 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 void

  • Gets or sets the control scaling in world space

    Returns Vector3

  • Gets or sets the control scaling in world space

    Parameters

    Returns void

  • get shareMaterials(): boolean
  • Gets a boolean indicating if this button shares its material with other HolographicButtons

    Returns boolean

  • get text(): string
  • set text(value: string): void
  • Gets or sets text for the button

    Returns string

  • Gets or sets text for the button

    Parameters

    • value: string

    Returns void

  • get tooltipText(): Nullable<string>
  • set tooltipText(text: Nullable<string>): void
  • 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 void

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

    Returns string

Methods

  • _prepareNode(scene: Scene): void
  • dispose(): void
  • Releases all associated resources

    Returns void

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

    Returns string

    current class name

  • getPressDepth(touchPoint: Vector3): number
  • Get the height of the touchPoint from the collidable part of the button

    Parameters

    • touchPoint: Vector3

      the point to compare to the button, in absolute position

    Returns number

    the depth of the touch point into the front of the button

Legend

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

Settings

Theme