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
  • Anchor
  • HasAnchor
  • HasContainer
  • HasEdges
  • HasPos
  • HasSize
  • HasVelocity
  • mutable

trait HasEdges extends HasPos with HasAnchor

A supertype for objects that take up a rectangular area and have an anchoring point. The object’s pos indicates the position of the anchoring point; the locations of its edges are determined relative to the anchor.

Linear Supertypes
HasAnchor, HasSize, HasPos, AnyRef, Any
Known Subclasses
HasContainer, ContainedObject, MovingObjectInContainer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasEdges
  2. HasAnchor
  3. HasSize
  4. HasPos
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def height: Double

    this object’s height: the distance from its top edge to its bottom edge

    this object’s height: the distance from its top edge to its bottom edge

    Definition Classes
    HasSize
  2. abstract def pos: Pos

    the object’s location

    the object’s location

    Definition Classes
    HasPos
  3. abstract def width: Double

    this object’s width: the distance from its left edge to its right edge

    this object’s width: the distance from its left edge to its right edge

    Definition Classes
    HasSize

Concrete Value Members

  1. def anchor: Anchor

    Returns the object’s anchoring point, which is Anchor.Center unless overridden.

    Returns the object’s anchoring point, which is Anchor.Center unless overridden.

    Definition Classes
    HasEdges → HasAnchor
  2. def bottom: Double

    Returns the y coordinate of the bottom edge.

  3. def bottomLeft: Pos

    Returns the coordinates of this object’s bottom left-hand corner.

  4. def bottomRight: Pos

    Returns the coordinates of this object’s bottom right-hand corner.

  5. def center: Pos

    Returns the average position between this object’s edges.

  6. def centerFromTopLeft: Pos

    the location of this object’s center: the average point between its edges, expressed in coordinates relative to the object’s top left-hand corner

    the location of this object’s center: the average point between its edges, expressed in coordinates relative to the object’s top left-hand corner

    Definition Classes
    HasSize
  7. def clampWhollyInside(container: HasEdges, desiredPosition: Pos = this.pos): Pos

    Looks for a position for this object that is as close to possible to a particular target position but keeps the object's edges within the bounds of the given other object.

    Looks for a position for this object that is as close to possible to a particular target position but keeps the object's edges within the bounds of the given other object.

    container

    another object that sets the boundaries for the return value

    desiredPosition

    the ideal position for this object (defaults to its current pos)

    returns

    the location closest to desiredPosition where this object’s anchor can be placed without its edges extending beyond container

  8. def clampXWhollyInside(container: HasEdges, desiredPosition: Pos = this.pos): Pos

    Looks for a position for this object that is as close to possible to a particular target position but keeps the left and right edges of the object within the bounds of the given other object.

    Looks for a position for this object that is as close to possible to a particular target position but keeps the left and right edges of the object within the bounds of the given other object.

    container

    another object that sets the boundaries for the return value

    desiredPosition

    the ideal position for this object (defaults to its current pos)

    returns

    the location closest to desiredPosition where this object’s anchor can be placed without its left or right edge extending beyond container

  9. def clampYWhollyInside(container: HasEdges, desiredPosition: Pos = this.pos): Pos

    Looks for a position for this object that is as close to possible to a particular target position but keeps the top and bottom edges of the object within the bounds of the given other object.

    Looks for a position for this object that is as close to possible to a particular target position but keeps the top and bottom edges of the object within the bounds of the given other object.

    container

    another object that sets the boundaries for the return value

    desiredPosition

    the ideal position for this object (defaults to its current pos)

    returns

    the location closest to desiredPosition where this object’s anchor can be placed without its top or bottom edge extending beyond container

  10. def closestPosTo(target: Pos): Pos

    Returns the position within this object’s edges that is as close as possible to the given position.

  11. def containsBetweenEdges(candidate: Pos): Boolean

    Determines whether the given Pos’s x coordinate is between this object’s left edge (inclusive) and its right edge (exclusive) and if it’s y coordinate is similarly between the top and bottom edges.

  12. def distance(another: HasPos): Double

    Determines the distance (“as the crow flies”) between this object’s pos and that of the given object.

    Determines the distance (“as the crow flies”) between this object’s pos and that of the given object.

    Definition Classes
    HasPos
  13. def internalAnchorPos: Pos

    Returns the Pos of the anchoring point within this object, expressed as coordinates relative to the object’s top left-hand corner.

    Returns the Pos of the anchoring point within this object, expressed as coordinates relative to the object’s top left-hand corner.

    Definition Classes
    HasAnchor
  14. def internalAnchorX: Double

    Returns the x coordinate of the anchoring point within this object, relative to the object’s left edge.

    Returns the x coordinate of the anchoring point within this object, relative to the object’s left edge.

    Definition Classes
    HasAnchor
  15. def internalAnchorY: Double

    Returns the y coordinate of the anchoring point within this object, relative to the object’s top edge.

    Returns the y coordinate of the anchoring point within this object, relative to the object’s top edge.

    Definition Classes
    HasAnchor
  16. def left: Double

    Returns the x coordinate of this object’s left edge.

  17. def right: Double

    Returns the x coordinate of the right edge.

  18. def top: Double

    Returns the y coordinate of the top edge.

  19. def topLeft: Pos

    Returns the coordinates of this object’s top left-hand corner.

  20. def topRight: Pos

    Returns the coordinates of this object’s top right-hand corner.