Class Button

Object
   |
   +--Button

Direct Known Subclasses:

IconButton, TextButton

class Button

Defined in example.lfo.jsui.js

Field Detail

active

Boolean active

Whether or not this Button listens to GUI events (active state, deactivated state)

className

String className

A string identifier for this class.

clicked

Boolean clicked

Whether this Button was clicked.

clickedCount

int clickedCount

Current number of frames (calls to draw()) that have elapsed while clicked state was true.

clickedHoldMax

int clickedHoldMax

How many frames (calls to draw()) elapse before the clicked state is reset.

color

Array(4) color

Base OpenGL color of this Button - [R,G,B,A]

data

Object data

The data (object) to broadcast to this Button's handler when clicked.

debug

Boolean debug

If non-zero, posts verbose debugging information to the Max window.

handler

Object handler

Reference to a handler object to broadcast UI events to

hidden

Boolean hidden

Whether or not this Button should be drawn.

hitmask

Array(4) hitmask

Base OpenGL hitmask (mouse click overlay) color of this Button - [R,G,B,A]

inactivemask

Array(4) inactivemask

Base OpenGL inactive state mask color of this Button - [R,G,B,A]

mouseWasOver

Boolean mouseWasOver

Whether the mouse was positioned over this button last time we checked.

overmask

Array(4) overmask

Base OpenGL overmask (mouse over overlay) color of this Button - [R,G,B,A]

scale

Array(2) scale

Scale of this Button in OpenGL world coordinates (x,y)

screenLocation

Array(3) screenLocation

Location of this Button in screen coordinates (pixels) (x,y,z) (Top left corner of drawn Button)

size

Array(2) size

Size of this Button in screen coordinates (pixels) (x,y)

toggle

Boolean toggle

Whether this button holds after clicking until it's either clicked again or reset.

worldLocation

Array(3) worldLocation

Location of this Button in OpenGL world coordinates (x,y,z) (Center of drawn Button)

Button

Button(<String> name, <Object> sketcher)

Simple Button classes for GUI events. Reports it's data to a listener object with the functions clicked, mouseOver, mouseOut defined. Buttons are drawn around a center point (location).

Parameters:
name - This will be the name of the button (a way of identifying it)
sketcher - The sketch object that will draw the button, associated with this jsui

clone

Button clone()

Returns a new clone (a new Button object exactly like this one)

Returns:
Button clone

draw

void draw(<Boolean> force)

Main OpenGL drawing routine for drawing this Button to the screen, using its internal reference to the jsui "sketch" object. The "base" is drawn first drawBase(), then a mouseover overlay drawOverOverlay() or inactive overlay drawInactiveOverOverlay. This function is designed to be flexible so it does NOT need to be overloaded by child classes. Normally, the Button will only re-draw if it has to (if an event has taken place that affects the onscreen appearance of the Button, and if it is NOT hidden).

Parameters:
force - Force the drawing of the Button.

drawBase

void drawBase()

Draw only basic button elements. This function is designed to be be overloaded by child classes for Buttons of different appearances.

drawClickedOverlay

void drawClickedOverlay()

Draw blended overlay showing button was clicked.

drawInactiveOverlay

void drawInactiveOverlay()

Draw blended overlay showing Button is not receiving UI events (not active).

drawOverOverlay

void drawOverOverlay()

Draw blended overlay showing mouse is over Button.

getActive

Boolean getActive()

Get this Button's active state (if it is receiving mouse events)

Returns:
true (listening to events) or false (ignoring events)

getHandler

Object getHandler()

Get reference tohandler obect for Button events

Returns:
Reference to handler object that will receive this Button's events.

getHidden

Boolean getHidden()

Get this Button's hidden state (if it should be drawn)

Returns:
true (not drawn) or false (drawn)

getScale

Array(2) getScale()

Get this Button's scale.

Returns:
Array of [x-scale, y-scale]

getScreenLocation

Array(3) getScreenLocation()

Get the location of this button in screen coordinates (pixels)

Returns:
3-member Array of ints [x,y,z]

getSize

Array(2) getSize()

Get this Button's size (width, height) in pixels

Returns:
Array of [x-size, y-size]

getWorldLocation

Array(3) getWorldLocation()

Get the location of this button in world coords (OpenGL, for sketch)

Returns:
3-member Array of floats [x,y,z]

hitTest

Object hitTest(<int> x,<int> y)

Test if an x,y coordinate falls within the Button's boundaries.

Parameters:
x - x-coordinate
y - y-coordinate

onclick

void onclick(x,y,button,cmd,shift,capslock,option,ctrl)

Mouse click event handler

ondblclick

void ondblclick(x, y, button, mod1, shift, caps, opt, mod2)

Mouse double-click event handler

ondrag

void ondrag(x, y, button, mod1, shift, caps, opt, mod2)

Mouse drag event handler

onidle

void onidle(x,y,button,cmd,shift,capslock,option,ctrl)

Mouse idle event handler

onidleout

void onidleout(x, y, button, mod1, shift, caps, opt, mod2)

Mouse idleout event handler

onresize

void onresize()

Actions to perform when the Button is resized. Can be overloaded.

push

void push(<Boolean> showPush)

Manual/code-triggered mouse click event handler.

Parameters:
showPush - Whether or not to show the push when drawing the Button to screen.

setActive

void setActive(<Boolean> state)

Sets this Button as active (receives mouse events)

Parameters:
state - True if the Button should listen to events, false if it should ignore them.

setClicked

void setClicked(<Boolean> state)

Set the clicked state of this Button, update GUI. Usually, this is only called internally. A Button's clicked state is set to true after it is pressed, and remains true for a number of drawing frames (this.clickedCount) while the clicked overlay is drawn, and then it reset back to false.

Parameters:
state - The new internal clicked state of the Button, true or false

setHandler

void setHandler(<Object> hobj)

Set reference to handler obect for Button events

Parameters:
hobj - Handler object that will receive this Button's events.

setHidden

void setHidden(<Boolean> state)

Sets this Button as hidden (not drawn) or not hidden (drawn)

Parameters:
state - True if the Button will not be drawn

setScale

void setScale(<int> sx,<int> sy)

Sets the scale (as in OpenGL, the scale is 2x the width of the drawn button)

Parameters:
sx - x scale
sy - y scale

setScreenLocation

void setScreenLocation(<int> x,<int> y,<int> z)

Set the location of this button in screen coordinates (pixels)

Parameters:
x - x coordinate
y - y coordinate
z - z coordinate (optional)

setSize

void setSize(<int> sx,<int> sy)

Sets the size of the button (width, height in pixels)

Parameters:
sx - x size (pixels)
sy - y size (pixels)

setWorldLocation

void setWorldLocation(<float> x,<float> y,<float> z)

Set the location of this button in world coords (OpenGL, for sketch)

Parameters:
x - x coordinate
y - y coordinate
z - z coordinate

toString

String toString()

Return string representation of this object

Returns:
String of data about this object