org.achtern.AchternEngine.core.scenegraph

Class ShortLifeNode

java.lang.Object

org.achtern.AchternEngine.core.scenegraph.Node

org.achtern.AchternEngine.core.scenegraph.ShortLifeNode

All Implemented Interfaces:

EngineHolder<CoreEngine>, Renderable, Updatable

public class ShortLifeNode
extends Node

A ShortLifeNode is just a standard Node with a limited lifetime. After this lifetime has passed, it gets removed from the scenegraph. You can also provide your own on death Callback for each Node. This callback gets called before the removal of the Node!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShortLifeNode.Mode This hints the ShortLifeNode how to behave, once the lifespan ends.

Field Summary

Fields

Modifier and Type	Field and Description
protected Callback<ShortLifeNode>	deathCallback This callback gets called, when the life has end of this Node.
protected float	lifeTime The amount of time the Node has "lived" in the scenegraph in seconds
protected float	maxLifeTime The max lifetime this Node has, This value should be in seconds!
protected ShortLifeNode.Mode	mode The Mode hint

Fields inherited from class org.achtern.AchternEngine.core.scenegraph.Node

children, engine, entities, name, parent, singleEntityRetriever, transform

Constructor Summary

Constructors

Constructor and Description
ShortLifeNode(float maxLifeTime) Construct a ShortLifeNode with just a maximum life time.
ShortLifeNode(float maxLifeTime, ShortLifeNode.Mode mode, Callback<ShortLifeNode> callback) Construct a ShortLifeNode.
ShortLifeNode(String name, float maxLifeTime) Construct a ShortLifeNode with a name and max. life time.
ShortLifeNode(String name, float maxLifeTime, ShortLifeNode.Mode mode, Callback<ShortLifeNode> callback) Construct a ShortLifeNode.

Method Summary

Modifier and Type	Method and Description
Callback<ShortLifeNode>	getDeathCallback() This callback gets called, when the life has end of this Node.
void	setDeathCallback(Callback<ShortLifeNode> deathCallback) This callback gets called, when the life has end of this Node.
void	update(float delta) Trigger an update.

Methods inherited from class org.achtern.AchternEngine.core.scenegraph.Node

add, add, add, addToWorld, getChildren, getEngine, getEntities, getEntity, getName, getParent, getTransform, numberOfEntities, remove, remove, remove, remove, removed, render, setChildren, setEngine, setEntities, setName, setParent, setTransform, toString

Methods inherited from class java.lang.Object

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

Field Detail

maxLifeTime

protected final float maxLifeTime

The max lifetime this Node has, This value should be in seconds! After lifeTime is greater than maxLifeTime it gets removed.

lifeTime

protected float lifeTime

The amount of time the Node has "lived" in the scenegraph in seconds

mode

protected ShortLifeNode.Mode mode

The Mode hint

deathCallback

protected Callback<ShortLifeNode> deathCallback

This callback gets called, when the life has end of this Node. It gets called before Node.removed().

Constructor Detail

ShortLifeNode

public ShortLifeNode(String name,
                     float maxLifeTime,
                     ShortLifeNode.Mode mode,
                     Callback<ShortLifeNode> callback)

Construct a ShortLifeNode. This constructor provides access to almost all (semi) public fields

Parameters:

name - The Name of the Node

maxLifeTime - The maximum lifetime in seconds

mode - The ShortLifeNode.Mode hint

callback - Death callback deathCallback

ShortLifeNode

public ShortLifeNode(float maxLifeTime,
                     ShortLifeNode.Mode mode,
                     Callback<ShortLifeNode> callback)

Construct a ShortLifeNode. This constructor provides acces to almost all (semi) public fields, but leaves the Node untitled.

Parameters:

maxLifeTime - The maximum lifetime in seconds

mode - The ShortLifeNode.Mode hint

callback - Death callback deathCallback

ShortLifeNode

public ShortLifeNode(String name,
                     float maxLifeTime)

Construct a ShortLifeNode with a name and max. life time. The death callback defaults to null; the Mode to ShortLifeNode.Mode.DETACH

Parameters:

name - The Name of the Node

maxLifeTime - The maximum lifetime in seconds

ShortLifeNode

public ShortLifeNode(float maxLifeTime)

Construct a ShortLifeNode with just a maximum life time. The death callback defaults to null; the Mode to ShortLifeNode.Mode.DETACH

Parameters:

maxLifeTime - The maximum lifetime in seconds

Method Detail

update

public void update(float delta)

Trigger an update. Do you regular updating of nodes/entities in here.

Specified by:

update in interface Updatable

Overrides:

update in class Node

Parameters:

delta - The delta time

getDeathCallback

@Generated(value="lombok")
public Callback<ShortLifeNode> getDeathCallback()

This callback gets called, when the life has end of this Node. It gets called before Node.removed().

Returns:

the active deathCallback

setDeathCallback

@Generated(value="lombok")
public void setDeathCallback(Callback<ShortLifeNode> deathCallback)

This callback gets called, when the life has end of this Node. It gets called before Node.removed().

Parameters:

deathCallback - new deathCallback