Namespace: PixMill

File Manifest

File Manifest

File	Language	Author(s)	Copyright
boundingBox.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
canvas.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
colorTable.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
colorTools.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
defctab.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
graphicsState.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
ncsctab.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
pathDescriptor.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
pixmill.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
resenectab.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
textAttributes.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
w3cctab.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constant Registry

Function Registry

Constant Details

PixMill.CTAB_IGNORE → Integer   <read-only>

This constant is used to specify that attempts to load duplicate entries into a color table will be ignored.

PixMill.CTAB_OVERWRITE → Integer   <read-only>

This constant is used to specify that attempts to load duplicate entries into a color table will be overwrite the existing specification.

PixMill.CTAB_THROWS → Integer   <read-only>

This constant is used to specify that attempts to load duplicate entries into a color table will cause an exception to be thrown.

PixMill.DEFCTab → Object   <read-only>

This object contains a very simple color table of names and color specifications.

PixMill.GRAVITIES → Array<String>   <read-only>

This constant contains an array of possible object gravity layout locations as strings.

PixMill.LAYOUTS → Array<String>   <read-only>

This constant contains an array of possible object layout types as strings.

PixMill.NCSCTab → Object   <read-only>

This object contains a color table of names and color specifications based on the Natural Color System standard.

PixMill.ReseneCTab → Object   <read-only>

This object contains a color table of names and color specifications based on colors provided by the Resene company.

PixMill.STRETCHES → Array<String>   <read-only>

This constant contains an array of possible font stretches as strings.

PixMill.STYLES → Array<String>   <read-only>

This constant contains an array of possible font styles as strings.

PixMill.UNDERLINES → Array<String>   <read-only>

This constant contains an array of possible font underlines as strings.

PixMill.VARIANTS → Array<String>   <read-only>

This constant contains an array of possible font variants as strings.

PixMill.W3CCTab → Object   <read-only>

This object contains a color table of names and color specifications based on the W3C specification.

PixMill.WEIGHTS → Array<String>   <read-only>

This constant contains an array of possible font weights as strings.

Function Details

PixMill.colorToGrayRGBCspec(cspec) → String or Array<Number> or Null

This function converts an RGB specification to the nearest neutral tone color using the NTSC formula.

Parameters:

• cspec [String or Array<Number>] — the RGB color specification

Returns:

• [String or Array<Number> or Null] — the neutral tone RGB specification, or null if the input is invalid or unrecognizable

---

PixMill.convertCMYKACspec(type, cspec) → String or Array<Number> or Null ⇏ ArgumentError

This function converts a valid CMYKA color specification into another one of a specified type.

Parameters:

• type [String] — the type of color specification to convert to: { 'atstring','integers','floats' }
• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Array<Number> or Null] — the new CMYKA color specification, or Null if invalid

Throws:

• [ArgumentError] — if the color specification type is invalid or unrecognizable

---

PixMill.convertCMYKACspecToCMYKCspec(cspec) → String or Array<Number> or Null

This function converts a valid CMYKA color specification into an CMYK color specification by removing the trailing alpha value.

Parameters:

• cspec [String or Array<Number>] — the CMYKA color specification

Returns:

• [String or Array<Number> or Null] — the new CMYK color specification, or Null if invalid

---

PixMill.convertCMYKCspec(type, cspec) → String or Array<Number> or Null ⇏ ArgumentError

This function converts a valid CMYK color specification into another one of a specified type.

Parameters:

• type [String] — the type of color specification to convert to: { 'hashstring','integers','floats' }
• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Array<Number> or Null] — the new CMYK color specification, or Null if invalid

Throws:

• [ArgumentError] — if the color specification type is invalid or unrecognizable

---

PixMill.convertRGBACspec(type, cspec) → String or Array<Number> or Null ⇏ ArgumentError

This function converts a valid RGBA color specification into another one of a specified type.

Parameters:

• type [String] — the type of color specification to convert to: { 'atstring','integers','floats' }
• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Array<Number> or Null] — the new RGBA color specification, or Null if invalid

Throws:

• [ArgumentError] — if the color specification type is invalid or unrecognizable

---

PixMill.convertRGBACspecToRGBCspec(cspec) → String or Array<Number> or Null

This function converts a valid RGBA color specification into an RGB color specification by removing the trailing alpha value.

Parameters:

• cspec [String or Array<Number>] — the RGBA color specification

Returns:

• [String or Array<Number> or Null] — the new RGB color specification, or Null if invalid

---

PixMill.convertRGBCspec(type, cspec) → String or Array<Number> or Null ⇏ ArgumentError

This function converts a valid RGB color specification into another one of a specified type.

Parameters:

• type [String] — the type of color specification to convert to: { 'hashstring','integers','floats' }
• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Array<Number> or Null] — the new RGB color specification, or Null if invalid

Throws:

• [ArgumentError] — if the color specification type is invalid or unrecognizable

---

PixMill.extractAlphaFromCMYKACspec(cspec) → String or Number or Null

This function extracts the alpha value from a valid CMYKA color specification. The format of the value depends on the format of the original color specification.

Parameters:

• cspec [String or Array<Number>] — the CMYKA color specification

Returns:

• [String or Number or Null] — the Alpha color specification, or Null if invalid

---

PixMill.extractAlphaFromRGBACspec(cspec) → String or Number or Null

This function extracts the alpha value from a valid RGBA color specification. The format of the value depends on the format of the original color specification.

Parameters:

• cspec [String or Array<Number>] — the RGBA color specification

Returns:

• [String or Number or Null] — the Alpha color specification, or Null if invalid

---

PixMill.isGrayRGBCspec(cspec) → Boolean

This function determines if a given RGB color specification is a neutral (gray) color (R=G=B).

Parameters:

• cspec [String or Array<Number>] — the RGB color specification

Returns:

• [Boolean] — true, if the color is gray

---

