class: GraphicsContext

[14:7] extends: FxObj

Wraps the JavaFX GraphicsContext and provides 2D drawing operations for a Canvas. Obtain an instance by calling getGraphicsContext() on a Canvas object. The GraphicsContext maintains a state stack that can be saved and restored. State includes fill paint, stroke paint, line width, font, transforms, and clip.

Methods

setFill (object PaintObj)

Sets the fill paint. Accepts a Color, LinearGradient, or RadialGradient object.
- @p PaintObj is a paint object (Color, LinearGradient, or RadialGradient).
- @r this object for chaining
setStroke (object PaintObj)

Sets the stroke paint. Accepts a Color, LinearGradient, or RadialGradient object.
- @p PaintObj is a paint object (Color, LinearGradient, or RadialGradient).
- @r this object for chaining
setLineWidth (double Width)

Sets the stroke line width.
- @p Width is a double with the line width.
- @r this object for chaining
setLineCap (string Cap)

Sets the line cap style.
- @p Cap is a string: BUTT, ROUND, or SQUARE.
- @r this object for chaining
setLineJoin (string Join)

Sets the line join style.
- @p Join is a string: MITER, BEVEL, or ROUND.
- @r this object for chaining
setMiterLimit (double Limit)

Sets the miter limit for MITER line joins.
- @p Limit is a double with the miter limit.
- @r this object for chaining
setGlobalAlpha (double Alpha)

Sets the global opacity for all drawing operations.
- @p Alpha is a double from 0.0 (transparent) to 1.0 (opaque).
- @r this object for chaining
setGlobalBlendMode (string Mode)

Sets the global blend mode for compositing.
- @p Mode is a string with the blend mode (e.g. SRC_OVER, MULTIPLY, SCREEN, ADD, OVERLAY, DARKEN, LIGHTEN, COLOR_DODGE, COLOR_BURN, HARD_LIGHT, SOFT_LIGHT, DIFFERENCE, EXCLUSION, RED, GREEN, BLUE).
- @r this object for chaining
fillRect (double X, double Y, double W, double H)

Fills a rectangle.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
strokeRect (double X, double Y, double W, double H)

Strokes a rectangle outline.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
fillOval (double X, double Y, double W, double H)

Fills an oval.
- @p X is a double with the X position of the bounding box.
- @p Y is a double with the Y position of the bounding box.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
strokeOval (double X, double Y, double W, double H)

Strokes an oval outline.
- @p X is a double with the X position of the bounding box.
- @p Y is a double with the Y position of the bounding box.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
fillArc (double X, double Y, double W, double H, double Start, double Extent, string Type)

Fills an arc.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @p Start is a double with the start angle in degrees.
- @p Extent is a double with the angular extent in degrees.
- @p Type is a string with the arc type: OPEN, CHORD, or ROUND.
- @r this object for chaining
strokeArc (double X, double Y, double W, double H, double Start, double Extent, string Type)

Strokes an arc outline.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @p Start is a double with the start angle in degrees.
- @p Extent is a double with the angular extent in degrees.
- @p Type is a string with the arc type: OPEN, CHORD, or ROUND.
- @r this object for chaining
fillRoundRect (double X, double Y, double W, double H, double ArcW, double ArcH)

Fills a rounded rectangle.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @p ArcW is a double with the arc width for corners.
- @p ArcH is a double with the arc height for corners.
- @r this object for chaining
strokeRoundRect (double X, double Y, double W, double H, double ArcW, double ArcH)

Strokes a rounded rectangle outline.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @p ArcW is a double with the arc width for corners.
- @p ArcH is a double with the arc height for corners.
- @r this object for chaining
strokeLine (double X1, double Y1, double X2, double Y2)

Draws a line between two points.
- @p X1 is a double with the start X.
- @p Y1 is a double with the start Y.
- @p X2 is a double with the end X.
- @p Y2 is a double with the end Y.
- @r this object for chaining
beginPath ()

Begins a new path.
- @r this object for chaining
moveTo (double X, double Y)

Moves the path cursor to the specified position without drawing.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @r this object for chaining
lineTo (double X, double Y)

Adds a line segment from the current position to the specified position.
- @p X is a double with the end X.
- @p Y is a double with the end Y.
- @r this object for chaining
quadraticCurveTo (double CX, double CY, double X, double Y)

Adds a quadratic Bezier curve to the path.
- @p CX is a double with the control point X.
- @p CY is a double with the control point Y.
- @p X is a double with the end point X.
- @p Y is a double with the end point Y.
- @r this object for chaining
bezierCurveTo (double CX1, double CY1, double CX2, double CY2, double X, double Y)

Adds a cubic Bezier curve to the path.
- @p CX1 is a double with the first control point X.
- @p CY1 is a double with the first control point Y.
- @p CX2 is a double with the second control point X.
- @p CY2 is a double with the second control point Y.
- @p X is a double with the end point X.
- @p Y is a double with the end point Y.
- @r this object for chaining
arcTo (double X1, double Y1, double X2, double Y2, double Radius)

