field.kit.math.geometry

Spline

class Spline extends Curve

A Catmull-Rom spline (which is a special form of the cubic hermite curve) implementation, generates a smooth curve/interpolation from a number of points.

Used in keyframe-based animation and graphics

Inherits

  1. Curve
  2. AnyRef
  3. Any

Value Members

  1. def +=(x: Float, y: Float, z: Float): Unit

    adds a control point

    adds a control point

  2. def +=(v: Vec3): Unit

    adds the given Vec3

    adds the given Vec3

    definition classes: Curve
  3. val EPSILON: Float

  4. var capacity: Int

  5. def clear: Unit

  6. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  7. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  8. def init(capacity: Int): Unit

    allocates the internal buffers

    allocates the internal buffers

    definition classes: Curve
  9. def point(time: Float, result: AnyRef): Unit

    point calculates a point on a Catmull-Rom curve from a given time value within the interval [0, 1]

    point calculates a point on a Catmull-Rom curve from a given time value within the interval [0, 1]. If the value is zero or less, the first control point is returned. If the value is one or more, the last control point is returned. Using the equation of a Catmull-Rom Curve, the point at the interval is calculated and returned.

  10. def point(time: Float): Unit

    calculates a point on the curve based on the time, where time is [0, 1]

    calculates a point on the curve based on the time, where time is [0, 1]. How the point is calculated is defined by the subclass.

    definition classes: Curve
  11. var size: Int

    the current number of vertices in the list

    the current number of vertices in the list

    definition classes: Curve
  12. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
  13. def update: Unit

    needs to be called when modifcations to the control vertices were made

    needs to be called when modifcations to the control vertices were made

  14. def vertex(n: Int, v: Vec3): Vec3

    definition classes: Curve
  15. def vertex(n: Int): Vec3

    definition classes: Curve
  16. var vertices: FloatBuffer

    stores the control vertices and tangents

    stores the control vertices and tangents

    definition classes: Curve

Instance constructors

  1. new Spline()

    alternative constructor

    alternative constructor

  2. new Spline(capacity: Int)