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

public class |source

Panel

Extends:

Component → Panel

Constructor Summary

Public Constructor
public	constructor(params: Object) Panel UI element is a kind of aggregation between a button, a textured plane and a text label.

Member Summary

Public Members
public	camera: *
public	clickable: *
public	cutOff: *
public	fillColor: *
public	font: *
public	fontBold: *
public	fontBoldItalic: *
public	fontItalic: *
public	height: *
public	imgMesh: *
public	material: *
public	materials: *[]
public	mesh: *
public	pointer: *
public	root: *
public	strokeColor: *
public	strokeMesh: *
public	strokeWidth: *
public	texture: *
public	texturedMesh: *
public	title: *
public	titleHeight: *
public	titleText: *
public	titleTexture: *
public	titleWidth: *
public	transform: *
public	vertices: undefined[]
public	width: *

Method Summary

Public Methods
public	off()
public	on()
public	setStrokeColor(color: *)
public	setup()

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

Panel UI element is a kind of aggregation between a button, a textured plane and a text label. It has a similar interactive behavior as a button.

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.title	String	optional	the title of this panel, a text that will be displayed as a title.
params.camera	Camera	optional	the camera to be used for picking.
params.material	String	optional default: "basic"	this panel material type (String) to use for its creation.
params.pointer	Pointer	optional	the pointer Object to be used for picking.
params.width	Number	optional default: 50	the panel's width.
params.height	Number	optional default: 50	the panel's height.
params.cutOff	Number	optional default: "auto"	the bevel angle for corners.
params.strokeWidth	Number	optional default: "auto"	the colored stroke around the panel.
params.titleHeight	Number	optional default: "auto"	the title text's height (in pixel)
params.fillColor	Color	optional default: Color.black	the text's color
params.strokeColor	Color	optional default: Color.mobilizing	the stroke's color
params.font	Font	optional	the panels regular font
params.fontItalic	Font	optional	the panels italic font
params.fontBold	Font	optional	the panels bold font
params.fontBoldItalic	Font	optional	the panels bold-italic font
params.texture	Texture	optional	the texture to map on the panel

Public Members

public camera: * source

public clickable: * source

public cutOff: * source

public fillColor: * source

public font: * source

public fontBold: * source

public fontBoldItalic: * source

public fontItalic: * source

public height: * source

public imgMesh: * source

public material: * source

public materials: *[] source

public mesh: * source

public pointer: * source

public root: * source

public strokeColor: * source

public strokeMesh: * source

public strokeWidth: * source

public texture: * source

public texturedMesh: * source

public title: * source

public titleHeight: * source

public titleText: * source

public titleTexture: * source

public titleWidth: * source

public transform: * source

public vertices: undefined[] source

public width: * source

Public Methods

public off() source

Deactivate the component

Override:

Component#off

public on() source

Activate the component A call to this method calls the setup method if it has not been run yet

Override:

Component#on

public setStrokeColor(color: *) source

Params:

Name	Type	Attribute	Description
color	*

public setup() source

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

Override:

Component#setup