Cubic

Artifact: androidx.graphics:graphics-shapes

View Source

Added in 1.0.1

Kotlin |Java

Cmn
```
open class Cubic
```

Known direct subclasses

MutableCubic

MutableCubic

This is a Mutable version of Cubic, used mostly for performance critical paths so we can avoid creating new Cubics

This class holds the anchor and control point data for a single cubic Bézier curve, with anchor points (anchor0X, anchor0Y) and (anchor1X, anchor1Y) at either end and control points (control0X, control0Y) and (control1X, control1Y) determining the slope of the curve between the anchor points.

Summary

Public companion functions
`Cubic`	`circularArc( centerX: Float, centerY: Float, x0: Float, y0: Float, x1: Float, y1: Float )` Generates a bezier curve that approximates a circular arc, with p0 and p1 as the starting and ending anchor points.	Cmn
`Cubic`	`straightLine(x0: Float, y0: Float, x1: Float, y1: Float)` Generates a bezier curve that is a straight line between the given anchor points.	Cmn

Public functions
`operator Cubic`	`div(x: Float)` Operator overload to enable dividing Cubics by a scalar value x, like "c0 / x"	Cmn
`operator Cubic`	`div(x: Int)` Operator overload to enable dividing Cubics by a scalar value x, like "c0 / x"	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`operator Cubic`	`plus(o: Cubic)` Operator overload to enable adding Cubic objects together, like "c0 + c1"	Cmn
`Cubic`	`reverse()` Utility function to reverse the control/anchor points for this curve.	Cmn
`Pair<Cubic, Cubic>`	`split(t: Float)` Returns two Cubics, created by splitting this curve at the given distance of `t` between the original starting and ending anchor points.	Cmn
`operator Cubic`	`times(x: Float)` Operator overload to enable multiplying Cubics by a scalar value x, like "c0 * x"	Cmn
`operator Cubic`	`times(x: Int)` Operator overload to enable multiplying Cubics by an Int scalar value x, like "c0 * x"	Cmn
`open String`	`toString()`	Cmn
`Cubic`	`transformed(f: PointTransformer)` Transforms the points in this `Cubic` with the given `PointTransformer` and returns a new `Cubic`	Cmn

Public properties
`Float`	`anchor0X` The first anchor point x coordinate	Cmn
`Float`	`anchor0Y` The first anchor point y coordinate	Cmn
`Float`	`anchor1X` The second anchor point x coordinate	Cmn
`Float`	`anchor1Y` The second anchor point y coordinate	Cmn
`Float`	`control0X` The first control point x coordinate	Cmn
`Float`	`control0Y` The first control point y coordinate	Cmn
`Float`	`control1X` The second control point x coordinate	Cmn
`Float`	`control1Y` The second control point y coordinate	Cmn

Public companion functions

circularArc

Cmn

Added in 1.0.1

fun circularArc(
    centerX: Float,
    centerY: Float,
    x0: Float,
    y0: Float,
    x1: Float,
    y1: Float
): Cubic

Generates a bezier curve that approximates a circular arc, with p0 and p1 as the starting and ending anchor points. The curve generated is the smallest of the two possible arcs around the entire 360-degree circle. Arcs of greater than 180 degrees should use more than one arc together. Note that p0 and p1 should be equidistant from the center.

straightLine

Cmn

Added in 1.0.1

fun straightLine(x0: Float, y0: Float, x1: Float, y1: Float): Cubic

Generates a bezier curve that is a straight line between the given anchor points. The control points lie 1/3 of the distance from their respective anchor points.

Public functions

div

Cmn

Added in 1.0.1

operator fun div(x: Float): Cubic

Operator overload to enable dividing Cubics by a scalar value x, like "c0 / x"

div

Cmn

Added in 1.0.1

operator fun div(x: Int): Cubic

Operator overload to enable dividing Cubics by a scalar value x, like "c0 / x"

equals

Cmn

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

plus

Cmn

Added in 1.0.1

operator fun plus(o: Cubic): Cubic

Operator overload to enable adding Cubic objects together, like "c0 + c1"

reverse

Cmn

Added in 1.0.1

fun reverse(): Cubic

Utility function to reverse the control/anchor points for this curve.

split

Cmn

Added in 1.0.1

fun split(t: Float): Pair<Cubic, Cubic>

Returns two Cubics, created by splitting this curve at the given distance of t between the original starting and ending anchor points.

times

Cmn

Added in 1.0.1

operator fun times(x: Float): Cubic

Operator overload to enable multiplying Cubics by a scalar value x, like "c0 * x"

times

Cmn

Added in 1.0.1

operator fun times(x: Int): Cubic

Operator overload to enable multiplying Cubics by an Int scalar value x, like "c0 * x"

toString

Cmn

open fun toString(): String

transformed

Cmn

Added in 1.0.1

fun transformed(f: PointTransformer): Cubic

Transforms the points in this Cubic with the given PointTransformer and returns a new Cubic

Parameters
`f: PointTransformer`	The `PointTransformer` used to transform this `Cubic`

Public properties

anchor0X

Cmn

Added in 1.0.1

val anchor0X: Float

The first anchor point x coordinate

anchor0Y

Cmn

Added in 1.0.1

val anchor0Y: Float

The first anchor point y coordinate

anchor1X

Cmn

Added in 1.0.1

val anchor1X: Float

The second anchor point x coordinate

anchor1Y

Cmn

Added in 1.0.1

val anchor1Y: Float

The second anchor point y coordinate

control0X

Cmn

Added in 1.0.1

val control0X: Float

The first control point x coordinate

control0Y

Cmn

Added in 1.0.1

val control0Y: Float

The first control point y coordinate

control1X

Cmn

Added in 1.0.1

val control1X: Float

The second control point x coordinate

control1Y

Cmn

Added in 1.0.1

val control1Y: Float

The second control point y coordinate