GameEntity (fxgl 0.3.1 API)

java.lang.Object
- com.almasb.fxgl.ecs.Entity
- - com.almasb.fxgl.entity.GameEntity

```
public class GameEntity
extends Entity
```
Entity that guarantees to have Type, Position, Rotation, BoundingBox and View components. Provides methods to conveniently access commonly used features.

Author:

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

Property Summary
- Properties inherited from class com.almasb.fxgl.ecs.Entity
  activeProperty

Constructor Summary

Constructors
Constructor and Description

GameEntity()

Constructors
Constructor and Description
`GameEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`distance(GameEntity other)`
`double`	`getBottomY()`
`BoundingBoxComponent`	`getBoundingBoxComponent()`
`javafx.geometry.Point2D`	`getCenter()`
`double`	`getHeight()`
`javafx.geometry.Point2D`	`getPosition()`
`PositionComponent`	`getPositionComponent()`
`RenderLayer`	`getRenderLayer()`
`double`	`getRightX()`
`double`	`getRotation()`
`RotationComponent`	`getRotationComponent()`
`Object`	`getType()`
`TypeComponent`	`getTypeComponent()`
`EntityView`	`getView()`
`ViewComponent`	`getViewComponent()`
`double`	`getWidth()`
`double`	`getX()`
`double`	`getY()`
`boolean`	`isColliding(GameEntity other)`
`boolean`	`isType(Object type)` Example: entity.isType(Type.PLAYER);
`boolean`	`isWithin(javafx.geometry.Rectangle2D bounds)`
`void`	`rotateBy(double angle)` Rotate entity view by given angle clockwise.
`void`	`rotateToVector(javafx.geometry.Point2D vector)` Set absolute rotation of the entity view to angle between vector and positive X axis.
`void`	`setPosition(javafx.geometry.Point2D position)` Set top left position of this entity in world coordinates.
`void`	`setRenderLayer(RenderLayer layer)` Set render layer.
`void`	`setRotation(double angle)` Set absolute rotation angle.
`void`	`setScaleX(double scaleX)` Set view scale X.
`void`	`setScaleY(double scaleY)` Set view scale Y.
`void`	`setView(javafx.scene.Node view)` Set view without generating bounding boxes from view.
`void`	`setViewFromTexture(String textureName)` Set view from texture.
`void`	`setViewFromTextureWithBBox(String textureName)` Set view from texture and generate bbox from it.
`void`	`setViewWithBBox(javafx.scene.Node view)` Set view and generate bounding boxes from view.
`void`	`setX(double x)` Set position x of this entity.
`void`	`setY(double y)` Set position y of this entity.
`String`	`toString()`
`void`	`translate(double dx, double dy)` Translate x and y by given vector.
`void`	`translate(javafx.geometry.Point2D vector)` Translate x and y by given vector.
`void`	`translate(Vec2 vector)` Translate x and y by given vector.
`void`	`translateTowards(javafx.geometry.Point2D point, double speed)`
`void`	`translateX(double dx)` Translate X by given value.
`void`	`translateY(double dy)` Translate Y by given value.

Methods inherited from class com.almasb.fxgl.ecs.Entity
activeProperty, addComponent, addComponentListener, addControl, addControlListener, copy, getComponent, getComponents, getComponentUnsafe, getControl, getControls, getControlUnsafe, getProperty, getWorld, hasComponent, hasControl, isActive, load, removeAllComponents, removeAllControls, removeComponent, removeComponentListener, removeControl, removeControlListener, removeFromWorld, save, setControlsEnabled, setOnActive, setOnNotActive, setProperty

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

- Constructor Detail
  - GameEntity
```
public GameEntity()
```
- Method Detail
  - getTypeComponent
```
public final TypeComponent getTypeComponent()
```
    Returns:
    
    type component
  - getPositionComponent
```
public final PositionComponent getPositionComponent()
```
    Returns:
    
    position component
  - getRotationComponent
```
public final RotationComponent getRotationComponent()
```
    Returns:
    
    rotation component
  - getBoundingBoxComponent
```
public final BoundingBoxComponent getBoundingBoxComponent()
```
    Returns:
    
    bounding box component
  - getViewComponent
```
public final ViewComponent getViewComponent()
```
    Returns:
    
    view component
  - getType
```
public final Object getType()
```
    Returns:
    
    entity type
  - isType
```
public final boolean isType(Object type)
```
```
     Example:
     entity.isType(Type.PLAYER);
 
```
    Parameters:
    
    type - entity type
    
    Returns:
    
    true iff this type component is of given type
  - getPosition
```
public final javafx.geometry.Point2D getPosition()
```
    Returns:
    
    top left point of this entity in world coordinates
  - setPosition
```
public final void setPosition(javafx.geometry.Point2D position)
```
    Set top left position of this entity in world coordinates.
    
    Parameters:
    
    position - point
  - getX
```
public final double getX()
```
    Returns:
    
    top left x
  - getY
```
public final double getY()
```
    Returns:
    
    top left y
  - setX
```
public final void setX(double x)
```
    Set position x of this entity.
    
    Parameters:
    
    x - x coordinate
  - setY
```
public final void setY(double y)
```
    Set position y of this entity.
    
    Parameters:
    
    y - y coordinate
  - translate
```
public final void translate(javafx.geometry.Point2D vector)
```
    Translate x and y by given vector.
    
    Parameters:
    
    vector - translate vector
  - translate
```
public final void translate(Vec2 vector)
```
    Translate x and y by given vector.
    
    Parameters:
    
    vector - translate vector
  - translate
```
public final void translate(double dx,
                            double dy)
