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

Class CanvasGroup

java.lang.Object

dev.prozilla.pine.core.component.Component

dev.prozilla.pine.core.component.canvas.CanvasGroup

All Implemented Interfaces:

Lifecycle, Printable, CanvasContext, ComponentFinder, EntityFinder

public class CanvasGroup
extends Component
implements CanvasContext

A component that groups multiple canvas elements together and aligns them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CanvasGroup.Distribution

Field Summary

Fields

Modifier and Type	Field	Description
EdgeAlignment	alignment
boolean	arrangeChildren
Color	backgroundColor
List<RectTransform>	childRects	Array of rect components in children of the attached entity
static final EdgeAlignment	DEFAULT_ALIGNMENT
static final Direction	DEFAULT_DIRECTION
static final CanvasGroup.Distribution	DEFAULT_DISTRIBUTION
Direction	direction
CanvasGroup.Distribution	distribution
int	gap	Distance between elements.
Vector2i	innerSize
DualDimension	padding
RectTransform	rect
Vector2i	totalChildrenSize

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

entity, id, isActive

Constructor Summary

Constructors

Constructor	Description
CanvasGroup()
CanvasGroup(Direction direction)
CanvasGroup(Direction direction, EdgeAlignment alignment)
CanvasGroup(Direction direction, EdgeAlignment alignment, CanvasGroup.Distribution distribution)

Method Summary

Modifier and Type	Method	Description
void	getChildComponents()	Finds and stores rect components in children to be used in calculations later.
int	getHeight()
String	getName()
RectTransform	getRect()
int	getWidth()
int	getX()
int	getY()
void	setPadding(DualDimension padding)

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

direction

public Direction direction

alignment

public EdgeAlignment alignment

distribution

public CanvasGroup.Distribution distribution

backgroundColor

public Color backgroundColor

gap

public int gap

Distance between elements.

padding

public DualDimension padding

arrangeChildren

public boolean arrangeChildren

innerSize

public Vector2i innerSize

totalChildrenSize

public Vector2i totalChildrenSize

childRects

public List<RectTransform> childRects

Array of rect components in children of the attached entity

rect

public RectTransform rect

DEFAULT_DIRECTION

public static final Direction DEFAULT_DIRECTION

DEFAULT_ALIGNMENT

public static final EdgeAlignment DEFAULT_ALIGNMENT

DEFAULT_DISTRIBUTION

public static final CanvasGroup.Distribution DEFAULT_DISTRIBUTION

Constructor Details

CanvasGroup

public CanvasGroup()

CanvasGroup

public CanvasGroup(Direction direction)

CanvasGroup

public CanvasGroup(Direction direction,
 EdgeAlignment alignment)

CanvasGroup

public CanvasGroup(Direction direction,
 EdgeAlignment alignment,
 CanvasGroup.Distribution distribution)

Method Details

getName

public String getName()

Overrides:

getName in class Component

setPadding

public void setPadding(DualDimension padding)

getChildComponents

public void getChildComponents()

Finds and stores rect components in children to be used in calculations later.

getRect

public RectTransform getRect()

getX

public int getX()

Specified by:

getX in interface CanvasContext

getY

public int getY()

Specified by:

getY in interface CanvasContext

getWidth

public int getWidth()

Specified by:

getWidth in interface CanvasContext

getHeight

public int getHeight()

Specified by:

getHeight in interface CanvasContext