HitBox (fxgl 0.4.1 API)

java.lang.Object
- com.almasb.fxgl.physics.HitBox

All Implemented Interfaces:

Serializable
```
public final class HitBox
extends Object
implements Serializable
```
A bounding collision box.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`HitBox(BoundingShape shape)` Creates a hit box with the given shape.
`HitBox(javafx.geometry.Point2D localOrigin, BoundingShape shape)` Creates a hit box with the given local origin and shape.
`HitBox(String name, BoundingShape shape)` Creates a hit box with given name and shape.
`HitBox(String name, javafx.geometry.Point2D localOrigin, BoundingShape shape)` Creates a hit box with given name, local origin (top-left) and shape.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindX(javafx.beans.property.DoubleProperty xProperty)` Bind to x property of entity.
`void`	`bindY(javafx.beans.property.DoubleProperty yProperty)` Bind to y property of entity.
`javafx.geometry.Point2D`	`centerLocal()`
`javafx.geometry.Point2D`	`centerWorld(double x, double y)`
`HitBox`	`copy()`
`javafx.geometry.Bounds`	`getBounds()`
`double`	`getHeight()`
`double`	`getMaxX()`
`double`	`getMaxXWorld()`
`double`	`getMaxY()`
`double`	`getMaxYWorld()`
`double`	`getMinX()`
`double`	`getMinXWorld()`
`double`	`getMinY()`
`double`	`getMinYWorld()`
`String`	`getName()`
`BoundingShape`	`getShape()`
`double`	`getWidth()`
`javafx.geometry.Bounds`	`translate(double x, double y)` Computes new bounds based on translated X and Y of an entity.
`javafx.geometry.Bounds`	`translateXFlipped(double x, double y, double entityWidth)` Computes new bounds based on translated X and Y of an entity with X axis being flipped.
`void`	`unbind()` Unbind the hit box.

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

- Constructor Detail
  - HitBox
```
public HitBox(BoundingShape shape)
```
    Creates a hit box with the given shape. The name of the {@link HitBox} will be auto generated based upon the hashCode of the given {@link BoundingShape}.
    
    Parameters:
    
    shape - bounding shape
  - HitBox
```
public HitBox(javafx.geometry.Point2D localOrigin,
              BoundingShape shape)
```
    Creates a hit box with the given local origin and shape. The name of the {@link HitBox} will be auto generated based upon the hashCode of the given {@link BoundingShape}.
    
    Parameters:
    
    localOrigin - origin of hit box
    
    shape - bounding shape
  - HitBox
```
public HitBox(String name,
              BoundingShape shape)
```
    Creates a hit box with given name and shape. Local origin is set to default (0, 0).
    
    Parameters:
    
    name - name of the hit box
    
    shape - bounding shape
  - HitBox
```
public HitBox(String name,
              javafx.geometry.Point2D localOrigin,
              BoundingShape shape)
```
    Creates a hit box with given name, local origin (top-left) and shape.
    
    Parameters:
    
    name - name of the hit box
    
    localOrigin - origin of hit box
    
    shape - bounding shape
- Method Detail
  - translate
```
public javafx.geometry.Bounds translate(double x,
                                        double y)
```
    Computes new bounds based on translated X and Y of an entity.
    
    Parameters:
    
    x - entity x
    
    y - entity y
    
    Returns:
    
    computed bounds
  - translateXFlipped
```
public javafx.geometry.Bounds translateXFlipped(double x,
                                                double y,
                                                double entityWidth)
```
    Computes new bounds based on translated X and Y of an entity with X axis being flipped.
    
    Parameters:
    
    x - entity x
    
    y - entity y
    
    entityWidth - entity width
    
    Returns:
    
    computed bounds
  - getBounds
```
public javafx.geometry.Bounds getBounds()
```
    Returns:
    
    bounds
  - getShape
```
public BoundingShape getShape()
```
    Returns:
    
    hit box shape
  - getMinX
```
public double getMinX()
```
    Returns:
    
    min x
  - getMinY
```
public double getMinY()
```
    Returns:
    
    min y
  - getMaxX
```
public double getMaxX()
```
    Returns:
    
    maxX of internal bounds (x + width)
  - getMaxY
```
public double getMaxY()
```
    Returns:
    
    maxY of internal bounds (y + height)
  - getWidth
```
public double getWidth()
```
    Returns:
    
    width of this hit box
  - getHeight
```
public double getHeight()
```
    Returns:
    
    height of this hit box
  - getName
```
public String getName()
```
    Returns:
    
    hit box name
  - bindX
```
public void bindX(javafx.beans.property.DoubleProperty xProperty)
```
    Bind to x property of entity.
    
    Parameters:
    
    xProperty - x property
  - bindY
```
public void bindY(javafx.beans.property.DoubleProperty yProperty)
```
    Bind to y property of entity.
    
    Parameters:
    
    yProperty - y property
  - unbind
```
public void unbind()
```
    Unbind the hit box.
  - getMinXWorld
```
public double getMinXWorld()
```
  - getMaxXWorld
```
public double getMaxXWorld()
```
  - getMinYWorld
```
public double getMinYWorld()
```
  - getMaxYWorld
```
public double getMaxYWorld()
```
  - centerLocal
```
public javafx.geometry.Point2D centerLocal()
```
    Returns:
    
    center point of this hit box, local to 0,0 (top,left) of the entity
  - centerWorld
```
public javafx.geometry.Point2D centerWorld(double x,
                                           double y)
```
    Parameters:
    
    x - position x of entity
    
    y - position y of entity
    
    Returns:
    
    center point of this hit box in world coordinates
  - copy
```
public HitBox copy()
```

Class HitBox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HitBox

HitBox

HitBox

HitBox

Method Detail

translate

translateXFlipped

getBounds

getShape

getMinX

getMinY

getMaxX

getMaxY

getWidth

getHeight

getName

bindX

bindY

unbind

getMinXWorld

getMaxXWorld

getMinYWorld

getMaxYWorld

centerLocal

centerWorld

copy