field.kit.math

Package

trait Package extends Trigonometry with Interpolation with Intersection

Extensive Maths package for 2D/3D graphics and simulations .

Provides trigonometry, interpolation and other helper methods.

known subclasses: Common
    authors:
  1. Marcus Wendt

Inherited

  1. Hide All
  2. Show all
  1. Intersection
  2. Interpolation
  3. Trigonometry
  4. AnyRef
  5. Any

Visibility

  1. Public
  2. All

Value Members

  1. def !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality .

    returns

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

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

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

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality .

    returns

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

    attributes: final
    definition classes: Any
  8. val DECIMAL: Regex

    regular expression to detect a number within a string with optional minus and fractional part

    regular expression to detect a number within a string with optional minus and fractional part

    attributes: final
  9. val DEG_TO_RAD: Float

    A value to multiply a degree value by, to convert it to radians .

    A value to multiply a degree value by, to convert it to radians .

    attributes: final
    definition classes: Trigonometry
  10. val EPSILON: Float

    attributes: final
  11. val HALF_PI: Float

    The value PI/2 as a float .

    The value PI/2 as a float . (90 degrees)

    attributes: final
    definition classes: Trigonometry
  12. val INV_PI: Float

    The value 1/PI as a float .

    The value 1/PI as a float .

    attributes: final
    definition classes: Trigonometry
  13. val PI: Float

    The value PI as a float .

    The value PI as a float . (180 degrees)

    attributes: final
    definition classes: Trigonometry
  14. val QUARTER_PI: Float

    The value PI/4 as a float .

    The value PI/4 as a float . (45 degrees)

    attributes: final
    definition classes: Trigonometry
  15. val RAD_TO_DEG: Float

    A value to multiply a radian value by, to convert it to degrees .

    A value to multiply a radian value by, to convert it to degrees .

    attributes: final
    definition classes: Trigonometry
  16. val THIRD_PI: Float

    The value PI/3 as a float .

    The value PI/3 as a float . (60 degrees)

    attributes: final
    definition classes: Trigonometry
  17. val TWO_PI: Float

    The value 2PI as a float .

    The value 2PI as a float . (360 degrees)

    attributes: final
    definition classes: Trigonometry
  18. def abs(n: Float): Float

    attributes: final
  19. def abs(n: Int): Int

    attributes: final
  20. def acos(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  21. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object .

    attributes: final
    definition classes: Any
  22. def asin(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  23. def atan(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  24. def atan2(x: Float, y: Float): Float

    attributes: final
    definition classes: Trigonometry
  25. def ceil(n: Float): Float

    attributes: final
  26. def clamp(value: Float, min: Float, max: Float): Float

    attributes: final
  27. def clamp(value: Float): Float

    attributes: final
  28. def clone(): AnyRef

    This method creates and returns a copy of the receiver object .

    This method creates and returns a copy of the receiver object .

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object .

    attributes: protected
    definition classes: AnyRef
  29. def cos(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  30. implicit def doubleTofloat(d: Double): Float

    attributes: implicit
  31. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality .

    returns

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

    attributes: final
    definition classes: AnyRef
  32. 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 [http://en.wikipedia.org/wiki/Equivalence_relation 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 scala.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
  33. def exp(a: Float): Float

    attributes: final
  34. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object .

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  35. def flipCoin(chance: Float): Boolean

    attributes: final
  36. def flipCoin: Boolean

    attributes: final
  37. def floor(n: Float): Float

    attributes: final
  38. def getClass(): java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object .

    Returns a representation that corresponds to the dynamic class of the receiver object .

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object .

    attributes: final
    definition classes: AnyRef
  39. 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.

    returns

    the hash code value for the object .

    definition classes: AnyRef → Any
  40. def intersects(x1: Float, y1: Float, x2: Float, y2: Float, x3: Float, y3: Float, x4: Float, y4: Float, result: Vec2): Boolean

    Finds the intersection point between two lines (Original code by Guillaume Stagnaro)

    Finds the intersection point between two lines (Original code by Guillaume Stagnaro)

    returns

    returns true when the two lines intersect, otherwise false

    attributes: final
    definition classes: Intersection
  41. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  42. def linear(current: Double, target: Double, delta: Double): Double

    attributes: final
    definition classes: Interpolation
  43. def linear(current: Float, target: Float, delta: Float): Float

    attributes: final
    definition classes: Interpolation
  44. def log(a: Float): Float

    attributes: final
  45. def max(a: Float, b: Float, c: Float): Float

    attributes: final
  46. def max(a: Float, b: Float): Float

    attributes: final
  47. def max(a: Int, b: Int): Int

    attributes: final
  48. def min(a: Float, b: Float, c: Float): Float

    attributes: final
  49. def min(a: Float, b: Float): Float

    attributes: final
  50. def min(a: Int, b: Int): Int

    attributes: final
  51. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality .

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  52. def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor .

    Wakes up a single thread that is waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef
  53. def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor .

    Wakes up all threads that are waiting on the receiver object's monitor .

    attributes: final
    definition classes: AnyRef
  54. def pow(a: Float, b: Float): Float

    attributes: final
  55. def random(scale: Float): Float

    attributes: final
  56. def random(min: Int, max: Int): Int

    attributes: final
  57. def random(min: Float, max: Float): Float

    attributes: final
  58. def random: Float

    attributes: final
  59. def randomNormal: Float

    attributes: final
  60. def reduceAngle(angle: Float): Float

    Reduces the given angle into the -PI/4 .

    Reduces the given angle into the -PI/4 . .. PI/4 interval.

    returns

    reduced angle

    attributes: final
    definition classes: Trigonometry
  61. val rnd: Random

    attributes: final
  62. def round(value: Float, precision: Int): Float

    attributes: final
  63. def same(a: Float, b: Float): Boolean

    no summary matey

    returns

    returns true when a and b are both positive or negative number

    attributes: final
  64. def signum(value: Float): Float

    no summary matey

    returns

    Returns the signum function of the argument; zero if the argument is zero, 1 . 0f if the argument is greater than zero, -1.0f if the argument is less than zero.

    attributes: final
  65. def sin(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  66. def slerp(current: Double, target: Double, delta: Double): Double

    attributes: final
    definition classes: Interpolation
  67. def slerp(current: Float, target: Float, delta: Float): Float

    spherical linear interpolation

    spherical linear interpolation

    attributes: final
    definition classes: Interpolation
      see also:
    1. http://en . wikipedia.org/wiki/Slerp

  68. def slerpAngle(cur: Float, to: Float, delta: Float): Float

    attributes: final
    definition classes: Interpolation
  69. def sq(n: Float): Float

    attributes: final
  70. def sqrt(a: Float): Float

    attributes: final
  71. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  72. def tan(f: Float): Float

    attributes: final
    definition classes: Trigonometry
  73. def toString(): String

    Returns a string representation of the object .

    Returns a string representation of the object .

    The default representation is platform dependent.

    returns

    a string representation of the object .

    definition classes: AnyRef → Any
  74. implicit def tuple2fToVec2(xy: (Float, Float)): Vec2

    attributes: implicit
  75. implicit def tuple3fToVec3(xyz: (Float, Float, Float)): Vec3

    attributes: implicit
  76. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  77. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  78. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef