BoundingBoxComponent (fxgl-base 0.5.0 API)

java.lang.Object
- com.almasb.fxgl.entity.component.Component
- - com.almasb.fxgl.entity.components.BoundingBoxComponent

All Implemented Interfaces:

CopyableComponent<BoundingBoxComponent>, SerializableComponent
```
public class BoundingBoxComponent
extends Component
implements SerializableComponent, CopyableComponent<BoundingBoxComponent>
```
Component that adds bounding box information to an entity. The bounding box itself comprises a collection of hit boxes.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`javafx.beans.property.ReadOnlyDoubleProperty`	`height`
`javafx.collections.ObservableList<HitBox>`	`hitBoxes`
`javafx.beans.property.ReadOnlyDoubleProperty`	`maxXWorld`
`javafx.beans.property.ReadOnlyDoubleProperty`	`maxYWorld`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minXLocal`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minXWorld`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minYLocal`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minYWorld`
`javafx.beans.property.ReadOnlyDoubleProperty`	`width`

Field Summary
- Fields inherited from class com.almasb.fxgl.entity.component.Component
  entity

Constructor Summary

Constructors
Constructor and Description

BoundingBoxComponent(HitBox... boxes)

Constructors
Constructor and Description
`BoundingBoxComponent(HitBox... boxes)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHitBox(HitBox hitBox)` Add a hit (collision) bounding box.
`CollisionResult`	`checkCollision(BoundingBoxComponent other)` Checks for collision with another bounding box.
`void`	`clearHitBoxes()` Remove all hit boxes.
`BoundingBoxComponent`	`copy()` Copies this component.
`javafx.geometry.Point2D`	`getCenterLocal()`
`javafx.geometry.Point2D`	`getCenterWorld()` If entity doesn't have `PositionComponent` then the center point is the same as local center.
`double`	`getHeight()` Returns total height of the bounding box, i.e.
`double`	`getMaxXLocal()` Note: same as width, unless specified otherwise.
`double`	`getMaxXWorld()`
`double`	`getMaxYLocal()` Note: same as height, unless specified otherwise.
`double`	`getMaxYWorld()`
`double`	`getMinXLocal()`
`double`	`getMinXWorld()`
`double`	`getMinYLocal()`
`double`	`getMinYWorld()`
`double`	`getWidth()` Returns total width of the bounding box, i.e.
`javafx.beans.property.ReadOnlyDoubleProperty`	`heightProperty()`
`javafx.collections.ObservableList<HitBox>`	`hitBoxesProperty()`
`boolean`	`isCollidingWith(BoundingBoxComponent other)`
`boolean`	`isOutside(double minX, double minY, double maxX, double maxY)`
`boolean`	`isOutside(javafx.geometry.Rectangle2D bounds)`
`boolean`	`isWithin(double minX, double minY, double maxX, double maxY)`
`boolean`	`isWithin(javafx.geometry.Rectangle2D bounds)`
`javafx.beans.property.ReadOnlyDoubleProperty`	`maxXWorldProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`maxYWorldProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minXLocalProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minXWorldProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minYLocalProperty()`
`javafx.beans.property.ReadOnlyDoubleProperty`	`minYWorldProperty()`
`void`	`onAdded()` Called after the component is added to entity.
`void`	`onRemoved()` Called before the component is removed from entity.
`javafx.geometry.Rectangle2D`	`range(double width, double height)` Forms a rectangle around the entity by extending min and max bounds with width in X and with height in Y directions.
`void`	`read(Bundle bundle)`
`void`	`removeHitBox(String name)` Removes a hit box with given name from the list of hit boxes for this entity.
`javafx.beans.property.ReadOnlyDoubleProperty`	`widthProperty()`
`void`	`write(Bundle bundle)`

Methods inherited from class com.almasb.fxgl.entity.component.Component
getEntity, isPaused, onUpdate, pause, resume

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

- Property Detail
  - hitBoxes
```
public final javafx.collections.ObservableList<HitBox> hitBoxesProperty
```
    Returns:
    
    unmodifiable list of hit boxes
  - width
```
public javafx.beans.property.ReadOnlyDoubleProperty widthProperty
```
    See Also:
    
    getWidth()
  - height
```
public javafx.beans.property.ReadOnlyDoubleProperty heightProperty
```
    See Also:
    
    getHeight()
  - minXLocal
```
public javafx.beans.property.ReadOnlyDoubleProperty minXLocalProperty
```
    See Also:
    
    getMinXLocal()
  - minYLocal
```
public javafx.beans.property.ReadOnlyDoubleProperty minYLocalProperty
```
    See Also:
    
    getMinYLocal()
  - minXWorld
```
public javafx.beans.property.ReadOnlyDoubleProperty minXWorldProperty
```
    See Also:
    
    getMinXWorld()
  - minYWorld
```
public javafx.beans.property.ReadOnlyDoubleProperty minYWorldProperty
```
    See Also:
    
    getMinYWorld()
  - maxXWorld
```
public javafx.beans.property.ReadOnlyDoubleProperty maxXWorldProperty
```
    See Also:
    
    getMaxXWorld()
  - maxYWorld
```
public javafx.beans.property.ReadOnlyDoubleProperty maxYWorldProperty
```
    See Also:
    
    getMaxYWorld()
- Constructor Detail
  - BoundingBoxComponent
```
public BoundingBoxComponent(HitBox... boxes)
```
- Method Detail
  - onAdded
```
public void onAdded()
```
    Description copied from class: Component
    
    Called after the component is added to entity.
    
    Overrides:
    
    onAdded in class Component
  - onRemoved
```
public void onRemoved()
```
    Description copied from class: Component
    
    Called before the component is removed from entity.
    
    Overrides:
    
    onRemoved in class Component
  - hitBoxesProperty
```
public final javafx.collections.ObservableList<HitBox> hitBoxesProperty()
```
    Returns:
    
    unmodifiable list of hit boxes
  - addHitBox
```
public final void addHitBox(HitBox hitBox)
```
    Add a hit (collision) bounding box.
    
    Parameters:
    
    hitBox - the bounding box
  - removeHitBox
```
public final void removeHitBox(String name)
```
    Removes a hit box with given name from the list of hit boxes for this entity.
    
    Parameters:
    
    name - hit box name
  - clearHitBoxes
```
public final void clearHitBoxes()
```
    Remove all hit boxes.
  - getWidth
```
public double getWidth()
```
    Returns total width of the bounding box, i.e. distance from the leftmost side to the rightmost side.
    
    Returns:
    
    width of the bounding box
  - widthProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty widthProperty()
```
    See Also:
    
    getWidth()
  - getHeight