Adds an arc to the path defined by two tangent lines and a radius.
- @p X1 is a double with the first tangent point X.
- @p Y1 is a double with the first tangent point Y.
- @p X2 is a double with the second tangent point X.
- @p Y2 is a double with the second tangent point Y.
- @p Radius is a double with the arc radius.
- @r this object for chaining
closePath ()

Closes the current path by drawing a line back to the starting point.
- @r this object for chaining
stroke ()

Strokes the current path with the current stroke paint and line settings.
- @r this object for chaining
fill ()

Fills the current path with the current fill paint.
- @r this object for chaining
setLineDashes (list Dashes = null)

Sets the dash pattern for stroked lines. Pass null or an empty list to clear the dash pattern and use solid lines.
- @p Dashes is a list of doubles defining the dash pattern (e.g. [10.0, 5.0]), or null for solid.
- @r this object for chaining
setLineDashOffset (double Offset)

Sets the offset into the dash pattern.
- @p Offset is a double with the dash offset.
- @r this object for chaining
fillText (string Text, double X, double Y)

Fills text at the specified position using the current fill paint and font.
- @p Text is a string with the text to draw.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @r this object for chaining
strokeText (string Text, double X, double Y)

Strokes text outline at the specified position using the current stroke paint and font.
- @p Text is a string with the text to draw.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @r this object for chaining
setFont (object FontObj)

Sets the font for text drawing.
- @p FontObj is a FxObj with a JavaFX Font (from Font.get() or Font.load()).
- @r this object for chaining
setTextAlign (string Align)

Sets the horizontal text alignment.
- @p Align is a string: LEFT, CENTER, RIGHT, or JUSTIFY.
- @r this object for chaining
setTextBaseline (string Baseline)

Sets the vertical text baseline.
- @p Baseline is a string: TOP, CENTER, BASELINE, or BOTTOM.
- @r this object for chaining
drawImage (object Img, double X, double Y)

Draws an image at the specified position.
- @p Img is an Image object to draw.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @r this object for chaining
drawImageScaled (object Img, double X, double Y, double W, double H)

Draws an image scaled to the specified size.
- @p Img is an Image object to draw.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the target width.
- @p H is a double with the target height.
- @r this object for chaining
clearRect (double X, double Y, double W, double H)

Clears a rectangular area, making it transparent.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
save ()

Pushes the current state onto the state stack. The state includes fill, stroke, line width, line cap, line join, miter limit, font, text align, text baseline, transforms, clip, and global alpha.
- @r this object for chaining
restore ()

Pops the state from the state stack, restoring all saved state properties.
- @r this object for chaining
clip ()

Intersects the current clip with the current path. Drawing operations after this call will only affect pixels inside the clipped area.
- @r this object for chaining
translate (double X, double Y)

Translates the origin by the specified amounts.
- @p X is a double with the horizontal translation.
- @p Y is a double with the vertical translation.
- @r this object for chaining
rotate (double Angle)

Rotates the canvas around the current origin.
- @p Angle is a double with the rotation angle in degrees.
- @r this object for chaining
scale (double X, double Y)

Scales the canvas axes.
- @p X is a double with the horizontal scale factor.
- @p Y is a double with the vertical scale factor.
- @r this object for chaining
getPixelWriter ()

Returns the PixelWriter for this canvas as an AussomJavaObject. Use AJI invoke() to call methods on it (e.g. setColor).
- @r An AussomJavaObject wrapping the PixelWriter.
getCanvas ()

Returns the Canvas this GraphicsContext draws to.
- @r An AJO wrapping javafx.scene.canvas.Canvas.
transform (double Mxx, double Myx, double Mxy, double Myy, double Mxt, double Myt)

Concatenates an affine transform onto the current transform.
- @p Mxx is a double, the X scaling.
- @p Myx is a double, the Y skew.
- @p Mxy is a double, the X skew.
- @p Myy is a double, the Y scaling.
- @p Mxt is a double, the X translation.
- @p Myt is a double, the Y translation.
- @r this object for chaining
transformAffine (object AffineObj)

Concatenates a javafx.scene.transform.Affine onto the current transform.
- @p AffineObj is an Affine wrapper.
- @r this object for chaining
setTransform (double Mxx, double Myx, double Mxy, double Myy, double Mxt, double Myt)

Replaces the current transform with an affine transform.
- @p Mxx is a double, the X scaling.
- @p Myx is a double, the Y skew.
- @p Mxy is a double, the X skew.
- @p Myy is a double, the Y scaling.
- @p Mxt is a double, the X translation.
- @p Myt is a double, the Y translation.
- @r this object for chaining
setTransformAffine (object AffineObj)

Replaces the current transform with a javafx.scene.transform.Affine.
- @p AffineObj is an Affine wrapper.
- @r this object for chaining
getTransform ()

Returns the current transform as a new javafx.scene.transform.Affine AJO.
- @r An AJO wrapping javafx.scene.transform.Affine.
getGlobalAlpha ()

