@haxall/haxall
    Preparing search index...

    Class GraphicsAbstract

    Graphics is used to draw 2D graphics.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Global alpha value used to control opacity for rending. The value must be between 0.0 (transparent) and 1.0 (opaue).

      Returns number

    • Global alpha value used to control opacity for rending. The value must be between 0.0 (transparent) and 1.0 (opaue).

      Parameters

      • it: number

      Returns void

    • Convenience to clip the given the rectangle. This sets the clipping area to the intersection of the current clipping region and the specified rectangle.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number

      Returns this

    • Clip a rectangle with rounded corners with the current paint. The ellipse of the corners is specified by wArc and hArc.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number
      • wArc: number
      • hArc: number

      Returns this

    • Convenience for setting paint to a solid color. If the paint is currently not a solid color, then get returns Paint.asColorPaint.

      Returns Color

    • Convenience for setting paint to a solid color. If the paint is currently not a solid color, then get returns Paint.asColorPaint.

      Parameters

      Returns void

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Dispose of this graphics context and release underyling OS resources.

      Returns void

    • Draw an ellipse within the given bounds with the current stroke and paint.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number

      Returns this

    • Draw an image at the given coordinate for the top/left corner. If the width or height does not correspond to the image's natural size then the image is scaled to fit.

      Parameters

      • img: Image
      • x: number
      • y: number
      • Optionalw: number
      • Optionalh: number

      Returns this

    • Draw a rectangular region of the source image to the drawing surface. The src rectangle defines the subregion of the source image to use. The dst rectangle identifies the destination location. If the src size does not correspond to the dst size, then the image is scaled to fit.

      Parameters

      Returns this

    • Draw a line with the current stroke and paint.

      Parameters

      • x1: number
      • y1: number
      • x2: number
      • y2: number

      Returns this

    • Draw a rectangle with the current stroke and paint.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number

      Returns this

    • Draw a rectangle with rounded corners with the current stroke and paint. The ellipse of the corners is specified by wArc and hArc.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number
      • wArc: number
      • hArc: number

      Returns this

    • Draw a the text string with the current paint and font. The x, y coordinate specifies the left baseline corner of where the text is to be drawn. Technically this is a fill operation similiar to the Canvas fillText function (there is currently no support to stroke/outline text).

      Parameters

      • s: string
      • x: number
      • y: number

      Returns this

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Fill an ellipse within the given bounds with the current stroke and paint.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number

      Returns this

    • Fill a rectangle with the current paint.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number

      Returns this

    • Fill a rectangle with rounded corners with the current paint. The ellipse of the corners is specified by wArc and hArc.

      Parameters

      • x: number
      • y: number
      • w: number
      • h: number
      • wArc: number
      • hArc: number

      Returns this

    • Current font used for drawing text

      Returns Font

    • Current font used for drawing text

      Parameters

      Returns void

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Get font metrics for the current font

      Returns FontMetrics

    • Current paint defines how text and shapes are stroked and filled

      Returns Paint

    • Current paint defines how text and shapes are stroked and filled

      Parameters

      Returns void

    • Begin a new path operation to stroke, fill, or clip a shape.

      Returns GraphicsPath

    • Pop the graphics stack and reset the state to the the last push.

      Returns this

    • Push the current graphics state onto an internal stack. Reset the state back to its current state via pop. If r is non-null, the graphics state is automatically translated and clipped to the bounds.

      Parameters

      Returns this

    • Current stroke defines how the shapes are outlined

      Returns Stroke

    • Current stroke defines how the shapes are outlined

      Parameters

      Returns void

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Perform an affine transformation on the coordinate system

      Parameters

      Returns this

    • Translate the coordinate system to the new origin. This call is a convenience for:

      transform(Transform.translate(x, y))
      

      Parameters

      • x: number
      • y: number

      Returns this

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void