easel.ui.graphics.pie

Class PieChartWidget

java.lang.Object

easel.ui.AbstractWidget<T>

easel.ui.graphics.ShaderWidget<PieChartWidget>

easel.ui.graphics.pie.PieChartWidget

public class PieChartWidget
extends ShaderWidget<PieChartWidget>

Renders a circular pie chart using shaders given dynamically specified regions. There are two distinct ways to build the chart: in bulk, using the withCounts(int...) and withColors(Color...) methods, or region by region with repeated applications of withRegion(int, Color). The order the regions are rendered in the pie chart (counter-clockwise starting at the top right) is determined by the order they are inserted into this widget. You can update the count or color of a particular region if you know the index at which it was entered into the chart. When constructing the pie chart using the bulk methods, make sure you have the same number of colors as region counts (otherwise it is undefined behavior).

Field Summary

Fields inherited from class easel.ui.graphics.ShaderWidget

height, shaderProgram, tex, width

Fields inherited from class easel.ui.AbstractWidget

hasInteractivity, hb, isHovered, leftClickStarted, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, rightClickStarted

Constructor Summary

Constructors

Constructor and Description
PieChartWidget(float width, float height) Constructs a new pie-chart that will render with the given width or height.

Method Summary

Modifier and Type	Method and Description
PieChartWidget	clear() Clears out all previously stored region sizes and colors.
protected void	setUniforms()
boolean	updateRegionColor(int index, com.badlogic.gdx.graphics.Color color) Updates the color of the given region, if it exists.
boolean	updateRegionCount(int index, int count) Updates the relative size of the given region, if it exists.
PieChartWidget	withColors(com.badlogic.gdx.graphics.Color... colors) Sets all colors in the pie chart at once.
PieChartWidget	withCounts(int... counts) Sets all counts in the pie chart at once.
PieChartWidget	withRegion(int count, com.badlogic.gdx.graphics.Color color) Set the relative count and color of the next region in the pie chart.

Methods inherited from class easel.ui.graphics.ShaderWidget

getContentHeight, getContentWidth, renderTexture, renderWidget, withDimensions, withHeight, withWidth

Methods inherited from class easel.ui.AbstractWidget

anchoredAt, anchoredAt, anchoredAtClamped, anchoredAtClamped, anchoredCenteredOnMouse, anchoredCenteredOnMouse, anchoredCenteredOnMouseClamped, anchoredCenteredOnMouseClamped, anchoredCenteredOnScreen, anchoredCenteredOnScreen, cancelMovementQueue, cancelMovementQueueForAllChildren, delayedTranslate, getBottom, getContentBottom, getContentCenterX, getContentCenterY, getContentLeft, getContentRight, getContentTop, getHeight, getLeft, getRight, getTop, getWidth, hide, initializeInteractivity, isMouseInBounds, isMouseInContentBounds, leftMouseClick, mouseEnter, mouseLeave, onLeftClick, onMouseEnter, onMouseLeave, onRightClick, refreshAnchor, render, renderTopLevel, resolveMovementQueue, rightMouseClick, scaleHitboxToContent, setAllDelayedMovement, setChildrenDelayedMovement, show, toString, translate, update, updateInteractivity, updateWidget, withMargins, withMargins, withMargins

Methods inherited from class java.lang.Object

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

Constructor Detail

PieChartWidget

public PieChartWidget(float width,
                      float height)

Constructs a new pie-chart that will render with the given width or height. The pie chart will be rendered as a square up to the smaller dimension. Note: the pie chart itself will be a little bit smaller than the given region as the radius used internally does not stretch all the way to the sides by design.

Parameters:

width - the width of the widget

height - the height of the widget

Method Detail

withCounts

public PieChartWidget withCounts(int... counts)

Sets all counts in the pie chart at once. Each count determines how much relative space that particular region gets as compared to the whole area, e.g. counts of withCounts(1, 1) will result in two regions each taking up exactly 50% of the final area. The order of the variadic list determines the order in which the regions are constructed. This function automatically clears out any previously existing counts, but will not clear out colors. This is intended to be used alongside withColors(Color...) with the same number of arguments to each, and not doing so should be considered undefined behavior.

Parameters:

counts - a list of relative counts determining the size of each region

Returns:

this widget

See Also:

withColors(Color...), withRegion(int, Color)

withColors

public PieChartWidget withColors(com.badlogic.gdx.graphics.Color... colors)

Sets all colors in the pie chart at once. This function will clear out any existing colors added previously and is intended to be used alongside withCounts(int...) with the same number of parameters to each. The order in the variadic list determines the order rendered on the pie chart, going counter-clockwise from the top right.

Parameters:

colors - a list of colors for each region

Returns:

this widget

See Also:

withCounts(int...), withRegion(int, Color)

clear

public PieChartWidget clear()

Clears out all previously stored region sizes and colors. Not necessary to be called unless you're using the withRegion(int, Color) mutators and wish to reset any previously added regions. The next withRegion(int, Color) call after this function will be the first region in the chart.

Returns:

this widget

See Also:

withRegion(int, Color)

withRegion

public PieChartWidget withRegion(int count,
                                 com.badlogic.gdx.graphics.Color color)

Set the relative count and color of the next region in the pie chart. This function is intended to be repeatedly chained until all regions are defined, and serves as a way to individually add regions instead of doing them in bulk (e.g. etc.. The first region constructed by this function will be the top right, with the remaining regions all relative to each other and proceeding counter-clockwise.

Parameters:

count - the relative size of this region (compared to other uses of this function)

color - the color for this region

Returns:

this widget

See Also:

clear(), withCounts(int...), withColors(Color...)

updateRegionCount

public boolean updateRegionCount(int index,
                                 int count)

Updates the relative size of the given region, if it exists. The index is determined by the order in which the region is added (starting at 0) using the bulk input functions (e.g. withCounts(int...)) or the particular input function (e.g. withRegion(int, Color)).

Parameters:

index - the zero-based index referring to the particular region to update

count - the new relative size of the region

Returns:

true if there is a region at that particular index which was updated; false if the index given is out of bounds

updateRegionColor

public boolean updateRegionColor(int index,
                                 com.badlogic.gdx.graphics.Color color)

Updates the color of the given region, if it exists. The index is determined by the order in which the region is added (starting at 0) using the bulk input functions (e.g. withCounts(int...)) or the particular input function (e.g. withRegion(int, Color)).

Parameters:

index - the zero-based index referring to the particular region to update

color - the new color of the region

Returns:

true if there is a region at that particular index which was updated; false if the index given is out of bounds

setUniforms

protected void setUniforms()

Overrides:

setUniforms in class ShaderWidget<PieChartWidget>