CosPlay
0.8.8
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
CosPlay/org.cosplay/CPArrayImage

CPArrayImage

org.cosplay.CPArrayImage
See theCPArrayImage companion object
class CPArrayImage(data: CPArray2D[CPPixel], origin: String) extends CPImage

An image based on two-dimensional pixel array.

This is the primary tool for creating in-code images. This class has number of constructors and companion utility methods to aid in creating in-code images in variety of ways. Here's a typical example of using this class to create an in-code image. Note the use of companion object function prepSeq():

object CPAlienImage extends CPArrayImage(
   prepSeq("""
       |    .  .
       |     \/
       |    (@@)
       | g/\_)(_/\e
       |g/\(=--=)/\e
       |    //\\
       |   _|  |_
     """),
   (ch, _, _) => ch&C_LIME
)

Attributes

data

Image data. Note that given data array should not have null values.

origin

The origin of the image like file path or URL.

Companion:
object
Source:
CPArrayImage.scala
Graph
Supertypes
class CPImage
trait CPAsset
class Object
trait Matchable
class Any
Known subtypes
object CPAardvarkImage.type
object CPAlienImage.type
object CPAlienPlanetImage.type
object CPAmigaImage.type
object CPArrowImage.type
object CPAstronaut1Image.type
object CPAstronaut2Image.type
object CPAtari2080STImage.type
object CPBananaImage.type
object CPBatImage.type
object CPBearImage.type
object CPBedImage.type
object CPBeetleImage.type
object CPBrickNImage.type
object CPBrickWImage.type
object CPCactusImage.type
object CPCalculatorImage.type
object CPCapsuleImage.type
object CPCarImage.type
object CPCastleImage.type
object CPCloudImage.type
object CPCrownImage.type
object CPCubesImage.type
object CPDogImage.type
object CPDolphinImage.type
object CPFlamingoImage.type
object CPGameBoyImage.type
object CPGingerbreadImage.type
object CPGlobeImage.type
object CPGrimReaperImage.type
object CPHelicopterImage.type
object CPIceCreamImage.type
object CPKnifeImage.type
object CPLanderImage.type
object CPMoon1Image.type
object CPMoon2Image.type
object CPMotorcycleImage.type
object CPMouseImage.type
object CPOceanLinerImage.type
object CPPlaneImage.type
object CPRocket1Image.type
object CPRocket2Image.type
object CPSatellite1Image.type
object CPSatellite2Image.type
object CPSatellite3Image.type
object CPSaturnImage.type
object CPShieldImage.type
object CPSkullImage.type
object CPSpaceShipImage.type
object CPSunGlassesImage.type
object CPSwordImage.type
object CPTelescopeImage.type
object CPTntImage.type
object CPTornadoImage.type
object CPTruckImage.type
object CPUmbrellaImage.type
object CPBikingAniImage.type
object CPBirdAniImage.type
object CPCubeAniImage.type
object CPCurveAniImage.type
object CPDancerAniImage.type
object CPHandAniImage.type
object CPPointManAniImage.type
object CPRunnerAniImage.type
object CPCircle1aImage.type
object CPCircle1bImage.type
object CPCircle1cImage.type
object CPCircle2aImage.type
object CPCircle2bImage.type
object CPCircle3Image.type
object CPCircle4Image.type
object CPCircle5Image.type
object CPCircle6Image.type
object CPCircle9Image.type

Members list

Concise view

Value members

Constructors

def this(data: CPArray2D[Char], skin: (Char, Int, Int) => CPPixel)

Creates an image from 2D array of characters.

Creates an image from 2D array of characters.

Attributes

data

Image data.

skin

Skinning function. The function takes a character, its X and Y coordinate and returns a new pixel.

Source:
CPArrayImage.scala
def this(data: Seq[String], skin: (Char, Int, Int) => CPPixel)

Creates an image from the sequence of strings.

Creates an image from the sequence of strings.

Attributes

