com.almasb.fxgl.entity.control

Class KeepOnScreenControl

java.lang.Object

com.almasb.fxgl.ecs.AbstractControl

com.almasb.fxgl.entity.control.KeepOnScreenControl

All Implemented Interfaces:

Control

public class KeepOnScreenControl
extends AbstractControl

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

Author:

Almas Baimagambetov (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
KeepOnScreenControl(boolean horizontally, boolean vertically)

Method Summary

Modifier and Type	Method and Description
void	onAdded(Entity entity) Called when this control is added to entity.
void	onUpdate(Entity entity, double tpf) Called on entity world update tick.

Methods inherited from class com.almasb.fxgl.ecs.AbstractControl

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

KeepOnScreenControl

public KeepOnScreenControl(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(Entity entity)

Description copied from interface: Control

Called when this control is added to entity. This is called before any control related listeners are notified. This allows the control to initiliaze properly.

Specified by:

onAdded in interface Control

Overrides:

onAdded in class AbstractControl

Parameters:

entity - the entity to which this control was added

onUpdate

public void onUpdate(Entity entity,
                     double tpf)

Description copied from interface: Control

Called on entity world update tick.

Parameters:

entity - the entity to which this control is attached

tpf - time per frame