```
    Translate x and y by given vector.
    
    Parameters:
    
    dx - vector x
    
    dy - vector y
  - translateX
```
public final void translateX(double dx)
```
    Translate X by given value.
    
    Parameters:
    
    dx - dx
  - translateY
```
public final void translateY(double dy)
```
    Translate Y by given value.
    
    Parameters:
    
    dy - dy
  - translateTowards
```
public final void translateTowards(javafx.geometry.Point2D point,
                                   double speed)
```
    Parameters:
    
    point - the point to move towards
    
    speed - the speed at which to move
  - distance
```
public final double distance(GameEntity other)
```
    Parameters:
    
    other - the other component
    
    Returns:
    
    distance in pixels from this position to the other
  - getRotation
```
public final double getRotation()
```
    Returns:
    
    rotation angle
  - setRotation
```
public final void setRotation(double angle)
```
    Set absolute rotation angle.
    
    Parameters:
    
    angle - rotation angle
  - rotateBy
```
public final void rotateBy(double angle)
```
    Rotate entity view by given angle clockwise. To rotate counter clockwise use a negative angle value. Note: this doesn't affect hit boxes. For more accurate collisions use PhysicsComponent.
    
    Parameters:
    
    angle - rotation angle in degrees
  - rotateToVector
```
public final void rotateToVector(javafx.geometry.Point2D vector)
```
    Set absolute rotation of the entity view to angle between vector and positive X axis. This is useful for projectiles (bullets, arrows, etc) which rotate depending on their current velocity. Note, this assumes that at 0 angle rotation the scene view is facing right.
    
    Parameters:
    
    vector - the rotation vector / velocity vector
  - getWidth
```
public final double getWidth()
```
    Returns:
    
    width of this entity based on bounding box
  - getHeight
```
public final double getHeight()
```
    Returns:
    
    height of this entity based on bounding box
  - getRightX
```
public final double getRightX()
```
    Returns:
    
    the righmost x of this entity in world coordinates
  - getBottomY
```
public final double getBottomY()
```
    Returns:
    
    the bottom y of this entity in world coordinates
  - getCenter
```
public final javafx.geometry.Point2D getCenter()
```
    Returns:
    
    center point of this entity in world coordinates
  - isColliding
```
public final boolean isColliding(GameEntity other)
```
    Parameters:
    
    other - the other game entity
    
    Returns:
    
    true iff bbox of this entity is colliding with bbox of other
  - isWithin
```
public final boolean isWithin(javafx.geometry.Rectangle2D bounds)
```
    Parameters:
    
    bounds - a rectangular box that represents bounds
    
    Returns:
    
    true iff entity is partially or entirely within given bounds
  - getView
```
public final EntityView getView()
```
    Returns:
    
    entity view
  - setView
```
public final void setView(javafx.scene.Node view)
```
    Set view without generating bounding boxes from view.
    
    Parameters:
    
    view - the view
  - setViewFromTexture
```
public final void setViewFromTexture(String textureName)
```
    Set view from texture.
    
    Parameters:
    
    textureName - name of texture
  - setViewFromTextureWithBBox
```
public final void setViewFromTextureWithBBox(String textureName)
```
    Set view from texture and generate bbox from it.
    
    Parameters:
    
    textureName - name of texture
  - setViewWithBBox
```
public final void setViewWithBBox(javafx.scene.Node view)
```
    Set view and generate bounding boxes from view.
    
    Parameters:
    
    view - the view
  - getRenderLayer
```
public final RenderLayer getRenderLayer()
```
    Returns:
    
    render layer
  - setRenderLayer
```
public final void setRenderLayer(RenderLayer layer)
```
    Set render layer.
    
    Parameters:
    
    layer - render layer
  - setScaleX
```
public final void setScaleX(double scaleX)
```
    Set view scale X.
    
    Parameters:
    
    scaleX - x value
  - setScaleY
```
public final void setScaleY(double scaleY)
```
    Set view scale Y.
    
    Parameters:
    
    scaleY - y value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Entity

Class GameEntity

Property Summary

Properties inherited from class com.almasb.fxgl.ecs.Entity

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

GameEntity

Method Detail

getTypeComponent

getPositionComponent

getRotationComponent

getBoundingBoxComponent

getViewComponent

getType

isType

getPosition

setPosition

getX

getY

setX

setY

translate

translate

translate

translateX

translateY

translateTowards

distance

getRotation

setRotation

rotateBy

rotateToVector

getWidth

getHeight

getRightX

getBottomY

getCenter

isColliding

isWithin

getView

setView

setViewFromTexture

setViewFromTextureWithBBox

setViewWithBBox

getRenderLayer

setRenderLayer

setScaleX

setScaleY

toString