PixMill.isValidCMYKACspec(cspec) → Boolean

This function determines if a given color specification is a valid CMYKA specification.

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [Boolean] — true, if the cspec is valid

---

PixMill.isValidCMYKCspec(cspec) → Boolean

This function determines if a given color specification is a valid CMYK specification.

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [Boolean] — true, if the cspec is valid

---

PixMill.isValidRGBACspec(cspec) → Boolean

This function determines if a given color specification is a valid RGBA specification.

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [Boolean] — true, if the cspec is valid

---

PixMill.isValidRGBCspec(cspec) → Boolean

This function determines if a given color specification is a valid RGB specification.

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [Boolean] — true, if the cspec is valid

---

PixMill.randomGrayRGBCspec(base, range, type) → String or Array<Number> ⇏ ArgumentError

This function creates a random neutral tone (gray) RGB color specification.

Parameters:

• base [Number] — the minimum intensity value for any of the component values <default: 0>
• range [Number] — the minimum intensity value for any of the component values <default: 255>
• type [String] — the type of color specification to create: { 'hashstring','integers','floats' } <default: 'integers'>

Returns:

• [String or Array<Number>] — the random RGB specification

Throws:

• [ArgumentError] — if base < 0, range < 0, (base+range)>255

---

PixMill.randomRGBCspec(base, range, type) → String or Array<Number> ⇏ ArgumentError

This function creates a random RGB color specification.

Parameters:

• base [Number] — the minimum intensity value for any of the component values <default: 0>
• range [Number] — the minimum intensity value for any of the component values <default: 255>
• type [String] — the type of color specification to create: { 'hashstring','integers','floats' } <default: 'integers'>

Returns:

• [String or Array<Number>] — the random RGB specification

Throws:

• [ArgumentError] — if base < 0, range < 0, (base+range)>255

---

PixMill.typeOfCMYKACspec(cspec) → String or Null

This function returns the type of the valid color specification as a string (or null, if invalid). Valid string returns are: { 'atstring','integers','floats' }

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Null] — the type of color specification

---

PixMill.typeOfCMYKCspec(cspec) → String or Null

This function returns the type of the valid color specification as a string (or null, if invalid). Valid string returns are: { 'hashstring','integers','floats' }

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Null] — the type of color specification

---

PixMill.typeOfRGBACspec(cspec) → String or Null

This function returns the type of the valid color specification as a string (or null, if invalid). Valid string returns are: { 'atstring','integers','floats' }

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Null] — the type of color specification

---

PixMill.typeOfRGBCspec(cspec) → String or Null

This function returns the type of the valid color specification as a string (or null, if invalid). Valid string returns are: { 'hashstring','integers','floats' }

Parameters:

• cspec [String or Array<Number>] — the color specification

Returns:

• [String or Null] — the type of color specification

---

Class: PixMill.BoundingBox

File Manifest

File Manifest

File	Language	Author(s)	Copyright
boundingBox.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Method Registry

Method Details

bottomleft() → Array<Number>

This method returns the bottom-left location of the bounding box as a 2-element array.

Returns:

• [Array<Number>] — the bottom-left location of the bounding box

---

bottomright() → Array<Number>

This method returns the bottom-right location of the bounding box as a 2-element array.

Returns:

• [Array<Number>] — the bottom-right location of the bounding box

---

center() → Array<Number>

This method returns the center location of the bounding box as a 2-element array.

Returns:

• [Array<Number>] — the center location of the bounding box

---

move(dx, dy) → PixMill.BoundingBox

This method moves the bounding box to a new location some distance away.

Parameters:

• dx [Number] — the offset along the x-axis to move
• dy [Number] — the offset along the y-axis to move

Returns:

• [PixMill.BoundingBox] — itself

---

moveTo(x, y) → PixMill.BoundingBox

This method moves the bounding box to a new location.

Parameters:

• x [Number] — the x-coordinate of the top-left corner
• y [Number] — the y-coordinate of the top-left corner

Returns:

• [PixMill.BoundingBox] — itself

---

moved(dx, dy) → PixMill.BoundingBox

This method creates a new bounding box based on this one, but moved some distance away

Parameters:

• dx [Number] — the offset along the x-axis to move
• dy [Number] — the offset along the y-axis to move

Returns:

• [PixMill.BoundingBox] — a new bounding box based on this box's size, but moved some distance away

---

position() → Array<Number>

This method returns the bounding box position as a 2-element array.

Returns:

• [Array<Number>] — the position of the bounding box

---

rect() → Array<Number>

This method returns the location and size of the bounding box as a 4-element array.

Returns:

• [Array<Number>] — the location and size of the bounding box

---

resize(dw, dh) → PixMill.BoundingBox ⇏ ArgumentError

This method resizes the bounding box according to specified deltas.

Parameters:

• dw [Number] — the difference in width
• dh [Number] — the difference in height

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the new calculated width or height is <0

---

resizeTo(w, h) → PixMill.BoundingBox ⇏ ArgumentError

This method resizes the bounding box.

Parameters:

• w [Number] — the new width of the bounding box
• h [Number] — the new height of the bounding box

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the new calculated width or height is <0

---

resized(w, h) → PixMill.BoundingBox ⇏ ArgumentError

This method creates a new bounding box at this box's location, but with a different size.

Parameters:

• w [Number] — the new width
• h [Number] — the new height

Returns:

• [PixMill.BoundingBox] — the new bounding box

Throws:

• [ArgumentError] — if the new calculated width or height is <0

---

setFromBox(x, y, x2, y2) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box according to its top-left and bottom-right box positions.

Parameters:

• x [Number] — the x-coordinate of the top-left corner of the bounding box
• y [Number] — the y-coordinate of the top-left corner of the bounding box
• x2 [Number] — the x-coordinate of the bottom-right corner of the bounding box
• y2 [Number] — the y-coordinate of the bottom-right corner of the bounding box

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the calculated width or height is <0

