Class Button3D

Class used to create a button in 3D

Hierarchy

AbstractButton3D
- Button3D

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Button3D(name?: string): Button3D

Overrides AbstractButton3D.constructor
- Defined in .temp/docdirectory/doc.d.ts:102650
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 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

behaviors

get behaviors(): Behavior<Control3D>[]

Inherited from AbstractButton3D.behaviors
- Defined in .temp/docdirectory/doc.d.ts:102832
Gets the list of attached behaviors

see

https://doc.babylonjs.com/features/behaviour

Returns Behavior<Control3D>[]

content

get content(): Control
set content(value: Control): any

Inherited from AbstractButton3D.content
- Defined in .temp/docdirectory/doc.d.ts:102752
Gets or sets the GUI 2D content used to display the button's facade

Returns Control
Inherited from AbstractButton3D.content
- Defined in .temp/docdirectory/doc.d.ts:102753
Gets or sets the GUI 2D content used to display the button's facade

Parameters
- value: Control
Returns any

contentResolution

get contentResolution(): number
set contentResolution(value: number): any

Inherited from AbstractButton3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:102757
Gets or sets the texture resolution used to render content (512 by default)

Returns number
Inherited from AbstractButton3D.contentResolution
- Defined in .temp/docdirectory/doc.d.ts:102758
Gets or sets the texture resolution used to render content (512 by default)

Parameters
- value: number
Returns any

isVisible

get isVisible(): boolean
set isVisible(value: boolean): any

Inherited from AbstractButton3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:102855
Gets or sets a boolean indicating if the control is visible

Returns boolean
Inherited from AbstractButton3D.isVisible
- Defined in .temp/docdirectory/doc.d.ts:102856
Gets or sets a boolean indicating if the control is visible

Parameters
- value: boolean
Returns any

mesh

get mesh(): Nullable<AbstractMesh>

Inherited from AbstractButton3D.mesh
- Defined in .temp/docdirectory/doc.d.ts:102881
Gets the mesh used to render this control

Returns Nullable<AbstractMesh>

node

get node(): Nullable<TransformNode>

Inherited from AbstractButton3D.node
- Defined in .temp/docdirectory/doc.d.ts:102877
Gets the transform node used by this control

Returns Nullable<TransformNode>

position

get position(): Vector3
set position(value: Vector3): any

Inherited from AbstractButton3D.position
- Defined in .temp/docdirectory/doc.d.ts:102786
Gets or sets the control position in world space

Returns Vector3
Inherited from AbstractButton3D.position
- Defined in .temp/docdirectory/doc.d.ts:102787
Gets or sets the control position in world space

Parameters
- value: Vector3
Returns any

scaling

get scaling(): Vector3
set scaling(value: Vector3): any

Inherited from AbstractButton3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:102789
Gets or sets the control scaling in world space

Returns Vector3
Inherited from AbstractButton3D.scaling
- Defined in .temp/docdirectory/doc.d.ts:102790
Gets or sets the control scaling in world space

Parameters
- value: Vector3
Returns any

typeName

get typeName(): string

Inherited from AbstractButton3D.typeName
- Defined in .temp/docdirectory/doc.d.ts:102867
Gets a string representing the class name

Returns string

Methods

_prepareNodeSearch playground for _prepareNode

_prepareNode(scene: Scene): void

Inherited from AbstractButton3D._prepareNode
- Defined in .temp/docdirectory/doc.d.ts:102892
hidden*

Parameters
- scene: Scene
Returns void

addBehaviorSearch playground for addBehavior

addBehavior(behavior: Behavior<Control3D>): Control3D

Implementation of IBehaviorAware.addBehavior

Inherited from AbstractButton3D.addBehavior
- Defined in .temp/docdirectory/doc.d.ts:102839
Attach a behavior to the control

see

https://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D

the current control

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Overrides AbstractButton3D.dispose
- Defined in .temp/docdirectory/doc.d.ts:102667
Releases all associated resources

Returns void

getBehaviorByNameSearch playground for getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Control3D>>

Implementation of IBehaviorAware.getBehaviorByName

Inherited from AbstractButton3D.getBehaviorByName
- Defined in .temp/docdirectory/doc.d.ts:102853
Gets an attached behavior by name

see

https://doc.babylonjs.com/features/behaviour

Parameters
- name: string
  
  defines the name of the behavior to look for
Returns Nullable<Behavior<Control3D>>

null if behavior was not found else the requested behavior

getClassNameSearch playground for getClassName

getClassName(): string

Inherited from AbstractButton3D.getClassName
- Defined in .temp/docdirectory/doc.d.ts:102872
Get the current class name of the control.

Returns string

current class name

linkToTransformNodeSearch playground for linkToTransformNode

linkToTransformNode(node: Nullable<TransformNode>): Control3D

Inherited from AbstractButton3D.linkToTransformNode
- Defined in .temp/docdirectory/doc.d.ts:102887
Link the control as child of the given node

Parameters
- node: Nullable<TransformNode>
  
  defines the node to link to. Use null to unlink the control
Returns Control3D

the current control

removeBehaviorSearch playground for removeBehavior

removeBehavior(behavior: Behavior<Control3D>): Control3D

Implementation of IBehaviorAware.removeBehavior

Inherited from AbstractButton3D.removeBehavior
- Defined in .temp/docdirectory/doc.d.ts:102846
Remove an attached behavior

see

https://doc.babylonjs.com/features/behaviour

Parameters
- behavior: Behavior<Control3D>
  
  defines the behavior to attach
Returns Control3D

the current control

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional name: string

Returns Button3D

Properties

Optional nameSearch playground for name

onPointerClickObservableSearch playground for onPointerClickObservable

onPointerDownObservableSearch playground for onPointerDownObservable

onPointerEnterObservableSearch playground for onPointerEnterObservable

onPointerMoveObservableSearch playground for onPointerMoveObservable

onPointerOutObservableSearch playground for onPointerOutObservable

onPointerUpObservableSearch playground for onPointerUpObservable

parentSearch playground for parent

pointerDownAnimationSearch playground for pointerDownAnimation

Type declaration

Returns void

pointerEnterAnimationSearch playground for pointerEnterAnimation

Type declaration

Returns void

pointerOutAnimationSearch playground for pointerOutAnimation

Type declaration

Returns void

pointerUpAnimationSearch playground for pointerUpAnimation

Type declaration

Returns void

Accessors

behaviors

Returns Behavior<Control3D>[]

content

Returns Control

Parameters

value: Control

Returns any

contentResolution

Returns number

Parameters

value: number

Returns any

isVisible

Returns boolean

Parameters

value: boolean

Returns any

mesh

Returns Nullable<AbstractMesh>

node

Returns Nullable<TransformNode>

position

Returns Vector3

Parameters

value: Vector3

Returns any

scaling

Returns Vector3

Parameters

value: Vector3

Returns any

typeName

Returns string

Methods

_prepareNodeSearch playground for _prepareNode

Parameters

scene: Scene

Returns void

addBehaviorSearch playground for addBehavior

Parameters

behavior: Behavior<Control3D>

Returns Control3D

disposeSearch playground for dispose

Returns void

getBehaviorByNameSearch playground for getBehaviorByName

Parameters