Package com.deco2800.game.rendering

Class BackgroundRenderComponent

java.lang.Object

com.deco2800.game.components.Component

com.deco2800.game.rendering.RenderComponent

com.deco2800.game.rendering.BackgroundRenderComponent

All Implemented Interfaces:

Disposable, Renderable, java.lang.Comparable<Renderable>

public class BackgroundRenderComponent
extends RenderComponent

Render the background texture.

Field Summary

Fields inherited from class com.deco2800.game.components.Component

enabled, entity

Constructor Summary

Constructors

Constructor	Description
BackgroundRenderComponent(java.lang.String texturePath)

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
void	draw(SpriteBatch batch)	Draw the renderable.
int	getLayer()	Layer to be rendered in.
float	getZIndex()	Set the zIndex of the entity according to the y coordinate of the entity and the original zIndex.
void	setHorizontal(float x)	Set the horizontal start point for the background texture
void	setVertical(float y)	Set the vertical start point for the background texture

Methods inherited from class com.deco2800.game.rendering.RenderComponent

compareTo, dispose, render

Methods inherited from class com.deco2800.game.components.Component

earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate, update

Methods inherited from class java.lang.Object

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

Constructor Details

BackgroundRenderComponent

public BackgroundRenderComponent(java.lang.String texturePath)

Method Details

create

public void create()

Description copied from class: Component

Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.

Overrides:

create in class RenderComponent

draw

public void draw(SpriteBatch batch)

Description copied from class: RenderComponent

Draw the renderable. Should be called only by the renderer, not manually.

Specified by:

draw in class RenderComponent

Parameters:

batch - Batch to render to.

getLayer

public int getLayer()

Description copied from interface: Renderable

Layer to be rendered in. Higher layers will be rendered on top of lower layers.

Specified by:

getLayer in interface Renderable

Overrides:

getLayer in class RenderComponent

Returns:

layer

getZIndex

public float getZIndex()

Description copied from class: RenderComponent

Set the zIndex of the entity according to the y coordinate of the entity and the original zIndex. If zIndex is not set originally, then The smaller the Y value, the higher the Z index, so that closer entities are drawn in front. If zIndex has been set, zIndex will not change.

Specified by:

getZIndex in interface Renderable

Overrides:

getZIndex in class RenderComponent

Returns:

The drawing priority of the current entity

setHorizontal

public void setHorizontal(float x)

Set the horizontal start point for the background texture

Parameters:

x - horizontal value

setVertical

public void setVertical(float y)

Set the vertical start point for the background texture

Parameters:

y - vertical value