Skip to content

Finding the component you need

Jump to bottom
thecodewarrior edited this page Aug 13, 2016 · 6 revisions

Finding the component/mixin/template you need

Tags (use Ctrl/Cmd+F to find these in the page):

  • [component
  • [mixin
  • [template
  • [movement
  • [OpenGL
  • [layout
  • [nodraw
  • [alignment
  • [text
  • [color
  • [3D
  • [tiled
  • [border
  • [texture
  • [item
  • [tooltip
  • [input
  • [navigation
  • [GUIStyle

Components

ComponentVoid no JavaDocs

[component [layout [nodraw

A void component. It has no functionality beyond what's common to all GuiComponents. Usually used to store other components. Such as this hierarchy contents (CompVoid) -> sidebar (CompVoid) -> list (CompList) -> listItem (CompVoid) -> thumbnail (CompSprite)

ComponentText no JavaDocs

[component [text [color [alignment [draw

A text component. It draws text, can change the color, can wrap, can align horizontally and vertically, can draw in unicode mode, and can draw shadows.

ComponentStructure no JavaDocs

[component [color [3D [blocks [draw

A structure model component. It draws a 3D structure and can have a color multiplier. It is generally used inside a Component3DView

ComponentSpriteTiled no JavaDocs

[component [color [sprite [texture [tiled [border [draw

A tiled textured component with a border. Draws an arbitrarily sized textured area with a border.

ComponentSpriteCapped no JavaDocs

[component [sprite [texture [tiled [draw

A tiled textured component that has caps. Draws an arbitrarily long textured area with sprites at the ends.

ComponentSprite no JavaDocs

[component [sprite [texture [color [draw

A sprite component. Draws a sprite at an arbitrary size on the screen. Stretches or squishes as necessary.

ComponentSlot no JavaDocs

[component [item [stack [tooltip [draw

A slot component. Draws an itemstack and enqueues it's tooltip. Tooltip and stack size text are customizable.

ComponentSlider no JavaDocs

[component [nodraw [movement [input

A sliding bar component. Used often as an input or scrollbar, has a child component that can be dragged along a line and a output that can be read.

ComponentScrolledView no JavaDocs

[component [nodraw [movment [navigation

A scrolled view component. Allows components to be scrolled horizontally and vertically and uses a scissor test to cut off any components outside the scroll area.

ComponentRect no JavaDocs

[component [color [draw

A colored rect component. Draws a colored rect with an optional gradient.

ComponentMarkup no JavaDocs

[component [text [draw [layout

A markup view component. A view that lays out markup elements and draws them. Markup elements have their functionality defined by the caller, there's little pre-baked functionality.

ComponentList

[component [layout [nodraw

A list layout component. Lays out all child elements vertically according to their logical size.

ComponentGrid

[component [layout [nodraw

A grid layout component. Lays out all child elements based on a fixed size grid.

ComponentCenterAlign

[component [layout [nodraw

A center alignment component. Aligns all it's children to be centered based on their logical size.

Component3DView

[component [3D [layout [nodraw

A 3D view and navigation component. Displays child components in 3D and allows the user to navigate through the 3D space.

Templates

ButtonTemplate no JavaDocs unfinished

[template [GUIStyle [input [texture

A template for a basic button. The button contains a string and adjusts to fit that string.

Mixins

GlMixin.pushPopMatrix no JavaDocs

[mixin [OpenGL

Calls GlStateManager.pushMatrix() before drawing, pops after drawing.

GlMixin.pushPopAttrib no JavaDocs

[mixin [OpenGL

Calls GlStateManager.pushAttrib() before drawing, pops after drawing.

GlMixin.color no JavaDocs

[mixin [OpenGL [color

(includes GlMixin.pushPopAttrib)

Changes the OpenGL color before drawing the component or it's children. Returns an Option<Color> that you use to specify the color

GlMixin.transform no JavaDocs

[mixin [OpenGL [movement [3D

(includes GlMixin.pushPopMatrix)

Translates by the specified amount before drawing. Returns an Option<Vec3d> that you use to specify the translation.

GlMixin.scale no JavaDocs

[mixin [OpenGL [movement [3D

(includes GlMixin.pushPopMatrix)

Scales by the specified amount before drawing. Returns an Option<Vec3d> that you use to specify the scale.

GlMixin.rotate no JavaDocs

[mixin [OpenGL [movement [3D

(includes GlMixin.pushPopMatrix)

Rotates by the specified amount before drawing. Returns an Option<Vec3d> that you use to specify the scale.

ButtonMixin

[mixin [input

Adds events for the different states of a button and adds an easily hooked event for when the button is enabled and clicked.

DragMixin

[mixin [input [movement

Adds draggable functionality to a component. Allows the component to be dragged with the mouse.

ScissorMixin

[mixin [OpenGL

Adds a scissor test to the component. The scissor test cuts off anything rendered outside the component's bounds as defined by the getPos() and getSize() methods.

Clone this wiki locally