---

setFromCxyr(cx, cy, r) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box according to its center position and a radius from the center.

Parameters:

• cx [Number] — the x-coordinate of the center of the bounding box
• cy [Number] — the y-coordinate of the center of the bounding box
• r [Number] — a radius from the center point

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the calculated width or height is <0

---

setFromCxywh(cx, cy, w, h) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box according to its center position and its size.

Parameters:

• cx [Number] — the x-coordinate of the center of the bounding box
• cy [Number] — the y-coordinate of the center of the bounding box
• w [Number] — the width of the bounding box
• h [Number] — the height of the bounding box

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the width or height is <0

---

setFromCxyxryr(cx, cy, xr, yr) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box according to its center position and x-axis and y-axis radii.

Parameters:

• cx [Number] — the x-coordinate of the center of the bounding box
• cy [Number] — the y-coordinate of the center of the bounding box
• xr [Number] — an x-axis radius from the center point
• yr [Number] — an y-axis radius from the center point

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the calculated width or height is <0

---

setFromPts(pts) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box to a location and size which will contain all of the specified points in the array.

Parameters:

• pts [Variadic] — the specified points

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the specified points are invalid or unrecognizable

---

setFromXywh(x, y, w, h) → PixMill.BoundingBox ⇏ ArgumentError

This method sets the bounding box according to its top-left box position and its size.

Parameters:

• x [Number] — the x-coordinate of the top-left corner of the bounding box
• y [Number] — the y-coordinate of the top-left corner of the bounding box
• w [Number] — the width of the bounding box
• h [Number] — the height of the bounding box

Returns:

• [PixMill.BoundingBox] — itself

Throws:

• [ArgumentError] — if the width or height is <0

---

size() → Array<Number>

This method returns the bounding box size as a 2-element array.

Returns:

• [Array<Number>] — the size of the bounding box

---

toArray() → Array<Number>

This method returns an array representation of the bounding box.

Returns:

• [Array<Number>] — The array representation of the bounding box

---

toString() → String

This method returns a string representation of the bounding box.

Returns:

• [String] — The string representation of the bounding box

---

topleft() → Array<Number>

This method returns the top-left location of the bounding box as a 2-element array.

Returns:

• [Array<Number>] — the top-left location of the bounding box

---

topright() → Array<Number>

This method returns the top-right location of the bounding box as a 2-element array.

Returns:

• [Array<Number>] — the top-right location of the bounding box

---

xywh() → Array<Number>

This method returns the location and size of the bounding box as a 4-element array.

Returns:

• [Array<Number>] — the location and size of the bounding box

---

Class: PixMill.Canvas

File Manifest

File Manifest

File	Language	Author(s)	Copyright
canvas.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new PixMill.Canvas(width, height, ctab, fill)

This contructor creates the canvas and its underlying JS canvas element based on the given width and height. Initial color settings can also be provided.

Parameters:

• width [Number] — the width of the drawing surface in pixels
• height [Number] — the height of the drawing surface in pixels
• ctab [PixMill.ColorTable] — the initial color table to use with the canvas <default: null>
• fill [Color] — the initial color to fill the canvas <default: null>

---

Property Details

rootbox → PixMill.Rectangle   <read-only>

This property defines the base-level drawing surface location and dimension of the canvas.

Method Details

erase() → PixMill.Canvas

This method erases the canvas.

Returns:

• [PixMill.Canvas] — itself

---

reset() → PixMill.Canvas

This method erases the canvas and resets the associated graphics state.

Returns:

• [PixMill.Canvas] — itself

---

setid(id) → PixMill.Canvas

This method assigns a DOM id to the underlying JS canvas.

Parameters:

• id [String] — the DOM ID

Returns:

• [PixMill.Canvas] — itself

---

Class: PixMill.Circle ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Circle(properties) ⇏ RuntimeError

This constructor constructs a circle marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the circle
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• r [Number] — the radius of the circle
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the circle <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, r, scale, gs)   <overload>

This overload method sets the properties of the the Circle marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• r [Number] — the radius of the circle
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.ColorTable

File Manifest

File Manifest

File	Language	Author(s)	Copyright
colorTable.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.ColorTable(source) ⇏ ArgumentError

This constructor creates a new ColorTable from an optional input source.

The Input Source

The constructor's input source can either be a PixMill.ColorTable or a JS Object containing string/color-specification pairs. A null input source will create an empty color table.

Parameters:

• source [Object or PixMill.ColorTable or Null] — the input source <default: null>

Throws:

• [ArgumentError] — if the incoming source is invalid or unrecognized

---

Method Details

delete(key) → PixMill.ColorTable

This method deletes an entry from the color table.

Parameters:

• key [String] — the color specification key

Returns:

• [PixMill.ColorTable] — itself

---

get(key, type) → String or Array<Number> ⇏ RuntimeError

This method is used to retrieve a color specification from the color table. It can also reformat the color specification.

Parameters:

• key [String] — the color specification key
• type [String or Null] — the type of color specification to return <default: null>

Returns:

• [String or Array<Number>] — the color specification

Throws:

• [RuntimeError] — if the key has not been defined or the type is not compatible with the color specification

---

getClosestCspecKey(target) → String or Null

This method finds an entry in the color table which is closest to the specific color specification.

Parameters:

• target [String or Array<Number>] — the target color specification

Returns:

• [String or Null] — the key of the color specification closest to the given target, or Null if the color table is empty

---

getHtmlSpec(key) → String or Null

This method is used to retrieve the HTML color specification from the color table.

Parameters:

• key [String] — the color specification key

Returns:

• [String or Null] — the HTML color specification, or Null if not found

---

hasKey(key) → Boolean

This method determines if the color table has a specified key defined.

Parameters:

• key [String] — the color table key

Returns:

• [Boolean] — true, if the key has been defined

---

keys() → Array<String>

This method retrieves all of the color table keys.

