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 world

    This package contains tools for locations and movement in two-dimensional space.

    This package contains tools for locations and movement in two-dimensional space.

    The tools in this package have aliases in the top-level package o1, so they are accessible to students simply via import o1._.

    The subpackage o1.world.objects contains additional tools for representing entities that reside within two-dimensional spaces.

    Definition Classes
    o1
  • package objects

    This package contains tools for representing objects that exist in two-dimensional space.

    This package contains tools for representing objects that exist in two-dimensional space. In particular, it defines:

    • the Anchor type: an anchor is the point where an object connects to its environment; and
    • a number of traits (HasPos, HasVelocity, etc.) the classes of an application can mix in to gain access to various convenience methods.

    NOTE TO STUDENTS: In this course, you don't need to understand how this package works or can be used. That being said, some students may wish to experiment with some of its contents. Many of the traits in this package have aliases in the top-level package o1, so they are accessible to students simply via import o1._.

    Definition Classes
    world
  • Bounds
  • Direction
  • Pos
  • Velocity

final case class Bounds(left: Double, top: Double, width: Double, height: Double) extends Product with Serializable

A Bounds represents the dimensions of a rectangular area in two-dimensional space.

Bounds objects are immutable. They assume a space in which x coordinates increase rightwards and y coordinates downwards.

This class has an alias in the top-level package o1, so it’s accessible to students simply via import o1._.

left

the x coordinate of the left edge of the Bounds

top

the y coordinate of the top edge of the Bounds

width

the width of the Bounds (the distance from its left edge to its right edge)

height

the height of the Bounds (the distance from its top edge to its bottom edge)

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bounds
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Bounds(left: Double, top: Double, width: Double, height: Double)

    left

    the x coordinate of the left edge of the Bounds

    top

    the y coordinate of the top edge of the Bounds

    width

    the width of the Bounds (the distance from its left edge to its right edge)

    height

    the height of the Bounds (the distance from its top edge to its bottom edge)

Value Members

  1. lazy val bottom: Double

    the y coordinate of the bottom edge of the Bounds

  2. def contains(pos: Pos): Boolean

    Determines if the given Pos is within the bounds.

    Determines if the given Pos is within the bounds. For that to be the case, the Pos object’s x needs to be between the left edge (inclusive) and the right edge (exclusive) and its y needs to be betewen the top edge (inclusive) and the bottom edge (exclusive).

  3. def contains(x: Double, y: Double): Boolean

    Determines if the given pair of coordinates is within the bounds.

    Determines if the given pair of coordinates is within the bounds. For that to be the case, the given x needs to be between the left edge (inclusive) and the right edge (exclusive) and the given y needs to be betewen the top edge (inclusive) and the bottom edge (exclusive).

  4. val height: Double
  5. val left: Double
  6. lazy val pos: Pos

    the coordinates of the top left-hand corner of the Bounds

  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. lazy val right: Double

    the x coordinate of the right edge of the Bounds

  9. def toString: String

    Returns a textual description of the bounds.

    Returns a textual description of the bounds.

    Definition Classes
    Bounds → AnyRef → Any
  10. val top: Double
  11. val width: Double