SceneObject (com.github.brunothg:game-engine 1.4.0 API)

java.lang.Object
- com.github.brunothg.game.engine.d2.object.SceneObject

Direct Known Subclasses:

ImageSceneObject, LabelSceneObject, NinePatchImageSceneObject, SpriteSceneObject
```
public abstract class SceneObject
extends Object
```
Helpful class for managing Objects in a scene. Provides methods for collision handling.

Author:

Marvin Bruns

Field Summary

Fields
Modifier and Type Field and Description

protected static Point ORIGIN_TOP_LEFT

Fields
Modifier and Type	Field and Description
`protected static Point`	`ORIGIN_TOP_LEFT`

Constructor Summary

Constructors
Constructor and Description

SceneObject()

Constructors
Constructor and Description
`SceneObject()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`collides(SceneObject obj)` Check, if both `SceneObject`s collide.
`Rectangle`	`collidesBoundingBox(SceneObject obj)` Check collision with bounding box algorithm.
`boolean`	`collidesExactly(SceneObject obj, Rectangle intersection)` Check exactly if a collision is present.
`boolean`	`consumes(SceneObject obj)` Check, if the given `SceneObject` is completely covered by this `SceneObject`.
`boolean`	`consumesBoundingBox(SceneObject obj)` Tests overlapping with bounding box.
`boolean`	`consumesExactly(SceneObject obj)` Exactly check overlapping.
`int`	`getHeight()` The height of this `SceneObject`
`Point`	`getOrigin()` The origin of this `SceneObject`.
`Point`	`getPosition()` Get the position of this `SceneObject`
`double`	`getPreciseHeight()` The precise height of this `SceneObject`
`double`	`getPreciseWidth()` The precise width of this `SceneObject`
`double`	`getPreciseX()` The precise X-Coordinate of this `SceneObject`
`double`	`getPreciseY()` The precise Y-Coordinate of this `SceneObject`
`Rectangle`	`getRectangle()` Get the `Rectangle` representing this object's bounds.
`RenderingOptions`	`getRenderingOptions()` Get the `RenderingOptions` used for painting.
`Size`	`getSize()` The size of this `SceneObject`
`Point`	`getTopLeftPosition()` The position of this `SceneObject`'s top left corner
`int`	`getWidth()` The width of this `SceneObject`
`int`	`getX()` The X-Coordinate of this `SceneObject`
`int`	`getY()` The Y-Coordinate of this `SceneObject`
`boolean`	`isDrawBoundingBox()` Check if the bounding box of this `SceneObject` is painted or not.
`protected abstract void`	`paint(Graphics2D g, long elapsedTime)` Paint this SceneObject.
`protected void`	`paintAbsoluteOnScene(Graphics2D g, long elapsedTime)` Paint this SceneObject using absolute coordinates.
`void`	`paintOnScene(Graphics2D g, int width, int height, long elapsedTime)` Paints this SceneObject and applies the actual `RenderingOptions`.
`void`	`paintOnScene(Graphics2D g, long elapsedTime)` Deprecated. Use `paintOnScene(Graphics2D, Size, long)` instead
`protected void`	`paintOnScene(Graphics2D g, Point positionTopLeft, Size size, long elapsedTime)` Paint on scene with given size and position
`void`	`paintOnScene(Graphics2D g, Size sceneSize, long elapsedTime)` Paints this SceneObject and applies the actual `RenderingOptions`.
`void`	`setDrawBoundingBox(boolean drawBoundingBox)` Change the drawing state of the bounding box.
`void`	`setPosition(int x, int y)` Set the position of this `SceneObject`
`void`	`setPosition(Point position)` Set the position of this `SceneObject`
`void`	`setRenderingOptions(RenderingOptions renderingOptions)` Set the `RenderingOptions` for painting.
`void`	`setSize(int width, int height)`
`void`	`setSize(Size size)` Set the size of this `SceneObject`
`void`	`setTopLeftPosition(Point p)` Set the position of this `SceneObject`'s top left corner

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

- Field Detail
  - ORIGIN_TOP_LEFT
```
protected static final Point ORIGIN_TOP_LEFT
```
- Constructor Detail
  - SceneObject
```
public SceneObject()
```
- Method Detail
  - paint
```
protected abstract void paint(Graphics2D g,
                              long elapsedTime)
```
    Paint this SceneObject. This method maybe called for collision testing with an elapsed time of zero. For correct collision the SceneObject it is important, that the object is drawn in it's actual state.
    
    Parameters:
    
    g - Graphics Object for painting
    
    elapsedTime - Elapsed time since the last call to this method
  - paintOnScene
```
@Deprecated
public void paintOnScene(Graphics2D g,
                                      long elapsedTime)
