Each instance of this class represents a picture: an immutable two-dimensional image.
You don’t instantiate Pic directly; instead, you create Pics with the methods on the Pic companion object. For instance, you can:
- load existing images:
Pic("mypic.png")orPic("http://address.of/mypic.png")), - create
Pics of shapes (e.g.,circle(150, Red)orstar(100, Black)); or - generate the pixels of a
Picwith a function.
Moreover, many of the methods of a Pic object create and return new Pics that represent combinations or transformations of existing Pics.
This class has an alias in the top-level package o1, so it’s accessible to students simply via import o1.*.
The examples below illustrate a few of the methods (assuming the above import):
val background = rectangle(400, 300, Red)
val rotatedSquare = square(50, Blue).clockwise(30)
val squareAgainstBg = background.place(rotatedSquare, Pos(100, 100))
squareAgainstBg.show()
val ladybug = Pic("ladybug.png").scaleTo(100).flipHorizontal
val combination = circle(100, Red).leftOf(ladybug)
val part = combination.crop(Pos(10, 10), 180, 80)
val negative = part.transformColors( _.negative )
negative.show()
Some of the methods of a Pic that use Pos objects or plain x and y coordinates to indicate positions within the Pic (e.g., place and crop above). All these methods consider the origo to be at the top left-hand corner or the Pic, with x values increasing downwards and y values rightwards. The coordinates are in pixels.
Each image has an anchor that defines where it connects to other Pics. By default, the anchor is Center; for example, the place method call above puts the center of the square at Pos(100, 100) within the background.
Here is a list of the main types of operations as methods on a Pic, and examples of each type:
-
Combining
Pics by positioning them relative to each other:above,below,leftOf,rightOf,onto,against,place. -
Rotations (*):
clockwise,counterclockwise -
Changing size (*):
scaleBy,scaleTo -
Selecting and moving pixels (**):
crop,shift,flipHorizontal,flipVertical -
Examining and manipulating individual pixels (**):
pixelColor,transformXY,transformColors,combine -
Convenience methods for experimentation and debugging:
show,hide.
Notes on implementation and efficiency:
Internally, a Pic stores its contents either as vector-based graphics, as a bitmap (raster), or as a combination of the two. By design, that internal representation is meant to be largely opaque to the user of the Pic class: students in O1 working on O1’s standard assignments generally shouldn’t need to know or care about it. Nevertheless, whether a particular Pic is stored in vector or bitmap form does have very substantial effect on efficiency in some contexts; Pic, like the rest of O1Library, is not designed for high-performance graphics.
Some users of this class may wish to know the following:
-
Pics start out in either vector form or bitmap form, depending on which method created them. Specifically, the shape-creating methods (likerectangleandcircle). producePics in vector form. -
No operation on a
Picever changes an already rasterized bitmap into vector graphics. (An operation such asleftOfcan produce anPicthat is stored as a combination of a vector graphic and a bitmap.) -
Some operations always produce a rasterized
Pic. These are marked with a double asterisk (**) in the list above. Some operations sometimes produce rasterizedPics but may retain the vector-based representation in simple cases. These are marked with a single asterisk (*). -
You can call freeze to force rasterization.
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Combines this Pic and the given one so that this Pic appears immediately above the other Pic. The combined Pic will be large enough to fit both originals.
Combines this Pic and the given one so that this Pic appears immediately above the other Pic. The combined Pic will be large enough to fit both originals.
Parameters
- align
-
how to align the original
Pics horizontally in case they have different widths; this optional parameter defaults to Align.HMiddle (that is, centered alignment) - gap
-
how many empty pixels to leave between the two
Pics; defaults to zero - lowerPic
-
the
Picthat is below thisPicin the combination - retainAnchor
-
truemeans that the anchor of the combination should be equally far from the top left-hand corner as thisPic’s anchor is;false(the default) means that the combination should follow the same general anchoring policy has thisPic(e.g., to anchor from its center). If unspecified, defaults tofalse.
Attributes
- Returns
-
the combined
Pic - See also
An Anchor.Absolute that points to the same spot in the Pic that the Pic’s current anchor does.
An Anchor.Absolute that points to the same spot in the Pic that the Pic’s current anchor does.
Attributes
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against anchors this Pic at its default anchor to a specific Pos in the background.
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against anchors this Pic at its default anchor to a specific Pos in the background.
Parameters
- at
-
the point within
backgroundthat thisPic’s anchor is positioned at - background
-
a
Picthat serves as a background for this one and determines the size of the visible part of the resulting image
Attributes
- Returns
-
the combined
Pic - See also
-
onto, which does the same but doesn’t leave out the “hanging” parts of the foreground imageplace, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against uses the given Anchor instead of this Pics default anchor and places it at a specific Pos in the background.
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against uses the given Anchor instead of this Pics default anchor and places it at a specific Pos in the background.
Parameters
- at
-
the point within
backgroundthat thisPicis positioned at - background
-
a
Picthat serves as a background for this one and determines the size of the visible part of the resulting image - my
-
the point within this
Picthat will be placed at the given coordinates
Attributes
- Returns
-
the combined
Pic - See also
-
onto, which does the same but doesn’t leave out the “hanging” parts of the foreground imageplace, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against uses the given Anchors instead of the default anchor of either of the original Pics.
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against uses the given Anchors instead of the default anchor of either of the original Pics.
Parameters
- atIts
-
the point within
backgroundthat thisPicis positioned at - background
-
a
Picthat serves as a background for this one and determines the size of the visible part of the resulting image - my
-
the point within this
Picthat will be placed at the given coordinates
Attributes
- Returns
-
the combined
Pic - See also
-
onto, which does the same but doesn’t leave out the “hanging” parts of the foreground imageplace, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against anchors this Pic at its default anchor to an anchor in the background.
Combines this Pic and the given one so that the other Pic serves as a background and this Pic appears in front of it but not beyond its borders. The visible part of the combined Pic is the size of the background Pic. In the combination, some or even none of this Pic is visible in front of the background, depending on the relative positioning and dimensions of the two images; any parts of this Pic that don’t fit against the background are left out. (The left-out parts are still part of the Pic’s data but not visible; only the part within the framing background image will be shown when the Pic is rendered onscreen.) This version of against anchors this Pic at its default anchor to an anchor in the background.
Parameters
- atIts
-
the point within
backgroundthat thisPic’s anchor is positioned at; if unspecified, defaults to Center - background
-
a
Picthat serves as a background for this one and determines the size of the visible part of the resulting image
Attributes
- Returns
-
the combined
Pic - See also
-
onto, which does the same but doesn’t leave out the “hanging” parts of the foreground imageplace, which does the same but switches the order of the twoPics
Combines copies of this Pic and another Pic so that they alternate in a vertical column (starting with this Pic). The combined Pic will be large enough to fit all the copies.
Combines copies of this Pic and another Pic so that they alternate in a vertical column (starting with this Pic). The combined Pic will be large enough to fit all the copies.
Parameters
- number
-
the total number of
Pics in the column (e.g.,6means the result has three copies of eachPic)
Attributes
- See also
Combines copies of this Pic and another Pic so that they alternate in a horizontal row (starting with this Pic). The combined Pic will be large enough to fit all the copies.
Combines copies of this Pic and another Pic so that they alternate in a horizontal row (starting with this Pic). The combined Pic will be large enough to fit all the copies.
Parameters
- number
-
the total number of
Pics in the row (e.g.,6means the result has three copies of eachPic)
Attributes
- See also
Anchors the Pic at the given position.
Anchors the Pic at the given position.
Parameters
- anchor
-
a new anchoring position
Attributes
- Returns
-
a new
Picthat’s identical to the original but anchored at the given position
Returns the color of the pixel at the given coordinates within the image. (This is equivalent to calling pixelColor.)
Returns the color of the pixel at the given coordinates within the image. (This is equivalent to calling pixelColor.)
The given position must be within the image’s bounds; an out-of-bounds error will occur otherwise.
N.B. This is inefficient on a Pic that’s not fully rasterized as a bitmap. If you have a vector graphic and need to call this method many times, consider freezing the Pic first.
Attributes
Returns the color of the pixel at the given coordinates within the image. (This is equivalent to calling pixelColor.)
Returns the color of the pixel at the given coordinates within the image. (This is equivalent to calling pixelColor.)
The given position must be within the image’s bounds; an out-of-bounds error will occur otherwise.
N.B. This is inefficient on a Pic that’s not fully rasterized as a bitmap. If you have a vector graphic and need to call this method many times, consider freezing the Pic first.
Attributes
Combines this Pic and the given one so that this Pic appears immediately below the other Pic. The combined Pic will be large enough to fit both originals.
Combines this Pic and the given one so that this Pic appears immediately below the other Pic. The combined Pic will be large enough to fit both originals.
Parameters
- abovePic
-
the
Picthat is above thisPicin the combination - align
-
how to align the original
Pics horizontally in case they have different widths; this optional parameter defaults to Align.HMiddle (that is, centered alignment) - gap
-
how many empty pixels to leave between the two
Pics; defaults to zero - retainAnchor
-
truemeans that the anchor of the combination should be equally far from the top left-hand corner as thisPic’s anchor is;false(the default) means that the combination should follow the same general anchoring policy has thisPic(e.g., to anchor from its center). If unspecified, defaults tofalse.
Attributes
- Returns
-
the combined
Pic - See also
Creates a version of this Pic that’s rotated clockwise around its center. The resulting image is sized so that the entire contents of the original Pic are visible; any empty space in the corners is Transparent.
Creates a version of this Pic that’s rotated clockwise around its center. The resulting image is sized so that the entire contents of the original Pic are visible; any empty space in the corners is Transparent.
Parameters
- degrees
-
the amount of clockwise rotation, in degrees; if unspecified, defaults to 90.0
Attributes
- Returns
-
a new
Picthat is a rotated version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Combines copies of this Pic so that they appear in a vertical column. The combined Pic will be large enough to fit all the copies.
Combines copies of this Pic so that they appear in a vertical column. The combined Pic will be large enough to fit all the copies.
Parameters
- number
-
the number of copies in the column (e.g.,
3means the result has three identical images)
Attributes
- See also
Creates a new Pic by combining this Pic with the given one on a pixel-by-pixel basis. For each pair of pixel coordinates in the two original Pics, combine calls the given function to compute the color of the corresponding pixel in the new Pic. The new Pic’s width equals the lesser of the two originals’ widths; the same goes for height.
Creates a new Pic by combining this Pic with the given one on a pixel-by-pixel basis. For each pair of pixel coordinates in the two original Pics, combine calls the given function to compute the color of the corresponding pixel in the new Pic. The new Pic’s width equals the lesser of the two originals’ widths; the same goes for height.
Parameters
- determinePixel
-
a function generates a pixel for the combination, given two pixel colors from the same location in the originals
Attributes
- Returns
-
the new (bitmap) image obtained by calling
determinePixeland putting together the outputs
Determines if the given Pos is within this Pic’s borders. For that to be the case, the Pos object’s x needs to be between zero (inclusive) and this Pic’s width (exclusive) and its y needs to be between zero (inclusive) and this Pic’s height (exclusive).
Determines if the given Pos is within this Pic’s borders. For that to be the case, the Pos object’s x needs to be between zero (inclusive) and this Pic’s width (exclusive) and its y needs to be between zero (inclusive) and this Pic’s height (exclusive).
Attributes
Creates a version of this Pic that’s rotated counterclockwise around its center. The resulting image is sized so that the entire contents of the original Pic are visible; any empty space in the corners is Transparent.
Creates a version of this Pic that’s rotated counterclockwise around its center. The resulting image is sized so that the entire contents of the original Pic are visible; any empty space in the corners is Transparent.
Parameters
- degrees
-
the amount of counterclockwise rotation, in degrees; if unspecified, defaults to 90.0
Attributes
- Returns
-
a new
Picthat is a rotated version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Returns a partial Pic of a rectangular area within this Pic.
Returns a partial Pic of a rectangular area within this Pic.
Parameters
- boundary
-
the cropping frame within this
Pic
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a part of the original
Returns a partial Pic of a rectangular area within this Pic.
Returns a partial Pic of a rectangular area within this Pic.
Parameters
- bottomRight
-
the cropping frame’s bottom-right corner within this
Pic; this point must not be outside thePic - topLeft
-
the cropping frame’s top-left corner within this
Pic; this point must not be outside thePic
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a part of the original
Returns a partial Pic of a rectangular area within this Pic.
Returns a partial Pic of a rectangular area within this Pic.
Parameters
- height
-
the height of the cropping frame
- topLeft
-
the cropping frame’s top-left corner within this
Pic - width
-
the width of the cropping frame
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a part of the original
Returns a partial Pic of a rectangular area within this Pic.
Returns a partial Pic of a rectangular area within this Pic.
Parameters
- height
-
the height of the cropping frame
- width
-
the width of the cropping frame
- x
-
the x coordinate of the cropping frame’s left edge within this
Pic - y
-
the y coordinate of the cropping frame’s top edge within this
Pic
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a part of the original
Creates a mirrored version of this Pic: what’s in each corner of the original is in the opposite corner of the resulting Pic.
Creates a mirrored version of this Pic: what’s in each corner of the original is in the opposite corner of the resulting Pic.
Attributes
- Returns
-
a new
Pic(a bitmap) that is a flipped version of this one
Creates a mirrored version of this Pic: what’s on the left in the original is on the right in the resulting Pic and vice versa.
Creates a mirrored version of this Pic: what’s on the left in the original is on the right in the resulting Pic and vice versa.
Attributes
- Returns
-
a new
Pic(a bitmap) that is a flipped version of this one
Creates a mirrored version of this Pic: what’s at the top in the original is at the bottom in the resulting Pic and vice versa.
Creates a mirrored version of this Pic: what’s at the top in the original is at the bottom in the resulting Pic and vice versa.
Attributes
- Returns
-
a new
Pic(a bitmap) that is a flipped version of this one
Forces rasterization of any vector graphics in this Pic’s internal representation into bitmap form. See the introduction to this class for more information.
Forces rasterization of any vector graphics in this Pic’s internal representation into bitmap form. See the introduction to this class for more information.
Attributes
- Returns
-
the same picture, stored entirely in bitmap form
- See also
Hides the window that has been created (with show) to display the Pic. If there is no such window, does nothing.
Indicates whether this Pic is internally stored as a bitmap raster. See the introduction to this class for more information.
Indicates whether this Pic is internally stored as a bitmap raster. See the introduction to this class for more information.
Attributes
- Returns
-
trueif the entirePicis rasterized as a bitmap;falseif thePic’s internal representation uses any vector graphics - See also
Combines this Pic and the given one so that this Pic appears immediately to the left the other Pic. The combined Pic will be large enough to fit both originals.
Combines this Pic and the given one so that this Pic appears immediately to the left the other Pic. The combined Pic will be large enough to fit both originals.
Parameters
- align
-
how to align the original
Pics vertically in case they have different heights; this optional parameter defaults to Align.VMiddle (that is, centered alignment) - gap
-
how many empty pixels to leave between the two
Pics; defaults to zero - retainAnchor
-
truemeans that the anchor of the combination should be equally far from the top left-hand corner as thisPic’s anchor is;false(the default) means that the combination should follow the same general anchoring policy has thisPic(e.g., to anchor from its center). If unspecified, defaults tofalse. - rightPic
-
the
Picthat is to the right of thisPicin the combination
Attributes
- Returns
-
the combined
Pic - See also
Combines this Pic and the given one so that this Pic appears in front of the other Pic. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto uses the given Anchors instead of the default anchor of either of the original Pics.
Combines this Pic and the given one so that this Pic appears in front of the other Pic. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto uses the given Anchors instead of the default anchor of either of the original Pics.
Parameters
- atIts
-
the point within
backPicthat thisPicis positioned at - backPic
-
the
Picthat is behind this one in the combination - my
-
the point within this
Picthat will be placed atatIts
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but leaves out any “hanging” parts of the foreground image
Combines this Pic and the given one so that this Pic appears in front of the other Pic. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto anchors this Pic from its default anchor to an anchor in the other image.
Combines this Pic and the given one so that this Pic appears in front of the other Pic. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto anchors this Pic from its default anchor to an anchor in the other image.
Parameters
- atIts
-
the point within
backPicthat thisPic’s anchor is positioned at; if unspecified, defaults to Center - backPic
-
the
Picthat is behind this one in the combination
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but leaves out any “hanging” parts of the foreground image
Combines this Pic and the given one so that this Pic appears in front of the other Pic at specific coordinates. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto anchors this Pic at its default anchor.
Combines this Pic and the given one so that this Pic appears in front of the other Pic at specific coordinates. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto anchors this Pic at its default anchor.
Parameters
- at
-
the point within
backPicthat thisPic’s anchor is positioned at - backPic
-
the
Picthat is behind this one in the combination
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but leaves out any “hanging” parts of the foreground image
Combines this Pic and the given one so that this Pic appears in front of the other Pic at specific coordinates. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto uses the given Anchor instead of this Pics default anchor.
Combines this Pic and the given one so that this Pic appears in front of the other Pic at specific coordinates. The combined Pic will be larger than either of the two originals unless this Pic fits completely in front of the other one. This version of onto uses the given Anchor instead of this Pics default anchor.
Parameters
- at
-
the point within
backPicthat thisPicis positioned at - backPic
-
the
Picthat is behind this one in the combination - my
-
the point within this
Picthat will be placed at the given coordinates
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but leaves out any “hanging” parts of the foreground image
Returns the color of the pixel at the given position within the image.
Returns the color of the pixel at the given position within the image.
The given position must be within the image’s bounds; an out-of-bounds error will occur otherwise.
N.B. This is inefficient on a Pic that’s not fully rasterized as a bitmap. If you have a vector graphic and need to call this method many times, consider freezing the Pic first.
Attributes
Returns the color of the pixel at the given coordinates within the image.
Returns the color of the pixel at the given coordinates within the image.
The given position must be within the image’s bounds; an out-of-bounds error will occur otherwise.
N.B. This is inefficient on a Pic that’s not fully rasterized as a bitmap. If you have a vector graphic and need to call this method many times, consider freezing the Pic first.
Attributes
Returns the color of the pixel at the given coordinates within the image.
Returns the color of the pixel at the given coordinates within the image.
The given position must be within the image’s bounds; an out-of-bounds error will occur otherwise.
N.B. This is inefficient on a Pic that’s not fully rasterized as a bitmap. If you have a vector graphic and need to call this method many times, consider freezing the Pic first.
Attributes
Returns the colors of the pixels in this Pic that are “near” a given Pos. A pixel counts as being near if it’s located at a Pos whose distance from the given Pos is less than or equal to the given range. This includes the pixel at the given Pos (if there is one).
Returns the colors of the pixels in this Pic that are “near” a given Pos. A pixel counts as being near if it’s located at a Pos whose distance from the given Pos is less than or equal to the given range. This includes the pixel at the given Pos (if there is one).
Distances are measured between the “centers” of the two pixels. For example, if pixel A is three pixels right and four pixels down pixel B, then their distance is five.
Parameters
- pos
-
a position whose nearby pixels in this
Picwill be returned - range
-
the maximum distance of a returned pixel from
pos(must be non-negative)
Attributes
- Returns
-
a collection of the pixel colors, in arbitrary order
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place uses the given Anchor instead of the other Pics default anchor and places it at a specific Pos in this background.
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place uses the given Anchor instead of the other Pics default anchor and places it at a specific Pos in this background.
Parameters
- at
-
the point within this
Picthatforegroundwill be placed at - foreground
-
the
Picthat will be placed against this background - its
-
the point within
foregroundthat will be placed at the given coordinates
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place uses the given Anchors instead of the default anchor of either of the original Pics.
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place uses the given Anchors instead of the default anchor of either of the original Pics.
Parameters
- atMy
-
the point within this
Picthatforegroundwill be placed at - foreground
-
the
Picthat will be placed against this background - its
-
the point within
foregroundthat will be placed at the given coordinates
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place anchors the other Pic at its default anchor to a specific Pos in this background.
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place anchors the other Pic at its default anchor to a specific Pos in this background.
Parameters
- at
-
the point within this
Picthatforeground’s anchor will be placed at - foreground
-
the
Picthat will be placed against this background
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but switches the order of the twoPics
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place anchors the other Pic at its default anchor to a specified anchor in this background.
Combines this Pic and the given one so that this Pic serves as a background and the other Pic appears in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. Some or even none of the other Pic is visible in front of this background, depending on the relative positioning and dimensions of the two images; any parts of the other Pic that don’t fit against this background are left out. (The left-out parts are still part of this Pic’s data but not visible; only the part within this framing background image will be shown when the Pic is rendered onscreen.) This version of place anchors the other Pic at its default anchor to a specified anchor in this background.
Parameters
- atMy
-
the point within this
Picthatforeground’s anchor will be placed at - foreground
-
the Pic` that will be placed against this background
Attributes
- Returns
-
the combined
Pic - See also
-
against, which does the same but switches the order of the twoPics
Combines this Pic and the given ones so that this Pic serves as a background and the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly.
Combines this Pic and the given ones so that this Pic serves as a background and the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly.
Parameters
- foregroundPics
-
tuples containing: (1) the
Pics that will be placed against this background; (2) the points within thisPicwhere their default anchors will be placed
Attributes
- Returns
-
the combined
Pic
Combines this Pic and the given ones so that this Pic serves as a background and the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly.
Combines this Pic and the given ones so that this Pic serves as a background and the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly.
Parameters
- foregroundPics
-
tuples containing: (1) the
Pics that will be placed against this background; (2) the points within thisPicwhere their default anchors will be placed
Attributes
- Returns
-
the combined
Pic
Combines this Pic and copies of the given one so that this Pic serves as a background and the copies of the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly, passing in the same foreground image each time.
Combines this Pic and copies of the given one so that this Pic serves as a background and the copies of the other Pics appear in front but not beyond this Pic’s borders. The visible part of the combined Pic is the size of this background Pic. This is equivalent to calling place(Pic,Pos) repeatedly, passing in the same foreground image each time.
Parameters
- at
-
the points within this
Picwhere the default anchors of the copies should be placed - foregroundPic
-
the
Pics whose copies will be placed against this background
Attributes
- Returns
-
the combined
Pic
Combines this Pic and the given one so that this Pic appears immediately to the right the other Pic. The combined Pic will be large enough to fit both originals.
Combines this Pic and the given one so that this Pic appears immediately to the right the other Pic. The combined Pic will be large enough to fit both originals.
Parameters
- align
-
how to align the original
Pics vertically in case they have different heights; this optional parameter defaults to Align.VMiddle (that is, centered alignment) - gap
-
how many empty pixels to leave between the two
Pics; defaults to zero - leftPic
-
the
Picthat is to the left of thisPicin the combination - retainAnchor
-
truemeans that the anchor of the combination should be equally far from the top left-hand corner as thisPic’s anchor is;false(the default) means that the combination should follow the same general anchoring policy has thisPic(e.g., to anchor from its center). If unspecified, defaults tofalse.
Attributes
- Returns
-
the combined
Pic - See also
Combines copies of this Pic so that they appear in a horizontal row. The combined Pic will be large enough to fit all the copies.
Combines copies of this Pic so that they appear in a horizontal row. The combined Pic will be large enough to fit all the copies.
Parameters
- number
-
the number of copies in the row (e.g.,
3means the result has three identical images)
Attributes
- See also
Creates a version of this Pic that is larger or smaller as per the given multiplier. A value between 0 and 1 produces a smaller Pic, a value above 1 a larger one. Retains the aspect ratio of the original image.
Creates a version of this Pic that is larger or smaller as per the given multiplier. A value between 0 and 1 produces a smaller Pic, a value above 1 a larger one. Retains the aspect ratio of the original image.
Parameters
- factor
-
the ratio between the sizes of the result and the original
Attributes
- Returns
-
a new
Picthat is a scaled version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Creates a scaled version of this Pic that has the given dimensions. The aspect ratio of the resulting image may be different from the original’s.
Creates a scaled version of this Pic that has the given dimensions. The aspect ratio of the resulting image may be different from the original’s.
Parameters
- targetHeight
-
the height of the output image
- targetWidth
-
the width of the output image
Attributes
- Returns
-
a new
Picthat is a scaled version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Creates a scaled version of this Pic that has the given size and is rectangular. If the original Pic isn’t rectangular, the aspect ratio of the result will be different.
Creates a scaled version of this Pic that has the given size and is rectangular. If the original Pic isn’t rectangular, the aspect ratio of the result will be different.
Parameters
- targetSize
-
the width and height of the output image
Attributes
- Returns
-
a new
Picthat is a scaled version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Creates a scaled version of this Pic that has the dimensions of the given Pic. The aspect ratio of the resulting image may be different from the original’s.
Creates a scaled version of this Pic that has the dimensions of the given Pic. The aspect ratio of the resulting image may be different from the original’s.
Parameters
- sizingPic
-
a
Picwhose width and height are given to the scaledPic
Attributes
- Returns
-
a new
Picthat is a scaled version of this one; it will usually be a bitmap, but some simple vector-basedPics may retain their vector form
Shifts each pixel within the Pic downwards by the given amount. Retains the size of the image: any pixels that would go beyond the bottom edge of the Pic instead wrap around to the top.
Shifts each pixel within the Pic downwards by the given amount. Retains the size of the image: any pixels that would go beyond the bottom edge of the Pic instead wrap around to the top.
Parameters
- offset
-
the number of pixels the image shifts down
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a shifted version of the original
Shifts each pixel within the Pic to the left by the given amount. Retains the size of the image: any pixels that would go beyond the left edge of the Pic instead wrap around to the right-hand side.
Shifts each pixel within the Pic to the left by the given amount. Retains the size of the image: any pixels that would go beyond the left edge of the Pic instead wrap around to the right-hand side.
Parameters
- offset
-
the number of pixels the image shifts to the left
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a shifted version of the original
Shifts each pixel within the Pic to the right by the given amount. Retains the size of the image: any pixels that would go beyond the right edge of the Pic instead wrap around to the left-hand side.
Shifts each pixel within the Pic to the right by the given amount. Retains the size of the image: any pixels that would go beyond the right edge of the Pic instead wrap around to the left-hand side.
Parameters
- offset
-
the number of pixels the image shifts to the right
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a shifted version of the original
Shifts each pixel within the Pic upwards by the given amount. Retains the size of the image: any pixels that would go beyond the top edge of the Pic instead wrap around to the bottom.
Shifts each pixel within the Pic upwards by the given amount. Retains the size of the image: any pixels that would go beyond the top edge of the Pic instead wrap around to the bottom.
Parameters
- offset
-
the number of pixels the image shifts up
Attributes
- Returns
-
a new
Pic(a bitmap) that contains a shifted version of the original
Displays this Pic in a minimalistic GUI window. Calling this method repeatedly on the same Pic doesn’t display multiple windows but reuses the existing one. This method is meant only for experimentation and debugging; not for GUI construction (cf. views).
Displays this Pic in a minimalistic GUI window. Calling this method repeatedly on the same Pic doesn’t display multiple windows but reuses the existing one. This method is meant only for experimentation and debugging; not for GUI construction (cf. views).
Students may alternatively use the show(pic) variant in the top-level package o1.
Parameters
- background
-
the color to appear behind the
Picin the frame (where thePicis transparent); defaults to a light gray (White70) - border
-
the width of the simple black window frame, in pixels; if unspecified, defaults to 1
Attributes
- See also
Returns a very simple string description of this Pic. Examples: — "ladybug.png" — circle-shape — "ladybug.png" (transformed) — circle-shape (transformed) — combined pic
Returns a very simple string description of this Pic. Examples: — "ladybug.png" — circle-shape — "ladybug.png" (transformed) — circle-shape (transformed) — combined pic
Attributes
- Definition Classes
Applies the given operation to each pixel in the Pic to generate a different Pic. That is, every color in the image will be replaced by another color in the generated image, as specified by the given function.
Applies the given operation to each pixel in the Pic to generate a different Pic. That is, every color in the image will be replaced by another color in the generated image, as specified by the given function.
Parameters
- transformer
-
a function that
transformColorscalls on every pixel in the image to map its color to a new one
Attributes
- Returns
-
the new (bitmap) image obtained by calling
transformerand putting together the outputs
Applies the given operation to each position in the Pic to generate a different Pic.
Applies the given operation to each position in the Pic to generate a different Pic.
Parameters
- newColorAt
-
a function that
transformXYcalls repeatedly to determine the pixels of the transformedPic
Attributes
- Returns
-
the new (bitmap) image obtained by calling
newColorAtand putting together the outputs
Sets a new limit to the history length on the Pic.
Sets a new limit to the history length on the Pic.
Parameters
- maxLength
-
a new historyLength (>= 0)
Attributes
Inherited methods
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
Attributes
- Inherited from:
- HasSize
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.
Attributes
- Inherited from:
- HasAnchor
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.
Attributes
- Inherited from:
- HasAnchor
Concrete fields
The height of the Pic in pixels.
The height of the Pic in pixels.
Attributes
A list of method names used for creating this Pic. Only the most recently applied methods are listed (up to historyLength. This method may be useful for demonstrative purposes, debugging, and/or automatic assessment.
A list of method names used for creating this Pic. Only the most recently applied methods are listed (up to historyLength. This method may be useful for demonstrative purposes, debugging, and/or automatic assessment.
Attributes
A limit on the number of historical method calls that are tracked by the Pic and available through history. Defaults to 10. Can be changed via withHistoryLength.
A limit on the number of historical method calls that are tracked by the Pic and available through history. Defaults to 10. Can be changed via withHistoryLength.
Attributes
This Pic converted to a Swing Icon.
This Pic converted to a Java AWT BufferedImage (for use in Swing GUIs).