com.bonzaiengine.gamekit.component

Class UiComponent

java.lang.Object

com.bonzaiengine.gamekit.component.UiComponent

All Implemented Interfaces:

IComponent

public final class UiComponent
extends java.lang.Object
implements IComponent

Component for rendering a UI layer on top of the SceneGraph

See Also:

uiStream, CameraComponent.uiLayer

Field Summary

Fields

Modifier and Type	Field and Description
Stream	uiStream Stream of the ui Widget (ui.xml/json)
Stream	uiThemeStream Stream of the ui theme (theme.xml/json)

Constructor Summary

Constructors

Constructor and Description
UiComponent()

Method Summary

Modifier and Type	Method and Description
GameObject	getGameObject()
<T extends Widget> T	getWidget()
void	init(GameObject gameObject) internal - don't call
void	onActivate() internal - don't call
void	onDeactivate() internal - don't call
void	onDestroy() internal - don't call
void	render(IGLApi glApi, SceneView sceneView) internal - don't call
void	start() internal - don't call
void	update(ISceneTarget sceneTarget, SceneView sceneView, long timePassedMs) internal - don't call

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uiStream

public Stream uiStream

Stream of the ui Widget (ui.xml/json)

See Also:

UiIO

uiThemeStream

public Stream uiThemeStream

Stream of the ui theme (theme.xml/json)

See Also:

UiIO

Constructor Detail

UiComponent

public UiComponent()

Method Detail

getGameObject

public final GameObject getGameObject()

Specified by:

getGameObject in interface IComponent

Returns:

the GameObject this component is attached to

getWidget

public final <T extends Widget> T getWidget()

Returns:

the UI widget, available after the component is initialized

init

public final void init(GameObject gameObject)

internal - don't call

Specified by:

init in interface IComponent

start

public final void start()

internal - don't call

Specified by:

start in interface IComponent

onActivate

public void onActivate()

internal - don't call

Specified by:

onActivate in interface IComponent

onDeactivate

public void onDeactivate()

internal - don't call

Specified by:

onDeactivate in interface IComponent

onDestroy

public void onDestroy()

internal - don't call

Specified by:

onDestroy in interface IComponent

update

public final void update(ISceneTarget sceneTarget,
                         SceneView sceneView,
                         long timePassedMs)

internal - don't call

render

public final void render(IGLApi glApi,
                         SceneView sceneView)

internal - don't call