data

Image data.

skin

Skinning function. The function takes a character, its X and Y coordinate and returns a new pixel.

Source:
CPArrayImage.scala
def this(data: String, skin: (Char, Int, Int) => CPPixel)

Creates an image from a single string.

Creates an image from a single string.

Attributes

data

Single string image data.

skin

Skinning function. The function takes a character, its X and Y coordinate and returns a new pixel.

Source:
CPArrayImage.scala
def this(px: CPPixel)

Creates a single pixel image.

Creates a single pixel image.

Attributes

px

Image pixel.

Source:
CPArrayImage.scala
def this(chArr: CPArray2D[Char], fg: CPColor, bg: Option[CPColor])

Creates an image from give 2D array of characters.

Creates an image from give 2D array of characters.

Attributes

bg

Optional background color for image pixels.

chArr

Image data.

fg

Foreground color of image pixels.

Source:
CPArrayImage.scala
def this(chArr: CPArray2D[Char], fg: CPColor)

Creates an image from give 2D array of characters without background color.

Creates an image from give 2D array of characters without background color.

Attributes

chArr

Image data.

fg

Foreground color of image pixels.

Source:
CPArrayImage.scala
def this(data: String, fg: CPColor, bg: Option[CPColor])

Creates an image from give string.

Creates an image from give string.

Attributes

bg

Optional background color for image pixels.

data

Single string image data.

fg

Foreground color of image pixels.

Source:
CPArrayImage.scala
def this(data: String, fg: CPColor)

Creates an image from give string without background color.

Creates an image from give string without background color.

Attributes

data

Single string image data.

fg

Foreground color of image pixels.

Source:
CPArrayImage.scala
def this(pxs: Seq[CPPixel])

Creates an image from given sequence of pixels.

Creates an image from given sequence of pixels.

Attributes

pxs

Sequence of pixel to create a new image from.

Source:
CPArrayImage.scala

Concrete methods

override def getDim: CPDim

Gets image dimension.

Gets image dimension.

Attributes

Definition Classes
Source:
CPArrayImage.scala
override def getPixel(x: Int, y: Int): CPPixel

Gets pixel at the given XY-coordinate.

Gets pixel at the given XY-coordinate.

Attributes

Definition Classes
Source:
CPArrayImage.scala

Inherited methods

def antialias(isBlank: CPPixel => Boolean): CPImage

Antialiases solid ASCII art image returning new image. Works only for solid ASCII art. Algorithm is loosely based on https://codegolf.stackexchange.com/questions/5450/anti-aliasing-ascii-art.

Antialiases solid ASCII art image returning new image. Works only for solid ASCII art. Algorithm is loosely based on https://codegolf.stackexchange.com/questions/5450/anti-aliasing-ascii-art.

Here's an example of antialiasing a solid ASCII art shape:

      xx  xxx  xxx                         db  <xb  <xb
     xxxx  xxx  xxx                       dxxb  Yxb  Yxb
    xxxxxx  xxx  xxx                     dxxxxb  Yxb  Yxb
   xxx  xxx  xxx  xxx                   dxx  xxb  xxb  xxb
   xxxx xxx  xxx  xxx                   Yxxb xxF  xxF  xxF
    xxxxxx  xxx  xxx                     YxxxxF  dxF  dxF
     xxxx  xxx  xxx         ===>          YxxF  dxF  dxF
   x  xx  xxx  xxx  x                   ;  YF  dxF  dxF  ;
   xx    xxx  xxx  xx                   xb    dxF  dxF  dx
   xxx  xxx  xxx  xxx                   xxb  <xF  <xF  <xx
   xxxx  xxx  xxx  xx                   xxxb  Yxb  Yxb  Yx
   xxxxx  xxx  xxx  x                   Yxxx>  Yx>  Yx>  V

Attributes

isBlank

Function to determine if given pixel is blank for the purpose of antialiasing.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def copy(skin: (CPPixel, Int, Int) => CPPixel): CPImage

