Packages

  • package o1

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University.

    O1Library is a toolkit designed for the course Programming 1 (a.k.a. O1) at Aalto University. It contains an assortment of tools; most prominently, it provides a framework for simple graphical programming and utilities for playing sound.

    This is the front page of O1Library’s documentation. However, this is probably not the best place to start learning about O1Library as a student. That’s because the relevant content of this library is introduced bit by bit in the chapters of O1’s custom ebook alongside the associated programming concepts and assignments.

    You may still find this documentation useful as a reference. You can also find some optional content here that you may wish to try.

    This front page lists the content available in the top-level package called simply o1. These tools are available with the simple command import o1._ in your Scala programs. Some of them you’ll use a lot; some of them you won’t necessarily need at all.

    The tools listed here are actually implemented in a number of subpackages (o1.gui, o1.sound, etc.); what you see here are just “shortcut aliases” to those actual implementations. The aliases are here to make that convenient import command work and to provide you with this list of links to some of the more commonly used tools in O1Library. The subpackages also contain additional content not listed here.

    O1Library has been developed by Aleksi Lukkarinen and Juha Sorva. Several of the key components in o1.gui and o1.world are built upon Aleksi’s Scala Media Computation Library. Some parts of O1Library draw inspiration from the “teachpacks” of the Racket programming language.

    We are grateful to Riku Autio, Joonatan Honkamaa, Juhani Numminen, Leo Varis, Veera Kahva, and anonymous students for bug reports and fixes. We thank Otto Seppälä for helpful discussions.

    Definition Classes
    root
  • package gui

    This package contains tools for building simple GUIs.

    This package contains tools for building simple GUIs. The toolkit is particularly well suited to constructing GUIs that display information as 2D images and/or geometric shapes. It is not designed for demanding graphical needs that call for high efficiency. Some of the tools in this package are built on the Swing GUI library, and the two libraries can be used in combination.

    Some of the types in this package have aliases in the top-level package o1, so they are accessible to students simply via import o1._. Some of the package contents are not available in the top-level package or included in this documentation.

    Please note: One of this package’s key components (views) comes in multiple varieties, which which are defined in the subpackages o1.gui.mutable and o1.gui.immutable and not listed below. The View that is most commonly used in O1 (and aliased as o1.View in the top-level package) is o1.gui.mutable.ViewFrame.

    Definition Classes
    o1
  • package colors

    This package contains Color constants.

    This package contains Color constants. They cover all the colors listed in the W3C’s CSS Color Module specification (July 5th, 2017); there are some additional ones as well.

    All the colors are fully opaque, except Transparent, which is fully transparent.

    The contents of this package are aliased in the top-level package o1 so that they are accessible to students simply via import o1._.

    Definition Classes
    gui
  • package event

    This package exists in order to provide aliases to event classes in Swing and to add some methods to Swing’s InputEvent via o1.gui.event.ConvenientInputEvent.

    This package exists in order to provide aliases to event classes in Swing and to add some methods to Swing’s InputEvent via o1.gui.event.ConvenientInputEvent.

    The contents of this package are aliased in the top-level package o1, so that they are accessible to students simply via* import o1._.

    Definition Classes
    gui
  • package layout

    The package o1.gui.layout contains utilities that make it more convenient to lay out components in simple GridBagPanels from Scala's Swing library.

    The package o1.gui.layout contains utilities that make it more convenient to lay out components in simple GridBagPanels from Scala's Swing library. These utilities are used internally by some of the given GUIs in O1.

    NOTE TO STUDENTS: In this course, you don't need to understand how this package works or can be used.

    Definition Classes
    gui
  • Animation
  • Color
  • DefaultFrameSettings
  • Dialog
  • Escapable
  • Pic
  • SimpleFrame
  • TerminatesOnClose
  • View
  • immutable
  • mutable
o

o1.gui

View

object View

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. View
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class Aborted[TraceData](message: String, partialTrace: Seq[(TraceData, TraceEvent)]) extends RuntimeException with Product with Serializable

    Represents situations where a View hasn’t reached its done state in the allotted number of ticks.

    Represents situations where a View hasn’t reached its done state in the allotted number of ticks.

    TraceData

    the type of the model-state descriptions in the trace

    partialTrace

    the trace collected until the view was aborted.

  2. trait HasPauseToggle extends AnyRef

    Add this trait on a View to give it a pause toggle.

    Add this trait on a View to give it a pause toggle. You’ll still need to call togglePause on whichever event you want to pause the view (e.g., user hitting space bar).

  3. abstract class RefreshPolicy extends AnyRef

    A superclass for the different policies for updating the image visible in a View in response to a change in the model.

    A superclass for the different policies for updating the image visible in a View in response to a change in the model.

    Note to students: You’re unlikely to need this for anything in O1.

  4. sealed abstract class TraceEvent extends AnyRef

    Describes a single tick or GUI event recorded while tracing a View.

    Describes a single tick or GUI event recorded while tracing a View. See the TraceEvent companion object for specific subtypes.

Value Members

  1. val TicksPerSecondDefault: Int

    The number of clock ticks (24) that a View aims to generate per clock tick, unless otherwise specified.

  2. object Always extends RefreshPolicy with Product with Serializable

    The RefreshPolicy of seeking to update the image visible in a View as often as possible.

    The RefreshPolicy of seeking to update the image visible in a View as often as possible. (Time-consuming but always safe.)

    Note to students: You’re unlikely to need this for anything in O1.

  3. object TraceEvent

    This companion object of the sealed TraceEvent class provides subtypes of the class, which can be used for tracing different kinds of events.

  4. object UnlessIdentical extends RefreshPolicy with Product with Serializable

    The RefreshPolicy of seeking to update the image visible in a View only when the current model object is non-identical in terms of equals than the previous one shown.

    The RefreshPolicy of seeking to update the image visible in a View only when the current model object is non-identical in terms of equals than the previous one shown.

    Note to students: You’re unlikely to need this for anything in O1.

  5. object UnlessSameReference extends RefreshPolicy with Product with Serializable

    The RefreshPolicy of seeking to update the image visible in a View only when the current model object is different in identity than the previous one shown.

    The RefreshPolicy of seeking to update the image visible in a View only when the current model object is different in identity than the previous one shown.

    Note to students: You’re unlikely to need this for anything in O1.