org.achtern.AchternEngine.core.scenegraph.entity

Interface Entity

All Superinterfaces:

Updatable

All Known Implementing Classes:

AmbientLight, AudioEmitter, AudioListener, BaseLight, Camera, Chaser, DirectionalLight, Figure, FlyMover, FogGenerator, HumanMover, Light, MouseLook, OrthographicCamera, PointLight, QuickEntity, QuickRenderPass, SimpleMover, SpotLight, WireframeDisplay

public interface Entity
extends Updatable

An Entity is the base of all things which live and do stuff in the scenegraph. The need a parent (Node) to work properly.

Method Summary

Modifier and Type	Method and Description
void	attached() Called when an Entity gets attached to an scenegraph
Node	boxed() Returns a Node containing this Entity.
void	destroy() Marks this Entity to be no longer needed.
void	destroy(boolean shouldbeDestroyed) Set whether or not the resources assoc. with this Entity can be destroyed.
String	getName() Should return the name of the Entits
Transform	getTransform() Should return the current transform of the Entity
void	removed() Called when an Entity is about to get removed from the active scenegraph
void	render(RenderEngine renderEngine) Called on render, draw stuff here
void	setEngine(CoreEngine engine) Set the CoreEngine
void	setParent(Node parent) Set the parent node
boolean	shouldBeDestroyed() If true, the Entity is no longer needed.

Methods inherited from interface org.achtern.AchternEngine.core.scenegraph.Updatable

update

Method Detail

destroy

void destroy()

Marks this Entity to be no longer needed. This is just a hint for the various engines operating with this Entity. The RenderEngine for example could decide to delete the resources for a given Entity from the graphics card's memory, etc.

destroy

void destroy(boolean shouldbeDestroyed)

Set whether or not the resources assoc. with this Entity can be destroyed.

Parameters:

shouldbeDestroyed - whether or not to destroy this Entity

See Also:

destroy()

shouldBeDestroyed

boolean shouldBeDestroyed()

If true, the Entity is no longer needed.

Returns:

whether or not to destroy this Entity

See Also:

destroy()

render

void render(RenderEngine renderEngine)

Called on render, draw stuff here

Parameters:

renderEngine - The active renderEngine (caller)

getTransform

Transform getTransform()

Should return the current transform of the Entity

Returns:

Current transform

setParent

void setParent(Node parent)

Set the parent node

Parameters:

parent - The new parent

setEngine

void setEngine(CoreEngine engine)

Set the CoreEngine

Parameters:

engine - The new coreengine

removed

void removed()

Called when an Entity is about to get removed from the active scenegraph

attached

void attached()

Called when an Entity gets attached to an scenegraph

getName

String getName()

Should return the name of the Entits

Returns:

The name

boxed

Node boxed()

Returns a Node containing this Entity. The Name should equal the name of this Entity.

Returns:

Node with this Entity