Makes a deep snapshot copy of the current image.

Makes a deep snapshot copy of the current image.

Attributes

skin

Optional skin to apply when copying.

Inherited from:
CPImage
Source:
CPImage.scala
def copyRect(rect: CPRect, skin: (CPPixel, Int, Int) => CPPixel): CPImage

Makes a deep snapshot copy of the subregion of the current image.

Makes a deep snapshot copy of the subregion of the current image.

Attributes

rect

Subregion to copy.

skin

Optional skin to apply when copying.

Inherited from:
CPImage
Source:
CPImage.scala
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Inherited from:
CPGameObject
Source:
CPGameObject.scala
def exists(f: (CPPixel, Int, Int) => Boolean): Boolean

Tests if there is a pixel in this image for which given predicate would return true.

Tests if there is a pixel in this image for which given predicate would return true.

Attributes

f

Predicate to test.

Inherited from:
CPImage
Source:
CPImage.scala
def foreach(f: CPPixel => Unit): Unit

Loops over the pixels in image.

Loops over the pixels in image.

Attributes

f

Function to call on each pixel.

Inherited from:
CPImage
Source:
CPImage.scala
def getHeight: Int

Shortcut to get image height.

Shortcut to get image height.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
def getId: String

Gets unique ID of this game object.

Gets unique ID of this game object.

Attributes

Inherited from:
CPGameObject
Source:
CPGameObject.scala
def getRect: CPRect

Gets rectangle shape of this image.

Gets rectangle shape of this image.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
def getTags: Set[String]

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Attributes

See also:
Inherited from:
CPGameObject
Source:
CPGameObject.scala
def getWidth: Int

Shortcut to get image width.

Shortcut to get image width.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
def h: Int

Shortcut to get image height.

Shortcut to get image height.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
def horFlip(): CPImage

Flips this image horizontally returning a new image. Note that this method does only shallow copy and returned image will delegate to this image. Use copy method to get a full deep copy before calling this method to get a full new image.

Flips this image horizontally returning a new image. Note that this method does only shallow copy and returned image will delegate to this image. Use copy method to get a full deep copy before calling this method to get a full new image.

Attributes

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def isSameAs(img: CPImage): Boolean

Tests whether this and given images have the same dimensions and the same pixels in corresponding locations.

Tests whether this and given images have the same dimensions and the same pixels in corresponding locations.

Attributes

img

Image to test.

Inherited from:
CPImage
Source:
CPImage.scala
def loop(f: (CPPixel, Int, Int) => Unit): Unit

Loops over the pixels in image. Iteration over the pixels in this image will be horizontal first. In other words, given the pixels with the following coordinates:

Loops over the pixels in image. Iteration over the pixels in this image will be horizontal first. In other words, given the pixels with the following coordinates:

   +-----------------+
   |(0,0) (1,0) (2,0)|
   |(0,1) (1,1) (2,1)|
   |(0,2) (1,2) (2,2)|
   +-----------------+

this method will iterate in the following order:

   (0,0) (1,0) (2,0) (0,1) (1,1) (2,1) (0,2) (1,2) (2,2)

Attributes

f

Function to call on each pixel. Note that unlike standard foreach function, this function also takes pixel's XY-coordinate.

Inherited from:
CPImage
Source:
CPImage.scala
def loopHor(f: (CPPixel, Int, Int) => Unit): Unit

Loops over the pixels in image. Iteration over the pixels in this image will be horizontal first. In other words, given the pixels with the following coordinates:

Loops over the pixels in image. Iteration over the pixels in this image will be horizontal first. In other words, given the pixels with the following coordinates:

   +-----------------+
   |(0,0) (1,0) (2,0)|
   |(0,1) (1,1) (2,1)|
   |(0,2) (1,2) (2,2)|
   +-----------------+

