com.almasb.fxgl.entity

Class Entities

java.lang.Object

com.almasb.fxgl.entity.Entities

public final class Entities
extends Object

Helper class with static convenience methods.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entities.GameEntityBuilder Provides fluent API for building entities.

Method Summary

Modifier and Type	Method and Description
static AnimationBuilder	animationBuilder()
static Entities.GameEntityBuilder	builder()
static BoundingBoxComponent	getBBox(Entity e) Convenient way to obtain bbox component.
static PhysicsComponent	getPhysics(Entity e) Convenient way to obtain physics component.
static PositionComponent	getPosition(Entity e) Convenient way to obtain position component.
static RotationComponent	getRotation(Entity e) Convenient way to obtain rotation component.
static TypeComponent	getType(Entity e) Convenient way to obtain type component.
static ViewComponent	getView(Entity e) Convenient way to obtain main view component.
static Entity	makeScreenBounds(double thickness) Create an entity with bounding box around the screen with given thickness.

Methods inherited from class java.lang.Object

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

Method Detail

getPosition

public static PositionComponent getPosition(Entity e)

Convenient way to obtain position component.

Parameters:

e - entity

Returns:

position component

getRotation

public static RotationComponent getRotation(Entity e)

Convenient way to obtain rotation component.

Parameters:

e - entity

Returns:

rotation component

getBBox

public static BoundingBoxComponent getBBox(Entity e)

Convenient way to obtain bbox component.

Parameters:

e - entity

Returns:

bbox component

getPhysics

public static PhysicsComponent getPhysics(Entity e)

Convenient way to obtain physics component.

Parameters:

e - entity

Returns:

physics component

getView

public static ViewComponent getView(Entity e)

Convenient way to obtain main view component.

Parameters:

e - entity

Returns:

main view component

getType

public static TypeComponent getType(Entity e)

Convenient way to obtain type component.

Parameters:

e - entity

Returns:

type component

makeScreenBounds

public static Entity makeScreenBounds(double thickness)

Create an entity with bounding box around the screen with given thickness.

Parameters:

thickness - thickness of hit boxes around the screen

Returns:

entity with screen bounds

builder

public static Entities.GameEntityBuilder builder()

Returns:

new entity builder

animationBuilder

public static AnimationBuilder animationBuilder()

Returns:

new animation builder