Returns:

• [Array<String>] — the list of color table keys

---

load(source, on_duplicate_entry) → PixMill.ColorTable ⇏ ArgumentError

This method is used to load this color table from an input source.

Parameters:

• source [Object or PixMill.ColorTable] — the input source
• on_duplicate_entry [Integer] — the action to take if a duplicate entry is encountered <default: PixMill.CTAB_OVERWRITE>

Returns:

• [PixMill.ColorTable] — itself

Throws:

• [ArgumentError] — if on_duplicate_entry = PixMill.CTAB_THROWS and a duplicate entry is encountered

---

set(key, cspec, on_duplicate_entry) → PixMill.ColorTable ⇏ ArgumentError ⇏ RuntimeError

This method is used to set a color specification to a key. It will also create an HTML-compatible version.

Parameters:

• key [String] — the color specification key
• cspec [String or Array<Number>] — the color specification key
• on_duplicate_entry [Integer] — the action to take if a duplicate entry is encountered <default: PixMill.CTAB_OVERWRITE>

Returns:

• [PixMill.ColorTable] — itself

Throws:

• [ArgumentError] — if the color specification is invalid or unrecognized
• [RuntimeError] — if on_duplicate_entry = PixMill.CTAB_THROWS and a duplicate entry is encountered

---

Class: PixMill.Ellipse ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Ellipse(properties) ⇏ RuntimeError

This constructor constructs a ellipse marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the ellipse
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• xr [Number] — the x-axis radius of the ellipse
• yr [Number] — the y-axis radius of the ellipse
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the ellipse <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, xr, yr, scale, gs)   <overload>

This overload method sets the properties of the the Ellipse marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• xr [Number] — the x-axis radius of the ellipse
• yr [Number] — the y-axis radius of the ellipse
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.Graphic ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Graphic(properties) ⇏ RuntimeError

This constructor constructs a graphic marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the graphic
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• surface [CanvasRenderingContext2D] — the surface containing the graphic/image data
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

draw(gs) → PixMill.MarkingObject ⇏ RuntimeError   <overload>

This method defines the default marking object drawing.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object drawing

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the layout is not set

---

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, surface, scale, gs)   <overload>

This overload method sets the properties of the the Graphic marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• surface [CanvasRenderingContext2D] — the surface containing the graphic/image data
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) ⇏ RuntimeError   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Throws:

• [RuntimeError] — always, graphic object cannot be traced

---

Class: PixMill.GraphicsState

File Manifest

File Manifest

File	Language	Author(s)	Copyright
graphicsState.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.GraphicsState(args) ⇏ ArgumentError

This constructor will create a graphics state attached to a given drawing context, with an optional color table, or will build a clone of another graphics state.

Parameters:

• args [Variadic] — a PixMill.GraphicsState to clone or a CanvasRenderingContext2D, PixMill.ColorTable pairing

Throws:

• [ArgumentError] — if the constructor's arguments are invalid or unrecognizable

---

Method Details

$bezierMinMax() → Object   <private>

This private method calculates the min & max points for bezier curve extent tracking.

Returns:

• [Object] — the min and max extent information

---

$collectPathExtents(x, y, x2, y2) → PixMill.GraphicsState   <private>

This private method manages the extents of the current path by collecting sole and/or min and max points.

Parameters:

• x [Number] — the x-coordinate of the sole or first point
• y [Number] — the y-coordinate of the sole or first
• x2 [Number] — the x-coordinate of the second point <default: null>
• y2 [Number] — the y-coordinate of the second point <default: null>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

$configSource(index, value) → PixMill.GraphicsState   <private>

This private method sets the specified source to a value in a format compatible to the platform's drawing context.

To Do: This implementation is partial, missing support for patterns and shaders (incl. gradient fills)

Parameters:

• index [String] — the source type to configure
• value [String or Array<Number>] — the incoming color specification or other source type

Returns:

• [PixMill.GraphicsState] — this graphics state

---

$extractHtml5Cspec(value) → String   <private>

This private method retrieves and/or converts a color specification to an HTML5-formatted one.

Parameters:

• value [String or Array<Number>] — the color specification or color table key

Returns:

• [String] — an HTML5-formatted color specification

---

$fillProc(path) → PixMill.GraphicsState   <private>

This private method sets the fill parameters and does a fill operation on the attached drawing context.

Parameters:

• path [Path2D] — the path that describes the object to fill

Returns:

• [PixMill.GraphicsState] — this graphics state

---

$genCanvasBbox(w, h, ctm) → Array<Number>   <private>

This private method generates a 4-element bounding box of the canvas' drawing surface. The current CTM is taken into account when calculating the bounding box, so the canvas may be offset, rotated and/or scaled.

Parameters:

• w [Number] — the width of the attached canvas
• h [Number] — the height of the attached canvas
• ctm [Array<Number>] — the CTM array used for calculations

Returns:

• [Array<Number>] — the 4-element array of x, y, width, height of the bounding box enclosing the canvas' drawing surface

---

$getHeight() → Number   <private>

This private method returns the height of the attached canvas.

Returns:

• [Number] — the height of the canvas

---

$getWidth() → Number   <private>

This private method returns the width of the attached canvas.

Returns:

• [Number] — the width of the canvas

---

$quadraticMinMax() → Object   <private>

This private method calculates the min & max points for quadratic bezier curve extent tracking.

Returns:

• [Object] — the min and max extent information

---

$strokeProc(path, width, loc) → PixMill.GraphicsState   <private>

This private method sets the stroke parameters and does a stroke operation on the attached drawing context.

Parameters:

• path [Path2D] — the path that describes the object to fill
• width [Number] — the stroke width in pixels
• loc [Boolean] — true, if the stroke should be clipped to the inside of the object

Returns:

• [PixMill.GraphicsState] — this graphics state

---

arc(x, y, radius, startAngle, endAngle, anticlockwise) → PixMill.GraphicsState

