Canvas#

public class Canvas#

A canvas for user interface elements. See getStockCanvas() and addCanvas().

RectTransform getRectTransform()#

The rect transform for the UI object.

LayoutElement getLayoutElement()#

How much space the UI object asks a layout for.

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

boolean getVisible()#
void setVisible(boolean value)#

Whether the UI object is visible.

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

Panel addPanel(boolean visible)#

Create a panel within this object.

Parameters:

  • visible (boolean) – Whether the new panel is visible.

Text addText(String content, boolean visible)#

Add text to this object.

Parameters:

  • content (String) – The text.

  • visible (boolean) – Whether the text is visible.

InputField addInputField(boolean visible)#

Add an input field to this object.

Parameters:

  • visible (boolean) – Whether the input field is visible.

Button addButton(String content, boolean visible)#

Add a button to this object.

Parameters:

  • content (String) – The label for the button.

  • visible (boolean) – Whether the button is visible.

Toggle addToggle(String content, boolean visible)#

Add a toggle to this object.

Parameters:

  • content (String) – The label for the toggle.

  • visible (boolean) – Whether the toggle is visible.

ToggleGroup addToggleGroup()#

Add a toggle group to this object, to make a set of toggles into radio buttons.

Note

The group is not drawn and does not take up any space. The toggles that belong to it can be added anywhere.

Slider addSlider(boolean vertical, boolean visible)#

Add a slider to this object.

Parameters:

  • vertical (boolean) – Whether the slider runs from bottom to top, rather than from left to right.

  • visible (boolean) – Whether the slider is visible.

Dropdown addDropdown(boolean visible)#

Add a dropdown to this object.

Parameters:

  • visible (boolean) – Whether the dropdown is visible.

Image addImage(boolean visible)#

Add an image to this object.

Parameters:

  • visible (boolean) – Whether the image is visible.

ScrollView addScrollView(boolean visible)#

Add a scroll view to this object.

Parameters:

  • visible (boolean) – Whether the scroll view is visible.

void remove()#

Remove the UI object.