Package dev.prozilla.pine.core.component.canvas

Class RectTransform

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.canvas.RectTransform

All Implemented Interfaces:

Lifecycle, Printable, ComponentFinder, EntityFinder

public class RectTransform
extends Component

A base component for positioning canvas elements. Every canvas element is handled as a rectangle and is anchored to a position on the canvas, bottom left corner by default.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	absolutePosition	If true, this rect won't be arranged by a canvas group
GridAlignment	anchor
CanvasRenderer	canvas
Vector2i	currentPosition
Vector2i	currentSize
boolean	cursorHit
static final GridAlignment	DEFAULT_ANCHOR
int	iterations
boolean	passThrough	If true, allows the cursor to pass through this element.
DualDimension	position
boolean	readyToRender
DualDimension	size

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

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
RectTransform()

Method Summary

Modifier and Type	Method	Description
void	computeCurrentSize(DualDimension size)
CanvasRenderer	getCanvas()	Gets the canvas component in a parent entity.
CanvasContext	getContext()
String	getName()
int	getPositionX()
int	getPositionY()
int	getSizeX()
int	getSizeY()
boolean	isInCanvasGroup()
boolean	isInside(int x, int y)	Checks if a point is inside this rectangle.
boolean	isInside(Vector2i point)	Checks if a point is inside this rectangle.
static boolean	isInsideRect(int x, int y, Vector2i rectPosition, Vector2i rectSize)	Checks if a point is inside a given rectangle.
static boolean	isInsideRect(Vector2i point, Vector2i rectPosition, Vector2i rectSize)	Checks if a point is inside a given rectangle.
void	setAnchor(GridAlignment anchor)
void	setPosition(DualDimension position)
void	setSize(DualDimension size)

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

equals, getCamera, getChildWithTag, getComponent, getComponentInParent, getComponentInParent, getComponents, getComponentsInChildren, getEntity, getInput, getLogger, getParentWithTag, getRenderer, getTimer, getTracker, getTransform, getWindow, getWorld, 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.common.Lifecycle

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

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

print, print

Field Details

currentPosition

public Vector2i currentPosition

currentSize

public Vector2i currentSize

cursorHit

public boolean cursorHit

readyToRender

public boolean readyToRender

iterations

public int iterations

position

public DualDimension position

size

public DualDimension size

anchor

public GridAlignment anchor

passThrough

public boolean passThrough

If true, allows the cursor to pass through this element.

absolutePosition

public boolean absolutePosition

If true, this rect won't be arranged by a canvas group

canvas

public CanvasRenderer canvas

DEFAULT_ANCHOR

public static final GridAlignment DEFAULT_ANCHOR

Constructor Details

RectTransform

public RectTransform()

Method Details

getName

public String getName()

Overrides:

getName in class Component

isInside

public boolean isInside(Vector2i point)

Checks if a point is inside this rectangle.

Returns:

True if the point is inside the rectangle

isInside

public boolean isInside(int x,
 int y)

Checks if a point is inside this rectangle.

Parameters:

x - X position

y - Y position

Returns:

True if the point is inside the rectangle

isInsideRect

public static boolean isInsideRect(Vector2i point,
 Vector2i rectPosition,
 Vector2i rectSize)

Checks if a point is inside a given rectangle.

Parameters:

rectPosition - Position of the rectangle

rectSize - Size of the rectangle

Returns:

True if the point is inside the rectangle

isInsideRect

public static boolean isInsideRect(int x,
 int y,
 Vector2i rectPosition,
 Vector2i rectSize)

Checks if a point is inside a given rectangle.

Parameters:

rectPosition - Position of the rectangle

rectSize - Size of the rectangle

Returns:

True if the point is inside the rectangle

getContext

public CanvasContext getContext()

isInCanvasGroup

public boolean isInCanvasGroup()

getCanvas

public CanvasRenderer getCanvas()
                         throws IllegalStateException

Gets the canvas component in a parent entity.

Throws:

IllegalStateException - When this entity is not a child of an entity with a canvas component.

setPosition

public void setPosition(DualDimension position)

setSize

public void setSize(DualDimension size)

setAnchor

public void setAnchor(GridAlignment anchor)

getPositionX

public int getPositionX()

getPositionY

public int getPositionY()

getSizeX

public int getSizeX()

getSizeY

public int getSizeY()

computeCurrentSize

public void computeCurrentSize(DualDimension size)