This method adds an arc sub-path to the current path.

Parameters:

• x [Number] — the x-coordinate of the center point of the circle which defines the arc
• y [Number] — the y-coordinate of the center point of the circle which defines the arc
• radius [Number] — the radius of the circle which defines the arc
• startAngle [Number] — the angle defining the location of the start point of the arc, in radians
• endAngle [Number] — the angle defining the location of the end point of the arc, in radians
• anticlockwise [Boolean] — true, if the arc is to be drawn anti-/counter-clockwise <default: false>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

arcTo() → PixMill.GraphicsState

This method will draw an arc from the

To Do: This method is incomplete with regard to extent tracking.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

beginPath() → PixMill.GraphicsState

This method creates a new path.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y) → PixMill.GraphicsState

This method traces a cubic bezier curve from the current point to a specified point using two control points.

Parameters:

• cp1x [Number] — the x-coordinate of the first control point
• cp1y [Number] — the y-coordinate of the first control point
• cp2x [Number] — the x-coordinate of the second control point
• cp2y [Number] — the y-coordinate of the second control point
• x [Number] — the x-coordinate of the end point
• y [Number] — the y-coordinate of the end point

Returns:

• [PixMill.GraphicsState] — this graphics state

---

clipto(preserve) → PixMill.GraphicsState

This method defines a clip region defined by the current path.

Parameters:

• preserve [Boolean] — true, if the current path is to be preserved <default: false>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

clone(incl_stack) → PixMill.GraphicsState

This method clones the current graphics state.

Parameters:

• incl_stack [Boolean] — true, if the clone includes the graphics state stack <default: false>

Returns:

• [PixMill.GraphicsState] — this graphics state cloned

---

closePath() → PixMill.GraphicsState

This method closes the existing path.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

copyPath() → Path2D

This method returns a copy of the current path.

Returns:

• [Path2D] — the copy of the current path

---

ellipse(x, y, radiusX, radiusY, rotation, startAngle, endAngle, anticlockwise) → PixMill.GraphicsState

This method adds an elliptical arc sub-path to the current path.

Parameters:

• x [Number] — the x-coordinate of the center point of the circle which defines the arc
• y [Number] — the y-coordinate of the center point of the circle which defines the arc
• radiusX [Number] — the x-axis radius of the ellipse which defines the arc
• radiusY [Number] — the y-axis radius of the ellipse which defines the arc
• rotation [Number] — the tilt of the ellipse, in radians
• startAngle [Number] — the angle defining the location of the start point of the arc, in radians
• endAngle [Number] — the angle defining the location of the end point of the arc, in radians
• anticlockwise [Boolean] — true, if the arc is to be drawn anti-/counter-clockwise <default: false>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

getPathExtents() → Array<Number>

This method returns the extents of the current path.

Returns:

• [Array<Number>] — the 4-element extent array

---

lineTo(x, y) → PixMill.GraphicsState

This method traces a line from the current point to the given point in the current path.

Parameters:

• x [Number] — the x-coordinate of the point
• y [Number] — the y-coordinate of the point

Returns:

• [PixMill.GraphicsState] — this graphics state

---

moveTo(x, y) → PixMill.GraphicsState

This method sets the current point in the current path.

Parameters:

• x [Number] — the x-coordinate of the point
• y [Number] — the y-coordinate of the point

Returns:

• [PixMill.GraphicsState] — this graphics state

---

paint() → PixMill.GraphicsState

This method paints the entire canvas with the current fill source.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

pathToSvgPath()

This method converts the current path to an SVG format path description.

---

pop(n) → PixMill.GraphicsState

This method pops one or more graphics states from the graphics state stack.

Parameters:

• n [Integer] — the number of graphics states to pop off the stack <default: 1>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

popAll() → PixMill.GraphicsState

This method pops the entire GS stack.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

push(proc) → PixMill.GraphicsState

This method pushes a new graphics state onto the graphics state stack. The new graphics state is a clone of the current graphics state. If an optional procedure is supplied, the graphics state will be popped after the procedure is run.

Parameters:

• proc [Function] — the proc to call after the new graphics state is pushed <default: null>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

quadraticCurveTo(cpx, cpy, x, y) → PixMill.GraphicsState

This method traces a quadratic bezier curve from the current point to a specified point using a control point.

Parameters:

• cpx [Number] — the x-coordinate of the control point
• cpy [Number] — the y-coordinate of the control point
• x [Number] — the x-coordinate of the end point
• y [Number] — the y-coordinate of the end point

Returns:

• [PixMill.GraphicsState] — this graphics state

---

rect(x, y, w, h) → PixMill.GraphicsState

This method adds a rectangular sub-path to the current path.

Parameters:

• x [Number] — the x-coordinate of the top-left position of the rectangle
• y [Number] — the y-coordinate of the top-left position of the rectangle
• w [Number] — the width of the rectangle
• h [Number] — the height of the rectangle

Returns:

• [PixMill.GraphicsState] — this graphics state

---

reset() → PixMill.GraphicsState

This method resets a graphics state to its initial state.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

restorePath() → PixMill.GraphicsState

This method restores the current saved path and state.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

rrect(x, y, w, h, xr, yr) → PixMill.GraphicsState

This method adds a rounded rectangular sub-path to the current path.

Parameters:

• x [Number] — the x-coordinate of the top-left position of the rectangle
• y [Number] — the y-coordinate of the top-left position of the rectangle
• w [Number] — the width of the rectangle
• h [Number] — the height of the rectangle
• xr [Number] — the x-axis radius of the corners of the rectangle
• yr [Number] — the y-axis radius of the corners of the rectangle

Returns:

• [PixMill.GraphicsState] — this graphics state

---

savePath() → PixMill.GraphicsState

This method saves the current path and state. There is no stack.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

set(options) → PixMill.GraphicsState

This method sets graphics state settings and properties.