this method will iterate in the following order:

   (0,0) (1,0) (2,0) (0,1) (1,1) (2,1) (0,2) (1,2) (2,2)

Attributes

f

Function to call on each pixel. Note that unlike standard foreach function, this function also takes pixel's XY-coordinate.

Inherited from:
CPImage
Source:
CPImage.scala
def loopVert(f: (CPPixel, Int, Int) => Unit): Unit

Loops over the pixels in image. Iteration over the pixels in this image will be vertical first. In other words, given the pixels with the following coordinates:

Loops over the pixels in image. Iteration over the pixels in this image will be vertical first. In other words, given the pixels with the following coordinates:

   +-----------------+
   |(0,0) (1,0) (2,0)|
   |(0,1) (1,1) (2,1)|
   |(0,2) (1,2) (2,2)|
   +-----------------+

this method will iterate in the following order:

   (0,0) (0,1) (0,2) (1,0) (1,1) (1,2) (2,0) (2,1) (2,2)

Attributes

f

Function to call on each pixel. Note that unlike standard foreach function, this function also takes pixel's XY-coordinate.

Inherited from:
CPImage
Source:
CPImage.scala
def replaceBg(isBgPx: CPPixel => Boolean, replacePx: CPPixel): CPImage

Detects all background pixels and replaces them with a given pixel returning new image.

Detects all background pixels and replaces them with a given pixel returning new image.

A pixel is considered to be a background pixel when:

  • It's satisfies given predicate
  • It's not equal to given replacement pixel
  • There's a path from it to the edge of the image through background pixels only

For example, a fully enclosed area of the image containing background pixels will NOT be considered a background as there's no path to the edge of the image without crossing a non-background pixels.

Attributes

isBgPx

Predicate determining if given pixel is a background pixel.

replacePx

Pixel to replace the detected background pixels.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def resizeByDim(newDim: CPDim, bgPx: CPPixel): CPImage

Crops and centers the image returning a new image instance. Given dimension can be bigger or smaller.

Crops and centers the image returning a new image instance. Given dimension can be bigger or smaller.

Attributes

bgPx

Background pixel in case of bigger dimension. Default value is CPPixel.XRAY.

newDim

Dimension to crop by.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def resizeByInsets(insets: CPInsets, bgPx: CPPixel): CPImage

Crops this image using given insets. Insets can be positive or negative.

Crops this image using given insets. Insets can be positive or negative.

Attributes

bgPx

Background pixel in case of bigger dimension. Default value is CPPixel.XRAY.

insets

Insets to crop by.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def saveRexCsv(file: File, bg: CPColor): Unit

Saves this image in REXPaint CSV format.

Saves this image in REXPaint CSV format.

Attributes

bg

Background color to replace in pixels with no background.

file

File instance.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def saveRexCsv(path: String, bg: CPColor): Unit

Saves this image in REXPaint CSV format.

Saves this image in REXPaint CSV format.

Attributes

bg

Background color to replace in pixels with no background.

path

Local file path.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def saveRexXp(file: File, bg: CPColor): Unit

Saves this image in REXPaint XP format. Note that this is a native format used by REXPaint and images in this format can be loaded by REXPaint for editing.

Saves this image in REXPaint XP format. Note that this is a native format used by REXPaint and images in this format can be loaded by REXPaint for editing.

Attributes

bg

Background color to set in pixels that have no background defined.

file

File instance.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def saveRexXp(path: String, bg: CPColor): Unit

Saves this image in REXPaint XP format.

Saves this image in REXPaint XP format.

Attributes

bg

Background color to replace in pixels with no background.

path

Local file path.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def saveTxt(path: String): Unit

Saves this image in *.txt format. Note that this format does not retain the color information.

Saves this image in *.txt format. Note that this format does not retain the color information.

Attributes

path

Local file path.

Inherited from:
CPImage
Source:
CPImage.scala
def saveTxt(file: File): Unit

Saves this image in *.txt format. Note that this format does not retain the color information.

