Package dev.prozilla.pine.core.component.sprite

Class SpriteRenderer

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.sprite.SpriteRenderer

All Implemented Interfaces:

Lifecycle, Printable, ApplicationContext, ApplicationProvider, ComponentsContext, ComponentsProvider, EntityContext, EntityProvider, SceneContext, SceneProvider

public class SpriteRenderer
extends Component

A component for rendering 2D sprites in the world.

Field Summary

Fields

Modifier and Type	Field	Description
final Color	color
boolean	cropToRegion	Determines whether the texture will be cropped to a given region.
boolean	mirrorHorizontally
boolean	mirrorVertically
Vector2f	offset
Vector2f	regionOffset
Vector2f	regionSize
float	rotation
float	scale
TextureBase	texture

Fields inherited from class dev.prozilla.pine.core.component.Component

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
SpriteRenderer(TextureBase texture)
SpriteRenderer(TextureBase texture, Color color)

Method Summary

Modifier and Type	Method	Description
float	getHeight()
String	getName()
float	getWidth()
float	getX()
float	getY()
void	setRegion(float regX, float regY, float regWidth, float regHeight)	Crops this sprite to a given region.
void	setRegion(Vector2f regionOffset, Vector2f regionSize)
void	unsetRegion()	Disables cropping for this sprite.

Methods inherited from class dev.prozilla.pine.core.component.Component

equals, getApplication, getEntity, getScene, hashCode, setActive, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.core.ApplicationProvider

getConfig, getInput, getLogger, getModManager, getRenderer, getTimer, getTracker, getWindow

Methods inherited from interface dev.prozilla.pine.core.component.ComponentsProvider

getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren

Methods inherited from interface dev.prozilla.pine.core.entity.EntityContext

isDescendantOf

Methods inherited from interface dev.prozilla.pine.core.entity.EntityProvider

getChildWithTag, getFirstChild, getLastChild, getParentWithTag, getTransform, isDescendantOf

Methods inherited from interface dev.prozilla.pine.common.Lifecycle

destroy, init, init, input, input, render, render, start, update, update

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.core.scene.SceneProvider

getCameraData, getWorld

Field Details

texture

public TextureBase texture

color

public final Color color

scale

public float scale

rotation

public float rotation

offset

public Vector2f offset

mirrorHorizontally

public boolean mirrorHorizontally

mirrorVertically

public boolean mirrorVertically

cropToRegion

public boolean cropToRegion

Determines whether the texture will be cropped to a given region.

regionOffset

public Vector2f regionOffset

regionSize

public Vector2f regionSize

Constructor Details

SpriteRenderer

public SpriteRenderer(TextureBase texture)

SpriteRenderer

public SpriteRenderer(TextureBase texture,
 Color color)

Method Details

getName

public String getName()

Overrides:

getName in class Component

setRegion

public void setRegion(Vector2f regionOffset,
 Vector2f regionSize)

setRegion

public void setRegion(float regX,
 float regY,
 float regWidth,
 float regHeight)

Crops this sprite to a given region.

unsetRegion

public void unsetRegion()

Disables cropping for this sprite.

getWidth

public float getWidth()

getHeight

public float getHeight()

getX

public float getX()

getY

public float getY()