Class StackPanel3D

Class used to create a stack panel in 3D on XY plane

Hierarchy

Container3D
- StackPanel3D

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new StackPanel3D(isVertical?: boolean): StackPanel3D

Overrides Container3D.constructor
- Defined in .temp/docdirectory/doc.d.ts:103436
Creates new StackPanel

Parameters
- Optional isVertical: boolean
Returns StackPanel3D

Properties

marginSearch playground for margin

margin: number

Gets or sets the distance between elements

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

Static Readonly FACEFORWARDREVERSED_ORIENTATIONSearch playground for FACEFORWARDREVERSED_ORIENTATION

FACEFORWARDREVERSED_ORIENTATION: 4 = 4

Control will rotate to look at negative z axis (0, 0, -1)

Static Readonly FACEFORWARD_ORIENTATIONSearch playground for FACEFORWARD_ORIENTATION

FACEFORWARD_ORIENTATION: 3 = 3

Control will rotate to look at z axis (0, 0, 1)

Static Readonly FACEORIGINREVERSED_ORIENTATIONSearch playground for FACEORIGINREVERSED_ORIENTATION

FACEORIGINREVERSED_ORIENTATION: 2 = 2

Control will rotate to make it look back at sphere central axis

Static Readonly FACEORIGIN_ORIENTATIONSearch playground for FACEORIGIN_ORIENTATION

FACEORIGIN_ORIENTATION: 1 = 1

Control will rotate to make it look at sphere central axis

Static Readonly UNSET_ORIENTATIONSearch playground for UNSET_ORIENTATION

UNSET_ORIENTATION: 0 = 0

Control rotation will remain unchanged

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>[]

blockLayout

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

Inherited from Container3D.blockLayout
- Defined in .temp/docdirectory/doc.d.ts:102688
Gets or sets a boolean indicating if the layout must be blocked (default is false). This is helpful to optimize layout operation when adding multiple children in a row

Returns boolean
Inherited from Container3D.blockLayout
- Defined in .temp/docdirectory/doc.d.ts:102689
Gets or sets a boolean indicating if the layout must be blocked (default is false). This is helpful to optimize layout operation when adding multiple children in a row

Parameters
- value: boolean
Returns any

children

get children(): Array<Control3D>

Inherited from Container3D.children
- Defined in .temp/docdirectory/doc.d.ts:102683
Gets the list of child controls

Returns Array<Control3D>

isVertical

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

- Defined in .temp/docdirectory/doc.d.ts:103431
Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)

Returns boolean
- Defined in .temp/docdirectory/doc.d.ts:103432
Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)

Parameters
- value: boolean
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

addControlSearch playground for addControl

addControl(control: Control3D): Container3D

Inherited from Container3D.addControl
- Defined in .temp/docdirectory/doc.d.ts:102711
Adds a control to the children of this control

Parameters
- control: Control3D
  
  defines the control to add
Returns Container3D

the current container

containsControlSearch playground for containsControl

containsControl(control: Control3D): boolean

Inherited from Container3D.containsControl
- Defined in .temp/docdirectory/doc.d.ts:102705
Gets a boolean indicating if the given control is in the children of this control

Parameters
- control: Control3D
  
  defines the control to check
Returns boolean

true if the control is in the child list

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Inherited from Container3D.dispose

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

removeControlSearch playground for removeControl

removeControl(control: Control3D): Container3D

Inherited from Container3D.removeControl
- Defined in .temp/docdirectory/doc.d.ts:102722
Removes a control from the children of this control

Parameters
- control: Control3D
  
  defines the control to remove
Returns Container3D

the current container

updateLayoutSearch playground for updateLayout

updateLayout(): Container3D

Inherited from Container3D.updateLayout
- Defined in .temp/docdirectory/doc.d.ts:102699
Force the container to update the layout. Please note that it will not take blockLayout property in account

Returns Container3D

the current container

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional isVertical: boolean

Returns StackPanel3D

Properties

marginSearch playground for margin

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

Static Readonly FACEFORWARDREVERSED_ORIENTATIONSearch playground for FACEFORWARDREVERSED_ORIENTATION

Static Readonly FACEFORWARD_ORIENTATIONSearch playground for FACEFORWARD_ORIENTATION

Static Readonly FACEORIGINREVERSED_ORIENTATIONSearch playground for FACEORIGINREVERSED_ORIENTATION

Static Readonly FACEORIGIN_ORIENTATIONSearch playground for FACEORIGIN_ORIENTATION

Static Readonly UNSET_ORIENTATIONSearch playground for UNSET_ORIENTATION

Accessors

behaviors

Returns Behavior<Control3D>[]

blockLayout

Returns boolean

Parameters

value: boolean

Returns any

children

Returns Array<Control3D>

isVertical

Returns boolean

Parameters

value: boolean

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