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
  • object Anchor

    This companion object of class Anchor contains a number of standard anchors (TopLeft, Center, etc.) and a class for creating anchors in a custom location.

    This companion object of class Anchor contains a number of standard anchors (TopLeft, Center, etc.) and a class for creating anchors in a custom location.

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

    Definition Classes
    objects
    See also

    HasAnchor

  • Absolute
  • BottomCenter
  • BottomLeft
  • BottomRight
  • Center
  • CenterLeft
  • CenterRight
  • TopCenter
  • TopLeft
  • TopRight

case class Absolute(deltaFromTopLeft: Pos) extends Anchor with Simple with Product with Serializable

An anchor at a custom Pos.

deltaFromTopLeft

the Pos of the anchor within the anchored object, relative to the object’s top left-hand corner

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

Instance Constructors

  1. new Absolute(deltaFromTopLeft: Pos)

    deltaFromTopLeft

    the Pos of the anchor within the anchored object, relative to the object’s top left-hand corner

Value Members

  1. def internalPosWithin(anchored: HasAnchor): Pos

    Returns the Pos of the anchoring point within the given Pic or other anchorable object, relative to the object’s top left-hand corner.

    Returns the Pos of the anchoring point within the given Pic or other anchorable object, relative to the object’s top left-hand corner.

    Definition Classes
    Anchor
  2. def internalXWithin(anchored: HasAnchor): Double

    Returns the x coordinate of the anchoring point within the given Pic or other anchorable object, relative to the object’s left edge.

    Returns the x coordinate of the anchoring point within the given Pic or other anchorable object, relative to the object’s left edge.

    Definition Classes
    Absolute → Anchor
  3. def internalYWithin(anchored: HasAnchor): Double

    Returns the y coordinate of the anchoring point within the given Pic or other anchorable object, relative to the object’s top edge.

    Returns the y coordinate of the anchoring point within the given Pic or other anchorable object, relative to the object’s top edge.

    Definition Classes
    Absolute → Anchor
  4. def productElementNames: Iterator[String]
    Definition Classes
    Product
  5. def toAbsoluteWithin(anchored: HasAnchor): Absolute

    Returns an absolute anchor the Pos of the anchoring point within the given Pic or other anchorable object, relative to the object’s top left-hand corner.

    Returns an absolute anchor the Pos of the anchoring point within the given Pic or other anchorable object, relative to the object’s top left-hand corner.

    Definition Classes
    Anchor
  6. def toString: String

    Returns a String description of the absolute anchor.

    Returns a String description of the absolute anchor.

    Definition Classes
    Absolute → AnyRef → Any