Repository

Panel

Extends:

Component → Panel

Constructor Summary

Public Constructor
public

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
public

cutOff: *

public
public

font: *

public
public
public
public

height: *

public
public
public

materials: *[]

public

mesh: *

public
public

root: *

public
public
public
public
public
public

title: *

public
public
public
public
public
public
public

width: *

Method Summary

Public Methods
public

off()

public

on()

public

setStrokeColor(color: *)

public

Inherited Summary

From class Component
public
public
public

events: *

public

id: *

public

name: *

private

_nexts: *[]

private
public
public

chain(component: Component)

Adds a component to this chained component array

public

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

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 the component This empty method is usually overriden to perform setup actions for the component.

public

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

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 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:

NameTypeAttributeDescription
paramsObject

Parameters object, given by the constructor.

params.titleString
  • optional

the title of this panel, a text that will be displayed as a title.

params.cameraCamera
  • optional

the camera to be used for picking.

params.materialString
  • optional
  • default: "basic"

this panel material type (String) to use for its creation.

params.pointerPointer
  • optional

the pointer Object to be used for picking.

params.widthNumber
  • optional
  • default: 50

the panel's width.

params.heightNumber
  • optional
  • default: 50

the panel's height.

params.cutOffNumber
  • optional
  • default: "auto"

the bevel angle for corners.

params.strokeWidthNumber
  • optional
  • default: "auto"

the colored stroke around the panel.

params.titleHeightNumber
  • optional
  • default: "auto"

the title text's height (in pixel)

params.fillColorColor
  • optional
  • default: Color.black

the text's color

params.strokeColorColor
  • optional
  • default: Color.mobilizing

the stroke's color

params.fontFont
  • optional

the panels regular font

params.fontItalicFont
  • optional

the panels italic font

params.fontBoldFont
  • optional

the panels bold font

params.fontBoldItalicFont
  • optional

the panels bold-italic font

params.textureTexture
  • 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:

NameTypeAttributeDescription
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