Parameters:

• options [Object] — an object of key/value pairs containing the graphics state settings to set

Returns:

• [PixMill.GraphicsState] — this graphics state

---

strokeFill(preserve) → PixMill.GraphicsState

This method does a combined fill and/or stroke operation along the current path.

Parameters:

• preserve [Boolean] — will reset the path if false <default: false>

Returns:

• [PixMill.GraphicsState] — this graphics state

---

unclip() → PixMill.GraphicsState

This method removes the topmost clip region from the clip stack.

Returns:

• [PixMill.GraphicsState] — this graphics state

---

Class: PixMill.Hexagon ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Hexagon(properties) ⇏ RuntimeError

This constructor constructs a hexagon marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the hexagon
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• size [Number] — the edge-to-edge size of the hexagon
• orientation [String] — the orientation of the hexagon <default: 'wide'>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the hexagon <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, size, orientation, scale, gs)   <overload>

This overload method sets the properties of the the Hexagon marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• size [Number] — the edge-to-edge size of the hexagon
• orientation [String] — the orientation of the hexagon <default: 'wide'>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.MarkingObject()

The constructor is a no-op. The derived classes provide the functionality.

---

Method Details

$calcDim(scale, value) → Number   <private> <deprecate>

This private method calculates a dimension value of the object based on the specified scale.

Parameters:

• scale [Number] — the scale factor
• value [Number] — the value to adjust

Returns:

• [Number] — the scaled value

---

$parentIsBase() → Boolean   <private>

Returns:

• [Boolean] — true if the parent is a drawing surface

---

$parentIsViewport() → Boolean   <private>

Returns:

• [Boolean] — true if the parent is a PixMill.Viewport

---

bbox() → PixMill.BoundingBox

This method returns the marking object's bbox (bounding box).

Note: Some layouts may be arrays, in which case the first array is the primary bounding box.

Returns:

• [PixMill.BoundingBox] — the marking object's bounding box

---

clipto(gs) → PixMill.MarkingObject

This method sets the underlying graphics state's clip region to the marking object's shape.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to set the clip region

Returns:

• [PixMill.MarkingObject] — this marking object

---

cliptrace(gs, force_placement) → PixMill.MarkingObject ⇏ RuntimeError

This method defines the default marking object shape tracing logic for clip region creation, aka path creation. For clip region creation, some derived objects may use its bbox as its clip region shape.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if there the marking object does not have a valid layout

---

draw(gs, eproc) → PixMill.MarkingObject ⇏ RuntimeError

This method defines the default marking object drawing.

Note: Most of the time, the derived object don't need to override this behavior. Most of the time...

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object drawing
• eproc [Function] — a function to call if the trace API call has thrown an exception <default: null>

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the trace call threw an uncaught exception

---

place(gs) → PixMill.MarkingObject

This method is used to set the object's layout for tracing and drawing purposes. As the base class is essentially a null object, there is no layout.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(type, parent) → PixMill.MarkingObject

This method sets the common properties of all marking objects. Each derived class will define the types of each property and interact with them.

Parameters:

• type [String] — the name of the type of the derived marking object
• parent [PixMill.MarkingObject or PixMill.GraphicsState] — the

Returns:

• [PixMill.MarkingObject] — this marking object

---

setHexagonLayout(gs, ee, orientation) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place a hexagonal marking object onto a drawing context using graphics state parameters.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• ee [Number] — the edge-to-edge size of the hexagon
• orientation [String] — the orientation of the hexagon as a string: { 'wide', 'tall' } <default: 'wide'>

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

setImageLayout(gs, surface) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place an image marking object onto a drawing context using graphics state parameters.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• surface [Image] — the image surface to be placed

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

setPolyLayout(gs, minmax) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place a polygon marking object onto a drawing context using graphics state parameters.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• minmax [Array<Number>] — a 4-element array of xy-minmax values that define the bounds of the effective area of the polygon

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

setRadiiLayout(gs, xr, yr) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place a circular/elliptical marking object onto a drawing context using graphics state parameters.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• xr [Number] — the radius of a circular object or the x-axis radius of an elliptical object
• yr [Number] — the y-axis radius of an elliptical object, should be equal to xr for a circular object <default: xr>

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

setTextLayout(gs, width, height) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place a text marking object onto a drawing context using graphics state parameters. The width and height parameters are non-rotated parameters. If the graphics state specifies any rotation or scaling, the appropriate values will be calculated.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• width [Number] — the width of the string
• height [Number] — the heighth of the string

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

setWhLayout(gs, w, h) → PixMill.MarkingObject ⇏ RuntimeError   <protected>

This protected method is designed to place a rectangular marking object onto a drawing context using graphics state parameters.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used to place the object
• w [Number] — the width of the rectangular object
• h [Number] — the height of the rectangular object

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the marking object is a PixMill.Viewport and x,y positioning or scaling is specified

---

trace(gs, force_placement) → PixMill.MarkingObject ⇏ RuntimeError

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Note: Due to how Javascript class inheritance works, while this method is defined within PixMill.MarkingObject, 'this' may be referring to a derived (real) object, so this.place() will call the correct method.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if there the marking object does not have a valid layout

---

unclip(gs) → PixMill.MarkingObject

This method resets the underlying graphics state's clip region.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state

Returns:

• [PixMill.MarkingObject] — this marking object

---

update(props) → PixMill.MarkingObject

This method updates the property values for the marking object.

Parameters:

• props [Array] — The properties to assign to the marking object

Returns:

• [PixMill.MarkingObject] — this marking object

---

viewport() → PixMill.Viewport

This method returns the marking object's viewport.

Returns:

• [PixMill.Viewport] — the marking object's viewport, or itself

---

Class: PixMill.Path ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Path(properties) ⇏ RuntimeError

This constructor constructs a path marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the path
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• desc [String] — the path description
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the path <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, desc, scale, gs)   <overload>