```
    Deprecated. Use paintOnScene(Graphics2D, Size, long) instead
    
    Paints this SceneObject and applies the actual RenderingOptions.
    
    Parameters:
    
    g - Graphics Object for painting
    
    elapsedTime - Elapsed time since the last call to this method
  - paintOnScene
```
public void paintOnScene(Graphics2D g,
                         int width,
                         int height,
                         long elapsedTime)
```
    Paints this SceneObject and applies the actual RenderingOptions.
    
    Parameters:
    
    g - Graphics Object for painting
    
    elapsedTime - Elapsed time since the last call to this method
    
    width - Scene width
    
    height - scene height
    
    See Also:
    
    paintOnScene(Graphics2D, Size, long)
  - paintOnScene
```
public void paintOnScene(Graphics2D g,
                         Size sceneSize,
                         long elapsedTime)
```
    Paints this SceneObject and applies the actual RenderingOptions.
    
    Parameters:
    
    g - Graphics Object for painting
    
    sceneSize - Scene size
    
    elapsedTime - Elapsed time since the last call to this method
    
    See Also:
    
    paintOnScene(Graphics2D, Size, long)
  - paintAbsoluteOnScene
```
protected void paintAbsoluteOnScene(Graphics2D g,
                                    long elapsedTime)
```
    Paint this SceneObject using absolute coordinates.
    
    Parameters:
    
    g - Graphics Object for painting
    
    elapsedTime - Elapsed time since the last call to this method
  - paintOnScene
```
protected void paintOnScene(Graphics2D g,
                            Point positionTopLeft,
                            Size size,
                            long elapsedTime)
```
    Paint on scene with given size and position
    
    Parameters:
    
    g - Graphics Object for painting
    
    positionTopLeft - Top left position of object
    
    size - Absolute size of object
    
    elapsedTime - Elapsed time since the last call to this method
  - getTopLeftPosition
```
public Point getTopLeftPosition()
```
    The position of this SceneObject's top left corner
    
    Returns:
    
    The Position of this SceneObject's top left corner
  - setTopLeftPosition
```
public void setTopLeftPosition(Point p)
```
    Set the position of this SceneObject's top left corner
  - getPosition
```
public Point getPosition()
```
    Get the position of this SceneObject
    
    Returns:
    
    The position of this ScreenObject
  - getY
```
public int getY()
```
    The Y-Coordinate of this SceneObject
    
    Returns:
    
    The Y-Coordinate of this ScreenObject
    
    See Also:
    
    getPosition()
  - getPreciseY
```
public double getPreciseY()
```
    The precise Y-Coordinate of this SceneObject
    
    Returns:
    
    The Y-Coordinate of this ScreenObject
    
    See Also:
    
    getPosition()
  - getX
```
public int getX()
```
    The X-Coordinate of this SceneObject
    
    Returns:
    
    The X-Coordinate of this ScreenObject
    
    See Also:
    
    getPosition()
  - getPreciseX
```
public double getPreciseX()
```
    The precise X-Coordinate of this SceneObject
    
    Returns:
    
    The X-Coordinate of this ScreenObject
    
    See Also:
    
    getPosition()
  - setPosition
```
public void setPosition(Point position)
```
    Set the position of this SceneObject
    
    Parameters:
    
    position - The Position of this ScreenObject
  - setPosition
```
public void setPosition(int x,
                        int y)
```
    Set the position of this SceneObject
    
    Parameters:
    
    x - The X-Coordinate of this ScreenObject
    
    y - The Y-Coordinate of this ScreenObject
    
    See Also:
    
    setPosition(Point)
  - getOrigin
```
public Point getOrigin()
```
    The origin of this SceneObject. This object's position will be translated to it's origin. The default implementation returns ORIGIN_TOP_LEFT
    
    Returns:
    
    The origin of this ScreenObject
  - getSize
```
public Size getSize()
```
    The size of this SceneObject
    
    Returns:
    
    The Size of this ScreenObject
  - getHeight
```
public int getHeight()
```
    The height of this SceneObject
    
    Returns:
    
    The height of this ScreenObject
    
    See Also:
    
    getSize()
  - getPreciseHeight
```
public double getPreciseHeight()
```
    The precise height of this SceneObject
    
    Returns:
    
    The height of this ScreenObject
    
    See Also:
    
    getSize()
  - getWidth
```
public int getWidth()
```
    The width of this SceneObject
    
    Returns:
    
    The width of this ScreenObject
    
    See Also:
    
    getSize()
  - getPreciseWidth
```
public double getPreciseWidth()
```
    The precise width of this SceneObject
    
    Returns:
    
    The width of this ScreenObject
    
    See Also:
    
    getSize()
  - setSize
```
public void setSize(Size size)
```
    Set the size of this SceneObject
    
    Parameters:
    
    size - Size of this ScreenObject
  - setSize
```
public void setSize(int width,
                    int height)
