import PanelStack from '@mobilizing/library/js/Mobilizing/renderer/3D/three/ui/PanelStack.js'

public class |source

PanelStack

Extends:

Component → PanelStack

Constructor Summary

Public Constructor
public	constructor(params: Object) A PanelStack is an organized Panel assemblage to be used as a selection menu.

Member Summary

Public Members
public	activePanels: *[]
public	animationDuration: *
public	animationEasing: *
public	camera: *
public	lineDepthOffset: *
public	lineHorizontalOffset: *
public	mode: *
public	panels: *
public	pointer: *
public	positions: *[]
public	root: *
public	transform: *
public	useMouse: boolean
public	useTouch: boolean
public	wheelDepthFactor: *
public	wheelRadius: *
public	wheelStep: *
public	wheelTheta: number
public	wheelVerticalFactor: *

Method Summary

Public Methods
public	stepTo(steps: Number) Make the PanelStack move to the given step (ie : the Panel index).

Private Methods
private	organizeLine()
private	organizeWheel()
private	stepToLine(steps: Number)
private	stepToWheel(steps: Number)

Inherited Summary

From class Component
public	active: boolean
public	context: *
public	events: *
public	id: *
public	name: *
private	_nexts: *[]
private	_setupDone: boolean
public	byPass()
public	chain(component: Component) Adds a component to this chained component array
public	getChainedComponents(): Array Returns the array of attached children components
public	off() Deactivate the component
public	on() Activate the component A call to this method calls the setup method if it has not been run yet
public	postUpdate() Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism
public	preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component.
public	preUpdate() Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism
public	prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server.
public	setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly
public	update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

A PanelStack is an organized Panel assemblage to be used as a selection menu. It's a 3D UI element.

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
params	Object		parameters object.
params.mode	String	default: "wheel"	the mode to use for panel's organisation in space.
params.panels	Array		The Panel objects array to use for building this PanelStack.
params.pointer	Pointer		The Pointer instance to be used for interaction with this PanelStack.
params.camera	Camera		The camera used in the scene to compute the raycasting based interaction with panels.
params.wheelRadius	Number		The radius of the wheel menu.
params.wheelVerticalFactor	Number	default: 1	The factor to use for flattening or expanding the global vertical shape of the wheel (will produce a vertical ellipse, instead of a circle).
params.wheelDepthFactor	Number	default: 1	(wheel mode only) The factor to use for flattening or expanding the depth of of each panel in the wheel (will produce an horizontal in depth ellipse, instead of a circle)
params.lineHorizontalOffset	Number	default: 10	the x axis offset of the Panels organized in line.
params.lineDepthOffset	Number	default: 10	the z axis offset of the Panels organized in line.
params.animationEasing	Animation.Easing	default: Animation.Easing.easeOutQuint	the easing effect to use for the animation of Panel.
params.animationDuration	Number	default: 2000	the animation duration in ms

Public Members

public activePanels: *[] source

public animationDuration: * source

public animationEasing: * source

public camera: * source

public lineDepthOffset: * source

public lineHorizontalOffset: * source

public mode: * source

public panels: * source

public pointer: * source

public positions: *[] source

public root: * source

public transform: * source

public useMouse: boolean source

public useTouch: boolean source

public wheelDepthFactor: * source

public wheelRadius: * source

public wheelStep: * source

public wheelTheta: number source

public wheelVerticalFactor: * source

Public Methods

public stepTo(steps: Number) source

Make the PanelStack move to the given step (ie : the Panel index). Using Animation Object internally to automate the movements.

Params:

Name	Type	Attribute	Description
steps	Number		Use positive number to move forward, negative to move backward.

Private Methods

private organizeLine() source

private organizeWheel() source

private stepToLine(steps: Number) source

Params:

Name	Type	Attribute	Description
steps	Number

private stepToWheel(steps: Number) source

Params:

Name	Type	Attribute	Description
steps	Number