Shape

Kotlin |Java

abstract class Shape : Cloneable

kotlin.Any
↳	android.graphics.drawable.shapes.Shape

Known Direct Subclasses

PathShape, RectShape

PathShape	Creates geometric paths, utilizing the `android.graphics.Path` class.
RectShape	Defines a rectangle shape.

Known Indirect Subclasses

ArcShape, OvalShape, RoundRectShape

ArcShape	Creates an arc shape.
OvalShape	Defines an oval shape.
RoundRectShape	Creates a rounded-corner rectangle.

Defines a generic graphical "shape."

Any Shape can be drawn to a Canvas with its own draw() method, but more graphical control is available if you instead pass it to a android.graphics.drawable.ShapeDrawable.

Custom Shape classes must implement clone() and return an instance of the custom Shape class.

Summary

Public constructors
`Shape()`

Public methods
open Shape	`clone()`
abstract Unit	`draw(canvas: Canvas!, paint: Paint!)` Draws this shape into the provided Canvas, with the provided Paint.
open Boolean	`equals(other: Any?)`
Float	`getHeight()` Returns the height of the Shape.
open Unit	`getOutline(outline: Outline)` Computes the Outline of the shape and return it in the supplied Outline parameter.
Float	`getWidth()` Returns the width of the Shape.
open Boolean	`hasAlpha()` Checks whether the Shape is opaque.
open Int	`hashCode()`
Unit	`resize(width: Float, height: Float)` Resizes the dimensions of this shape.

Protected methods
open Unit	`onResize(width: Float, height: Float)` Callback method called when `resize(float,float)` is executed.

Public constructors

Shape

Shape()

Public methods

clone

Added in API level 1

open fun clone(): Shape

Return
`Shape`	a clone of this instance.

Exceptions
`java.lang.CloneNotSupportedException`	if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

draw

Added in API level 1

abstract fun draw(
    canvas: Canvas!, 
    paint: Paint!
): Unit

Draws this shape into the provided Canvas, with the provided Paint.

Before calling this, you must call resize(float,float).

Parameters
`canvas`	Canvas!: the Canvas within which this shape should be drawn
`paint`	Paint!: the Paint object that defines this shape's characteristics

equals

Added in API level 1

open fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getHeight

Added in API level 1

fun getHeight(): Float

Returns the height of the Shape.

getOutline

Added in API level 21

open fun getOutline(outline: Outline): Unit

Computes the Outline of the shape and return it in the supplied Outline parameter. The default implementation does nothing and outline is not changed.

Parameters
`outline`	Outline: the Outline to be populated with the result. Must be non-`null`.

getWidth

Added in API level 1

fun getWidth(): Float

Returns the width of the Shape.

hasAlpha

Added in API level 1

open fun hasAlpha(): Boolean

Checks whether the Shape is opaque.

Default impl returns true. Override if your subclass can be opaque.

Return
`Boolean`	true if any part of the drawable is not opaque.

hashCode

Added in API level 1

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

resize

Added in API level 1

fun resize(
    width: Float, 
    height: Float
): Unit

Resizes the dimensions of this shape.

Must be called before draw(android.graphics.Canvas,android.graphics.Paint).

Parameters
`width`	Float: the width of the shape (in pixels)
`height`	Float: the height of the shape (in pixels)

Protected methods

onResize

Added in API level 1

protected open fun onResize(
    width: Float, 
    height: Float
): Unit

Callback method called when resize(float,float) is executed.

Parameters
`width`	Float: the new width of the Shape
`height`	Float: the new height of the Shape