```
    Parameters:
    
    width - Width of this ScreenObject
    
    height - Height of this ScreenObject
    
    See Also:
    
    setSize(Size)
  - isDrawBoundingBox
```
public boolean isDrawBoundingBox()
```
    Check if the bounding box of this SceneObject is painted or not. If it is painted a rectangle will be drawn around the dimensions of this object.
    
    Returns:
    
    true if the bounding box will be painted
  - setDrawBoundingBox
```
public void setDrawBoundingBox(boolean drawBoundingBox)
```
    Change the drawing state of the bounding box.
    
    Parameters:
    
    drawBoundingBox - true if the bounding box should be painted
  - getRenderingOptions
```
public RenderingOptions getRenderingOptions()
```
    Get the RenderingOptions used for painting. The are applied to every Graphics2D object, this one is painted on.
    
    Returns:
    
    The rendering options or null, if no rendering related configuration was made
    
    See Also:
    
    setRenderingOptions(RenderingOptions)
  - setRenderingOptions
```
public void setRenderingOptions(RenderingOptions renderingOptions)
```
    Set the RenderingOptions for painting.
    
    Parameters:
    
    renderingOptions -
    
    See Also:
    
    getRenderingOptions()
  - consumes
```
public boolean consumes(SceneObject obj)
```
    Check, if the given SceneObject is completely covered by this SceneObject.
    First test with bounding box if there maybe a overlapping situation exact calculations are made.
    
    Parameters:
    
    obj - Other Object for testing
    
    Returns:
    
    true if the given object is completely covered by this object
  - consumesExactly
```
public boolean consumesExactly(SceneObject obj)
```
    Exactly check overlapping. Uses alpha mask to detect geometry. If there's a pixel in the given object, that has an alpha greater 0 and this object is transparent (alpha = 0) at this position false is returned.
    
    Parameters:
    
    obj - Other object for testing
    
    Returns:
    
    true if the given SceneObject is consumed by this object
  - consumesBoundingBox
```
public boolean consumesBoundingBox(SceneObject obj)
```
    Tests overlapping with bounding box.
    
    Parameters:
    
    obj - Other Object for testing
  - collides
```
public boolean collides(SceneObject obj)
```
    Check, if both SceneObjects collide.
    In a first step bounding box collision will be tested. If a collision maybe possible exact collision is checked.
    
    Parameters:
    
    obj - Second SceneObject
    
    Returns:
    
    true if both SceneObjects collide
    
    See Also:
    
    collidesExactly(SceneObject, Rectangle), collidesBoundingBox(SceneObject)
  - collidesExactly
```
public boolean collidesExactly(SceneObject obj,
                               Rectangle intersection)
```
    Check exactly if a collision is present. The result may only be correct if collidesBoundingBox(SceneObject) returns a non empty region. The default implementation tests every pixel drawn by this object. If there's a pixel set (alpha != 0) in both objects they collide. Depending on the object there maybe a better collision handling. Feel free to override this method for better performance.
    
    Parameters:
    
    obj - The second SceneObject for testing
    
    intersection - Region in which the collision may occur
    
    Returns:
    
    true if there's a collision
  - collidesBoundingBox
```
public Rectangle collidesBoundingBox(SceneObject obj)
```
    Check collision with bounding box algorithm.
    
    Parameters:
    
    obj - The second SceneObject for testing
    
    Returns:
    
    The overlapping region or null if none. Coordinates (0,0) is located in the top-left corner.
  - getRectangle
```
public Rectangle getRectangle()
```
    Get the Rectangle representing this object's bounds.
    
    Returns:
    
    This object's bounds

Class SceneObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORIGIN_TOP_LEFT

Constructor Detail

SceneObject

Method Detail

paint

paintOnScene

paintOnScene

paintOnScene

paintAbsoluteOnScene

paintOnScene

getTopLeftPosition

setTopLeftPosition

getPosition

getY

getPreciseY

getX

getPreciseX

setPosition

setPosition

getOrigin

getSize

getHeight

getPreciseHeight

getWidth

getPreciseWidth

setSize

setSize

isDrawBoundingBox

setDrawBoundingBox

getRenderingOptions

setRenderingOptions

consumes

consumesExactly

consumesBoundingBox

collides

collidesExactly

collidesBoundingBox

getRectangle