This overload method sets the properties of the the Path marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• desc [String] — the path description
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.PathDescriptor

File Manifest

File Manifest

File	Language	Author(s)	Copyright
pathDescriptor.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.PathDescriptor(desc)

This constructor tokenizes the given path description for analysis or rendering.

Parameters:

• desc [String] — the path description

---

Method Details

$compile() → Boolean   <private>

This private method tokenizes the path descriptor string.

Returns:

• [Boolean] — true, if successful

---

anyTokens() → Boolean

This method determines if any tokens have been defined.

Returns:

• [Boolean] — true, if there are tokens

---

set(desc) → Boolean

This method tokenizes the given patah description.

Parameters:

• desc [String] — the path description

Returns:

• [Boolean] — true, if any tokens have been parsed successfully

---

trace(gs, absx, absy, relx, rely)

This method draws the tokenized information using the given graphics state.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state
• absx [Function] — the function to call to compute an absolute x-coordinate value <default: (x) => { return x }>
• absy [Function] — the function to call to compute an absolute y-coordinate value <default: (y) => { return y }>
• relx [Function] — the function to call to compute a relative x-coordinate value <default: (rx) => { return rx }>
• rely [Function] — the function to call to compute a relative y-coordinate value <default: (ry) => { return ry }>

---

Class: PixMill.Polygon ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Polygon(properties) ⇏ RuntimeError

This constructor constructs a polygon marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the polygon
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• points [Array<Number>] — the points of the polygon as a single-dimension Array of coordinates
• closed [Boolean] — true, if the polygon path is closed <default: true>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the polygon <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, points, closed, scale, gs)   <overload>

This overload method sets the properties of the the Polygon marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• points [Array<Number>] — the points of the polygon as a single-dimension Array of coordinates
• closed [Boolean] — true, if the polygon path is closed <default: true>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.Rectangle ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Rectangle(properties) ⇏ RuntimeError

This constructor constructs a rectangle marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the rectangle
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• w [Number] — the width of the rectangle
• h [Number] — the height of the rectangle
• xr [Number] — the x-axis radius of the corners of a rounded rectangle, if specified <default: null>
• yr [Number] — the y-axis radius of the corners of a rounded rectangle, if specified <default: null>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the rectangle <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, w, h, xr, yr, scale, gs)   <overload>

This overload method sets the properties of the the Rectangle marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• w [Number] — the width of the rectangle
• h [Number] — the height of the rectangle
• xr [Number] — the x-axis radius of the corners of a rounded rectangle, if specified <default: null>
• yr [Number] — the y-axis radius of the corners of a rounded rectangle, if specified <default: null>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) → PixMill.MarkingObject   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Returns:

• [PixMill.MarkingObject] — this marking object

---

Class: PixMill.Text ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Text(properties) ⇏ RuntimeError

This constructor constructs a text marking object from the supplied parameters.

Parameters:

• properties [Object] — the properties of the text
• parent [PixMill.MarkingObject] — the parent object which defines the placement reference point
• string [String] — the text string
• fontscale [Integer] — the scale factor for the font <default: 0>
• snap_to_ink [Boolean] — true, if the bounding box of the marking object will be reduced to the area inked <default: false>
• attribute_list [PixMill.TextAttributes] — attributes to apply to the text string <default: null>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the text <default: null>

Throws:

• [RuntimeError] — if the properties parameter is missing required elements

---

Method Details

cliptrace(gs)   <overload>

This method defines the default marking object shape tracing logic for clip region creation, aka path creation.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to set the clip region

---

draw(gs) → PixMill.MarkingObject ⇏ RuntimeError   <overload>

This method defines the default marking object drawing.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object drawing

Returns:

• [PixMill.MarkingObject] — this marking object

Throws:

• [RuntimeError] — if the layout is not set

---

place(gs) → PixMill.MarkingObject   <overload>

This method is used to set the object's layout for tracing and drawing purposes.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state used for object placement

Returns:

• [PixMill.MarkingObject] — this marking object

---

set(parent, string, fontscale, snap_to_ink, attribute_list, scale, gs)   <overload>

This overload method sets the properties of the the Text marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• string [String] — the text string
• fontscale [Integer] — the scale factor for the font <default: 0>
• snap_to_ink [Boolean] — true, if the bounding box of the marking object will be reduced to the area inked <default: false>
• attribute_list [PixMill.TextAttributes] — attributes to apply to the text string <default: null>
• scale [Integer] — the scale factor that defines the coordinate system coverage of the parent <default: 0>
• gs [PixMill.GraphicsState] — the graphics state associated with the graphic <default: null>

---

trace(gs, force_placement) ⇏ RuntimeError   <overload>

This method defines the default marking object shape tracing logic, aka path creation. It requires a layout to be set via the place API call.

Parameters:

• gs [PixMill.GraphicsState] — the graphics state to use for object shape tracing
• force_placement [Boolean] — true, if the caller wants to force/overwrite a new placement layout <default: false>

Throws:

• [RuntimeError] — always, text object cannot be traced

---

Class: PixMill.TextAttributes

File Manifest

File Manifest

File	Language	Author(s)	Copyright
textAttributes.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new PixMill.TextAttributes(attrs)

This constructor creates a PixMill.TextAttributes object w/o any attributes defined.

Parameters:

• attrs [PixMill.TextAttributes] — a set of text attributes to clone <default: null>

---

Property Details

anyDrawingAttributes → Boolean   <read-only>

This property returns true if any drawing attributes have been defined

anyLayoutAttributes → Boolean   <read-only>

This property returns true if any layout attributes have been defined

anyUnderlineAttributes → Boolean   <read-only>

This property returns true if any underline attributes have been defined

length → Integer   <read-only>

This property returns the number of attributes defined

Method Details

$addToDrawingAttributes(name, value, si, ei) → PixMill.TextAttributes   <private>

Parameters:

• name [String] — The name of the attribute
• value [Any] — The value of the attribute
• si [Integer] — the starting index of the range to cover
• ei [Integer] — the ending index of the range to cover

Returns:

• [PixMill.TextAttributes] — itself

---

$addToLayoutAttributes(name, value, si, ei) → PixMill.TextAttributes   <private>

Parameters:

• name [String] — The name of the attribute
• value [Any] — The value of the attribute
• si [Integer] — the starting index of the range to cover
• ei [Integer] — the ending index of the range to cover

Returns:

• [PixMill.TextAttributes] — itself

---

addBackground(value, si, ei) → PixMill.TextAttributes

This method adds a background color attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Color] — The background color to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addFill(value, si, ei) → PixMill.TextAttributes

This method adds a fill attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Color] — The fill color to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addFontRelSize(value, si, ei) → PixMill.TextAttributes

This method adds a font relative size attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Number] — The relative size of the font
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addFontStyle(value, si, ei) → PixMill.TextAttributes

This method adds a font style attribute, which can optionally only apply to a range of the text.

Parameters:

• value [PixMill.STYLES] — The font style to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addFontVariant(value, si, ei) → PixMill.TextAttributes

This method adds a font variant attribute, which can optionally only apply to a range of the text.

Parameters:

• value [PixMill.VARIANTS] — The font variant to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addRise(value, si, ei) → PixMill.TextAttributes

This method adds a font rise attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Number] — The distance to rise the font glyphs
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addStretch(value, si, ei) → PixMill.TextAttributes

This method adds a font stretch attribute, which can optionally only apply to a range of the text.

Parameters:

• value [PixMill.STRETCHES] — The font stretch to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addStrikethrough(value, si, ei) → PixMill.TextAttributes

This method adds a font strikethrough, which can optionally only apply to a range of the text.

Parameters:

• value [Null] — Unused
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addStrikethroughColor(value, si, ei) → PixMill.TextAttributes

This method adds a strikethrough color attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Color] — The strikethrough color to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addStroke(value, si, ei) → PixMill.TextAttributes

This method adds a stroke attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Color] — The stroke color to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addStrokeWidth(value, si, ei) → PixMill.TextAttributes

This method adds a stroke width attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Number] — The stroke width to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addSubscript(value, si, ei) → PixMill.TextAttributes

This method adds a font subscript attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Null] — Unused
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addSuperscript(value, si, ei) → PixMill.TextAttributes

This method adds a font superscript attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Null] — Unused
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addUnderline(value, si, ei) → PixMill.TextAttributes

This method adds a font underline, which can optionally only apply to a range of the text.

Parameters:

• value [PixMill.UNDERLINES] — The font underline to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addUnderlineColor(value, si, ei) → PixMill.TextAttributes

This method adds a underline color attribute, which can optionally only apply to a range of the text.

Parameters:

• value [Color] — The underline color to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

addWeight(value, si, ei) → PixMill.TextAttributes

This method adds a font weight attribute, which can optionally only apply to a range of the text.

Parameters:

• value [PixMill.WEIGHTS] — The font weight to use
• si [Integer] — the starting index of the range to cover <default: null>
• ei [Integer] — the ending index of the range to cover <default: null>

Returns:

• [PixMill.TextAttributes] — itself

---

collectDrawingAttributes(si, ei) → Object

This method collects the set of drawing attributes that apply to a given range.

Parameters:

• si [Integer] — the starting index of the range <default: null>
• ei [Integer] — the ending index of the range <default: null>

Returns:

• [Object] — the collection of drawing attributes

---

eachBackgroundLayoutAttribute(callback)

This method calls a callback function for each background drawing attribute.

Parameters:

• callback [Function] — the function to call for each background attribute

---

eachDrawingAttribute(callback)

This method calls a callback function for each defined drawing attribute.

Parameters:

• callback [Function] — the function to call for each drawing attribute

---

eachLayoutAttribute(callback)

This method calls a callback function for each defined layout attribute.

Parameters:

• callback [Function] — the function to call for each layout attribute

---

eachSpecificDrawingAttribute(attribute, callback)

This method calls a callback function for each specific drawing attribute.

Parameters:

• attribute [String] — the specific attribute
• callback [Function] — the function to call for each drawing attribute

---

eachSpecificLayoutAttribute(attribute, callback)

This method calls a callback function for each specific layout attribute.

Parameters:

• attribute [String] — the specific attribute
• callback [Function] — the function to call for each layout attribute

---

eachUnderlineLayoutAttribute(callback)

This method calls a callback function for each underline layout attribute.

Parameters:

• callback [Function] — the function to call for each underline layout attribute

---

Class: PixMill.Viewport ← PixMill.MarkingObject

File Manifest

File Manifest

File	Language	Author(s)	Copyright
markingObjects.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new PixMill.Viewport(parent, x, y)

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• x [Number] — the x-coordinate of the origin point of the viewport within the underlying drawing context <default: 0>
• y [Number] — the y-coordinate of the origin point of the viewport within the underlying drawing context <default: 0>

---

Method Details

bbox() → PixMill.BoundingBox   <overload>

This overload function returns the viewport's bounding box defined in its property list.

Returns:

• [PixMill.BoundingBox] — the viewport's bounding box

---

set(parent, x, y) → PixMill.Viewport ⇏ RuntimeError   <overload>

This overload method sets the properties of the the Viewport marking object.

Parameters:

• parent [DrawingContext] — the underlying drawing context, which is a CanvasRenderingContext2D in this Javascript port
• x [Number] — the x-coordinate of the origin point of the viewport within the underlying drawing context <default: 0>
• y [Number] — the y-coordinate of the origin point of the viewport within the underlying drawing context <default: 0>

Returns:

• [PixMill.Viewport] — this viewport

Throws:

• [RuntimeError] — if the drawing context is not of an appropriate type (CanvasRenderingContext2D)

---