Saves this image in *.txt format. Note that this format does not retain the color information.

Attributes

file

File instance.

Inherited from:
CPImage
Source:
CPImage.scala
def skin(f: (CPPixel, Int, Int) => CPPixel): CPImage

Creates shallow copy of this image with given skin function. Note that this method will wrap this image and delegate to it instead of creating a full copy of the image. To make a deep copy use copy method.

Creates shallow copy of this image with given skin function. Note that this method will wrap this image and delegate to it instead of creating a full copy of the image. To make a deep copy use copy method.

Attributes

f

Skinning function. The function takes an existing pixel, its X and Y coordinate and return a new pixel.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def split(w: Int, h: Int): Seq[CPImage]

Splits this image into sequence of [w,h] images.

Splits this image into sequence of [w,h] images.

Attributes

h

Split height.

w

Split width.

Inherited from:
CPImage
Source:
CPImage.scala
def stitchBelow(img: CPImage, bgPx: CPPixel): CPImage

Attaches given image underneath this image returning a new combined image.

Attaches given image underneath this image returning a new combined image.

Attributes

bgPx

Background pixel to use when combined image has large width.

img

Image to attached.

Inherited from:
CPImage
Source:
CPImage.scala
def stitchRight(img: CPImage, bgPx: CPPixel): CPImage

Attaches given image to the right of this image returning a new combined image.

Attaches given image to the right of this image returning a new combined image.

Attributes

bgPx

Background pixel to use when combined image has large height.

img

Image to attached.

Inherited from:
CPImage
Source:
CPImage.scala
def toArray2D: CPArray2D[CPPixel]

Converts this image into 2D array of pixels.

Converts this image into 2D array of pixels.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
def trim(isBlank: CPPixel => Boolean): CPImage

Trims blank rows and columns from this image returning a new, trimmed image.

Trims blank rows and columns from this image returning a new, trimmed image.

Attributes

isBlank

Function to determine if an individual pixel is blank. Row or column is blank if all of its pixels satisfy this predicate.

Inherited from:
CPImage
Source:
CPImage.scala
def trimBg(isBgPx: CPPixel => Boolean): CPImage

A shortcut method that detects background pixels and replaces them with CPPixel.XRAY returning a new image. This effectively makes the background transparent.

A shortcut method that detects background pixels and replaces them with CPPixel.XRAY returning a new image. This effectively makes the background transparent.

This is equivalent to:

   replaceBg(isBgPx, CPPixel.XRAY)

Attributes

isBgPx

Predicate determining if given pixel is a background pixel.

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def trimBg(): CPImage

A shortcut method that considers all pixels with ' ' (space) character as background pixels and replaces them with CPPixel.XRAY returning a new image. This effectively makes the background transparent.

A shortcut method that considers all pixels with ' ' (space) character as background pixels and replaces them with CPPixel.XRAY returning a new image. This effectively makes the background transparent.

This is equivalent to:

   replaceBg(_.char == ' ', CPPixel.XRAY)

Attributes

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def verFlip(): CPImage

Flips this image vertically returning a new image. Note that this method does only shallow copy and returned image will delegate to this image. Use copy method to get a full deep copy before calling this method to get a full new image.

Flips this image vertically returning a new image. Note that this method does only shallow copy and returned image will delegate to this image. Use copy method to get a full deep copy before calling this method to get a full new image.

Attributes

See also:
Inherited from:
CPImage
Source:
CPImage.scala
def w: Int

Shortcut to get image width.

Shortcut to get image width.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala

Inherited fields

override val getOrigin: String

Gets the origin of this asset. Typically, this should be a URL, file name or class name for in-code assets like array images, animations or system font.

Gets the origin of this asset. Typically, this should be a URL, file name or class name for in-code assets like array images, animations or system font.

Attributes

Inherited from:
CPImage
Source:
CPImage.scala
override val toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Inherited from:
CPImage
Source:
CPImage.scala
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL