CPCloudImage
Attributes
- Source:
- CPCloudImage.scala
- Graph
- Supertypes
- Self type
- CPCloudImage.type
Members list
Value members
Inherited methods
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
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
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
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 typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
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
- CPGameObject -> Any
- Inherited from:
- CPGameObject
- Source:
- CPGameObject.scala
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
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
Gets image dimension.
Gets image dimension.
Attributes
- Definition Classes
- Inherited from:
- CPArrayImage
- Source:
- CPArrayImage.scala
Shortcut to get image height.
Gets unique ID of this game object.
Gets pixel at the given XY-coordinate.
Gets pixel at the given XY-coordinate.
Attributes
- Definition Classes
- Inherited from:
- CPArrayImage
- Source:
- CPArrayImage.scala
Gets rectangle shape of this image.
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
Shortcut to get image width.
Shortcut to get image height.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Converts this image into 2D array of pixels.
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
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
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
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
Shortcut to get image width.
Inherited fields
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
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