```
public double getHeight()
```
    Returns total height of the bounding box, i.e. distance from the topmost side to the bottommost side.
    
    Returns:
    
    height of the bounding box
  - heightProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty heightProperty()
```
    See Also:
    
    getHeight()
  - minXLocalProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty minXLocalProperty()
```
    See Also:
    
    getMinXLocal()
  - getMinXLocal
```
public double getMinXLocal()
```
    Returns:
    
    min x of bbox in local coordinate system
  - minYLocalProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty minYLocalProperty()
```
    See Also:
    
    getMinYLocal()
  - getMinYLocal
```
public double getMinYLocal()
```
    Returns:
    
    min y of bbox in local coordinate system
  - getMaxXLocal
```
public double getMaxXLocal()
```
    Note: same as width, unless specified otherwise.
    
    Returns:
    
    max x of bbox in local coordinates
  - getMaxYLocal
```
public double getMaxYLocal()
```
    Note: same as height, unless specified otherwise.
    
    Returns:
    
    max y of bbox in local coordinates
  - minXWorldProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty minXWorldProperty()
```
    See Also:
    
    getMinXWorld()
  - minYWorldProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty minYWorldProperty()
```
    See Also:
    
    getMinYWorld()
  - maxXWorldProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty maxXWorldProperty()
```
    See Also:
    
    getMaxXWorld()
  - getMinXWorld
```
public double getMinXWorld()
```
    Returns:
    
    min x in world coordinate system
  - maxYWorldProperty
```
public javafx.beans.property.ReadOnlyDoubleProperty maxYWorldProperty()
```
    See Also:
    
    getMaxYWorld()
  - getMinYWorld
```
public double getMinYWorld()
```
    Returns:
    
    min y in world coordinate system
  - getMaxXWorld
```
public double getMaxXWorld()
```
    Returns:
    
    max x in world coordinates
  - getMaxYWorld
```
public double getMaxYWorld()
```
    Returns:
    
    max y in world coordinates
  - getCenterLocal
```
public javafx.geometry.Point2D getCenterLocal()
```
    Returns:
    
    center point in local coordinates
  - getCenterWorld
```
public javafx.geometry.Point2D getCenterWorld()
```
    If entity doesn't have PositionComponent then the center point is the same as local center.
    
    Returns:
    
    center point in world coordinates
  - checkCollision
```
public final CollisionResult checkCollision(BoundingBoxComponent other)
```
    Checks for collision with another bounding box. Returns collision result containing the first hit box that triggered collision. If no collision - CollisionResult.NO_COLLISION will be returned. If there is collision, the CollisionResult object must be put into pooler after using the data.
    
    Parameters:
    
    other - bounding box to check collision against
    
    Returns:
    
    collision result
  - isCollidingWith
```
public final boolean isCollidingWith(BoundingBoxComponent other)
```
    Parameters:
    
    other - the other entity
    
    Returns:
    
    true iff this entity is colliding with other based on their hit boxes, in current frame
  - 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
  - isWithin
```
public final boolean isWithin(double minX,
                              double minY,
                              double maxX,
                              double maxY)
```
    Parameters:
    
    minX - min x
    
    minY - min y
    
    maxX - max x
    
    maxY - max y
    
    Returns:
    
    true iff entity is partially or entirely within given bounds
  - isOutside
```
public final boolean isOutside(javafx.geometry.Rectangle2D bounds)
```
    Parameters:
    
    bounds - a rectangular box that represents bounds
    
    Returns:
    
    true iff entity is completely outside given bounds
  - isOutside
```
public final boolean isOutside(double minX,
                               double minY,
                               double maxX,
                               double maxY)
```
    Parameters:
    
    minX - min x
    
    minY - min y
    
    maxX - max x
    
    maxY - max y
    
    Returns:
    
    true iff entity is completely outside given bounds
  - range
```
public final javafx.geometry.Rectangle2D range(double width,
                                               double height)
```
    Forms a rectangle around the entity by extending min and max bounds with width in X and with height in Y directions.
    
    Parameters:
    
    width - width to extend by in each direction
    
    height - height to extend by in each direction
    
    Returns:
    
    rectangular area
  - write
```
public void write(@NotNull
                  Bundle bundle)
```
  - read
```
public void read(@NotNull
                 Bundle bundle)
```
  - copy
```
public BoundingBoxComponent copy()
```
    Description copied from interface: CopyableComponent
    
    Copies this component. The general contract should be similar to Object.clone(). The 'depth' of the copy should be determined by the user.
    
    Specified by:
    
    copy in interface CopyableComponent<BoundingBoxComponent>
    
    Returns:
    
    new instance (copy) of the component with copied values

Class BoundingBoxComponent

Property Summary

Field Summary

Fields inherited from class com.almasb.fxgl.entity.component.Component

Constructor Summary

Method Summary

Methods inherited from class com.almasb.fxgl.entity.component.Component

Methods inherited from class java.lang.Object

Property Detail

hitBoxes

width

height

minXLocal

minYLocal

minXWorld

minYWorld

maxXWorld

maxYWorld

Constructor Detail

BoundingBoxComponent

Method Detail

onAdded

onRemoved

hitBoxesProperty

addHitBox

removeHitBox

clearHitBoxes

getWidth

widthProperty

getHeight

heightProperty

minXLocalProperty

getMinXLocal

minYLocalProperty

getMinYLocal

getMaxXLocal

getMaxYLocal

minXWorldProperty

minYWorldProperty

maxXWorldProperty

getMinXWorld

maxYWorldProperty

getMinYWorld

getMaxXWorld

getMaxYWorld

getCenterLocal

getCenterWorld

checkCollision

isCollidingWith

isWithin

isWithin

isOutside

isOutside

range

write

read

copy