com.almasb.fxgl.extra.entity.components

Class KeepOnScreenComponent

java.lang.Object

com.almasb.fxgl.entity.component.Component

com.almasb.fxgl.extra.entity.components.KeepOnScreenComponent

public class KeepOnScreenComponent
extends Component

A component that keeps an entity within the viewport. Entities with physics enabled are not supported. Do NOT use this component if viewport is bound to an entity.

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Field Summary

Fields inherited from class com.almasb.fxgl.entity.component.Component

entity

Constructor Summary

Constructors

Constructor and Description
KeepOnScreenComponent(boolean horizontally, boolean vertically)

Method Summary

Modifier and Type	Method and Description
void	onAdded()
void	onUpdate(double tpf)

Methods inherited from class com.almasb.fxgl.entity.component.Component

getEntity, isPaused, onRemoved, pause, resume

Methods inherited from class java.lang.Object

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

Constructor Detail

KeepOnScreenComponent

public KeepOnScreenComponent(boolean horizontally,
                             boolean vertically)

Parameters:

horizontally - keep on screen in X axis

vertically - keep on screen in Y axis

Method Detail

onAdded

public void onAdded()

Overrides:

onAdded in class Component

onUpdate

public void onUpdate(double tpf)

Overrides:

onUpdate in class Component