Returns the global alpha value.
- @r A double from 0.0 to 1.0.
getGlobalBlendMode ()

Returns the current global blend mode.
- @r An AJO wrapping javafx.scene.effect.BlendMode.
getFill ()

Returns the current fill paint.
- @r An AJO wrapping javafx.scene.paint.Paint.
getStroke ()

Returns the current stroke paint.
- @r An AJO wrapping javafx.scene.paint.Paint.
getLineWidth ()

Returns the current stroke line width.
- @r A double with the line width.
getLineCap ()

Returns the current line cap style.
- @r An AJO wrapping javafx.scene.shape.StrokeLineCap.
getLineJoin ()

Returns the current line join style.
- @r An AJO wrapping javafx.scene.shape.StrokeLineJoin.
getMiterLimit ()

Returns the current miter limit.
- @r A double with the miter limit.
getLineDashes ()

Returns the current line dash pattern as an AJO wrapping a double[].
- @r An AJO wrapping a Java double[], or null when no dash pattern is set.
getLineDashOffset ()

Returns the current line dash offset.
- @r A double with the dash offset.
getFont ()

Returns the current font.
- @r An AJO wrapping javafx.scene.text.Font.
setFontSmoothingType (string Smoothing)

Sets the font smoothing type used when drawing text.
- @p Smoothing is a string: GRAY or LCD.
- @r this object for chaining
getFontSmoothingType ()

Returns the current font smoothing type.
- @r An AJO wrapping javafx.scene.text.FontSmoothingType.
getTextAlign ()

Returns the current horizontal text alignment.
- @r An AJO wrapping javafx.scene.text.TextAlignment.
getTextBaseline ()

Returns the current vertical text baseline.
- @r An AJO wrapping javafx.geometry.VPos.
setFillRule (string Rule)

Sets the fill rule used when filling complex paths.
- @p Rule is a string: NON_ZERO or EVEN_ODD.
- @r this object for chaining
getFillRule ()

Returns the current fill rule.
- @r An AJO wrapping javafx.scene.shape.FillRule.
setImageSmoothing (bool Smoothing)

Sets whether image smoothing is applied when drawing scaled images.
- @p Smoothing is a bool; true enables smoothing.
- @r this object for chaining
isImageSmoothing ()

Returns whether image smoothing is enabled.
- @r A bool indicating whether image smoothing is on.
arc (double CenterX, double CenterY, double RadiusX, double RadiusY, double StartAngle, double ArcExtent)

Adds an arc segment to the current path.
- @p CenterX is a double with the center X.
- @p CenterY is a double with the center Y.
- @p RadiusX is a double with the X radius.
- @p RadiusY is a double with the Y radius.
- @p StartAngle is a double with the start angle in degrees.
- @p ArcExtent is a double with the angular extent in degrees.
- @r this object for chaining
rect (double X, double Y, double W, double H)

Adds a rectangle subpath to the current path.
- @p X is a double with the X position.
- @p Y is a double with the Y position.
- @p W is a double with the width.
- @p H is a double with the height.
- @r this object for chaining
appendSVGPath (string SvgPath)

Appends an SVG-style path string to the current path.
- @p SvgPath is a string with an SVG path data expression.
- @r this object for chaining
isPointInPath (double X, double Y)

Returns true if the given point is inside the current path.
- @p X is a double with the test X.
- @p Y is a double with the test Y.
- @r A bool true when the point is inside the path.
fillPolygon (list Xs, list Ys, int NumPoints)

Fills a polygon defined by parallel X and Y coordinate lists.
- @p Xs is a list of doubles with the X coordinates.
- @p Ys is a list of doubles with the Y coordinates.
- @p NumPoints is an int with the number of points to use.
- @r this object for chaining
strokePolygon (list Xs, list Ys, int NumPoints)

Strokes a polygon outline defined by parallel X and Y coordinate lists.
- @p Xs is a list of doubles with the X coordinates.
- @p Ys is a list of doubles with the Y coordinates.
- @p NumPoints is an int with the number of points to use.
- @r this object for chaining
strokePolyline (list Xs, list Ys, int NumPoints)

Strokes a polyline (open polygon) defined by parallel X and Y coordinate lists.
- @p Xs is a list of doubles with the X coordinates.
- @p Ys is a list of doubles with the Y coordinates.
- @p NumPoints is an int with the number of points to use.
- @r this object for chaining
setEffect (object EffectObj)

Sets the effect applied to subsequent drawing operations.
- @p EffectObj is an Effect wrapper, or null to clear.
- @r this object for chaining
getEffect (object EffectObj)

Returns a copy of the current effect. JavaFX requires a destination effect AJO; pass an Effect wrapper to receive the result, or null to allocate a fresh one.
- @p EffectObj is an Effect wrapper used as the receiver, or null.
- @r An AJO wrapping javafx.scene.effect.Effect, or null.
applyEffect (object EffectObj)

Applies an effect to the current pixel contents of the canvas.
- @p EffectObj is an Effect wrapper to apply.
- @r this object for chaining