QuickEntity (AchternEngine 0.4 API)

java.lang.Object
- org.achtern.AchternEngine.core.scenegraph.entity.QuickEntity

All Implemented Interfaces:

EngineHolder<CoreEngine>, Entity, Updatable

Direct Known Subclasses:

AudioEmitter, AudioListener, Camera, Chaser, Figure, FogGenerator, MouseLook, QuickRenderPass, SimpleMover
```
public abstract class QuickEntity
extends Object
implements Entity, EngineHolder<CoreEngine>
```
A helper class to create an Entity easily. Implements all methods in order to override only "needed" methods and handels the following: - Storing the parent node - Storing the coreengine - Storing a name (and setting it)

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`destroy`
`protected CoreEngine`	`engine`
`protected String`	`name`
`static String`	`NAME_UNTITLED_ENTITY`
`protected Node`	`parent`

Constructor Summary

Constructors
Constructor and Description

QuickEntity()
Create an "Untitled Entity"

QuickEntity(String name)
Create a entity with a specifc name

Constructors
Constructor and Description
`QuickEntity()` Create an "Untitled Entity"
`QuickEntity(String name)` Create a entity with a specifc name

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected boolean`	`canEqual(Object other)`
`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.
`boolean`	`equals(Object o)`
`CoreEngine`	`getEngine()` Retrieves the stored engine
`String`	`getName()` Should return the name of the Entits
`Node`	`getParent()`
`Transform`	`getTransform()` Should return the current transform of the Entity
`int`	`hashCode()`
`boolean`	`isDestroy()`
`void`	`removed()` Sets the parent to null.
`void`	`render(RenderEngine renderEngine)` Called on render, draw stuff here
`void`	`setDestroy(boolean destroy)`
`void`	`setEngine(CoreEngine engine)` Set the CoreEngine
`void`	`setName(String name)`
`void`	`setParent(Node parent)` Set the parent node
`boolean`	`shouldBeDestroyed()` If true, the Entity is no longer needed.
`String`	`toString()`
`void`	`update(float delta)` Trigger an update.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME_UNTITLED_ENTITY
```
public static final String NAME_UNTITLED_ENTITY
```
    See Also:
    
    Constant Field Values
  - parent
```
protected Node parent
```
  - engine
```
protected CoreEngine engine
```
  - name
```
protected String name
```
  - destroy
```
protected boolean destroy
```
- Constructor Detail
  - QuickEntity
```
public QuickEntity()
```
    Create an "Untitled Entity"
  - QuickEntity
```
public QuickEntity(String name)
```
    Create a entity with a specifc name
    
    Parameters:
    
    name - The name
- Method Detail
  - update
```
public void update(float delta)
```
    Description copied from interface: Updatable
    
    Trigger an update. Do you regular updating of nodes/entities in here.
    
    Specified by:
    
    update in interface Updatable
    
    Parameters:
    
    delta - The delta time
    
    See Also:
    
    Updatable.update(float)
  - render
```
public void render(RenderEngine renderEngine)
```
    Description copied from interface: Entity
    
    Called on render, draw stuff here
    
    Specified by:
    
    render in interface Entity
    
    Parameters:
    
    renderEngine - The active renderEngine (caller)
    
    See Also:
    
    Entity.render(org.achtern.AchternEngine.core.rendering.RenderEngine)
  - removed
```
public void removed()
```
    Sets the parent to null.
    
    Specified by:
    
    removed in interface Entity
    
    See Also:
    
    Entity.removed()
  - attached
```
public void attached()
```
    Description copied from interface: Entity
    
    Called when an Entity gets attached to an scenegraph
    
    Specified by:
    
    attached in interface Entity
    
    See Also:
    
    ()
  - destroy
```
public 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.
    
    Specified by:
    
    destroy in interface Entity
  - destroy
```
public void destroy(boolean shouldbeDestroyed)
```
    Set whether or not the resources assoc. with this Entity can be destroyed.
    
    Specified by:
    
    destroy in interface Entity
    
    Parameters:
    
    shouldbeDestroyed - whether or not to destroy this Entity
    
    See Also:
    
    destroy()
  - shouldBeDestroyed
```
public boolean shouldBeDestroyed()
```
    If true, the Entity is no longer needed.
    
    Specified by:
    
    shouldBeDestroyed in interface Entity
    
    Returns:
    
    whether or not to destroy this Entity
    
    See Also:
    
    destroy()
  - boxed
```
public Node boxed()
```
    Returns a Node containing this Entity. The Name should equal the name of this Entity.
    
    Specified by:
    
    boxed in interface Entity
    
    Returns:
    
    Node with this Entity
  - getTransform
```
public Transform getTransform()
```
    Description copied from interface: Entity
    
    Should return the current transform of the Entity
    
    Specified by:
    
    getTransform in interface Entity
    
    Returns:
    
    Current transform
    
    See Also:
    
    Entity.getTransform()
  - getParent
```
@Generated(value="lombok")
public Node getParent()
```
  - getEngine
```
@Generated(value="lombok")
public CoreEngine getEngine()
```
    Description copied from interface: EngineHolder
    
    Retrieves the stored engine
    
    Specified by:
    
    getEngine in interface EngineHolder<CoreEngine>
    
    Returns:
    
    The stored engine
  - getName
```
@Generated(value="lombok")
public String getName()
```
    Description copied from interface: Entity
    
    Should return the name of the Entits
    
    Specified by:
    
    getName in interface Entity
    
    Returns:
    
    The name
  - isDestroy
```
@Generated(value="lombok")
public boolean isDestroy()
```
  - setParent
```
@Generated(value="lombok")
public void setParent(Node parent)
```
    Description copied from interface: Entity
    
    Set the parent node
    
    Specified by:
    
    setParent in interface Entity
    
    Parameters:
    
    parent - The new parent
  - setEngine
```
@Generated(value="lombok")
public void setEngine(CoreEngine engine)
```
    Description copied from interface: Entity
    
    Set the CoreEngine
    
    Specified by:
    
    setEngine in interface EngineHolder<CoreEngine>
    
    Specified by:
    
    setEngine in interface Entity
    
    Parameters:
    
    engine - The new coreengine
  - setName
```
@Generated(value="lombok")
public void setName(String name)
```
  - setDestroy
```
@Generated(value="lombok")
public void setDestroy(boolean destroy)
```
  - equals
```
@Generated(value="lombok")
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
@Generated(value="lombok")
protected boolean canEqual(Object other)
```
  - hashCode
```
@Generated(value="lombok")
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
@Generated(value="lombok")
public String toString()
```
    Overrides:
    
    toString in class Object

Class QuickEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_UNTITLED_ENTITY

parent

engine

name

destroy

Constructor Detail

QuickEntity

QuickEntity

Method Detail

update

render

removed

attached

destroy

destroy

shouldBeDestroyed

boxed

getTransform

getParent

getEngine

getName

isDestroy

setParent

setEngine

setName

setDestroy

equals

canEqual

hashCode

toString