Scaladoc for field.kit.math.Vec2

Inherited

Hide All
Show all

Vec
AnyRef
Any

Visibility

Public
All

Instance constructors

new Vec2()
new Vec2(x: Float, y: Float)

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
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
def ##(): Int

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

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

attributes: final
definition classes: AnyRef
def *(v: Vec): Vec2

Multiplies the given Vec2 with this Vec2 and returns the result

Multiplies the given Vec2 with this Vec2 and returns the result
returns
result
attributes: final
def *(s: Float): Vec2

Multiplies the given float with this vector

Multiplies the given float with this vector
returns
result as new vector
attributes: final
def *=(v: Vec): Vec2

attributes: final
def *=(s: Float): Vec2

attributes: final
def +(v: Vec): Vec2

Adds the given Vec2 to this Vec2 and returns the result

Adds the given Vec2 to this Vec2 and returns the result
returns
result
attributes: final
def +(s: Float): Vec2

Adds the given Float to this vector

Adds the given Float to this vector
returns
result as new vector
attributes: final
def +=(v: Vec): Vec2

attributes: final
def +=(s: Float): Vec2

attributes: final
def -(v: Vec): Vec2

Subtracts the given Vec2 from this Vec2 and returns the result

Subtracts the given Vec2 from this Vec2 and returns the result
returns
result
attributes: final
def -(s: Float): Vec2

Subtracts the given float from this vector

Subtracts the given float from this vector
returns
result as new vector
attributes: final
def -=(v: Vec): Vec2

attributes: final
def -=(s: Float): Vec2

attributes: final
def /(v: Vec): Vec2

Divides this Vec2 through the given Vec2 and returns the result

Divides this Vec2 through the given Vec2 and returns the result
returns
result
attributes: final
def /(s: Float): Vec2

Divides this vector through the given float

Divides this vector through the given float
returns
result as new vector
attributes: final
def /=(v: Vec): Vec2

attributes: final
def /=(s: Float): Vec2

attributes: final
def :=(s: String): Vec2

Attempts to parse the given String to set this Vectors components

Attempts to parse the given String to set this Vectors components
returns
itself
attributes: final
def :=(buffer: FloatBuffer, index: Int): Vec2

Sets the xyz components to the data from a given buffer at a given index

Sets the xyz components to the data from a given buffer at a given index
returns
itself
attributes: final
def :=(s: Float): Vec2

Sets all components of this Vector to the given Float

Sets all components of this Vector to the given Float
returns
itself
attributes: final
def :=(x: Float, y: Float): Vec2

Sets this Vectors components to the given Floats

Sets this Vectors components to the given Floats
returns
itself
attributes: final
def :=(v: Vec): Vec2

Sets this Vectors components to the given Vec2

Sets this Vectors components to the given Vec2
returns
itself
attributes: final
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
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
def angleBetween(v: Vec): Float

It is assumed that both this vector and the given vector are unit vectors (iow, normalized) .

It is assumed that both this vector and the given vector are unit vectors (iow, normalized) .
returns
the angle (in radians) between two vectors .
attributes: final
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
def clone(): Vec2

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 .
definition classes: Vec2 → AnyRef
def distance(x: Float, y: Float): Float

attributes: final
def distance(v: Vec): Float

attributes: final
def distanceSquared(x: Float, y: Float): Float

attributes: final
def distanceSquared(v: Vec): Float

attributes: final
def dot(v: Vec): Float

Calculates the dot product of this vector with a provided vector .

Calculates the dot product of this vector with a provided vector .
returns
the resultant dot product of this vector and a given vector .
attributes: final
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
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
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
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
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
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
def isValid: Boolean

checks wether one or several components of this vector are Not a Number or Infinite

checks wether one or several components of this vector are Not a Number or Infinite
attributes: final
def length: Float

attributes: final
def lengthSquared: Float

attributes: final
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
def normalize: Vec2

Normalizes this vector .

Normalizes this vector .
returns
itself
attributes: final
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
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
def perpendiculate: Vec2

attributes: final
def put(buffer: FloatBuffer): Vec2

attributes: final
def put(buffer: FloatBuffer, index: Int): Vec2

attributes: final
def set(s: String): Vec2

Attempts to parse the given String to set this Vectors components

Attempts to parse the given String to set this Vectors components
returns
itself
attributes: final
def set(buffer: FloatBuffer, index: Int): Vec2

Sets the xyz components to the data from a given buffer at a given index

Sets the xyz components to the data from a given buffer at a given index
returns
itself
attributes: final
def set(s: Float): Vec2

Sets all components of this Vector to the given Float

Sets all components of this Vector to the given Float
returns
itself
attributes: final
def set(x: Float, y: Float): Vec2

Sets this Vectors components to the given Floats

Sets this Vectors components to the given Floats
returns
itself
attributes: final
def set(v: Vec): Vec2

Sets this Vectors components to the given Vec2

Sets this Vectors components to the given Vec2
returns
itself
attributes: final
def slerp(target: Vec, delta: Float): Vec2

Interpolates towards the given target vector
Interpolates towards the given target vector
attributes: final
1. spherical linear interpolation
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def toCartesian: Unit

Converts the vector from polar to Cartesian space .

Converts the vector from polar to Cartesian space . Assumes this order: x=radius, y=theta
returns
itself as Cartesian vector
def toLabel: String
def toPolar: Vec2

Converts the current vector into polar coordinates .

Converts the current vector into polar coordinates . After the conversion the x component of the vector contains the radius (magnitude) and y the rotation angle.
returns
itself as polar vector
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: Vec2 → AnyRef → Any
def wait(): Unit

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

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

attributes: final
definition classes: AnyRef
var x: Float

definition classes: Vec2 → Vec
var y: Float

definition classes: Vec2 → Vec
def z: Float

definition classes: Vec2 → Vec
def z_=(value: Float): Unit

definition classes: Vec2 → Vec
def zero: Vec2

attributes: final

Vec2

class Vec2 extends Vec

Inherited

Visibility

Instance constructors

new Vec2()

new Vec2(x: Float, y: Float)

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def *(v: Vec): Vec2

def *(s: Float): Vec2

def *=(v: Vec): Vec2

def *=(s: Float): Vec2

def +(v: Vec): Vec2

def +(s: Float): Vec2

def +=(v: Vec): Vec2

def +=(s: Float): Vec2

def -(v: Vec): Vec2

def -(s: Float): Vec2

def -=(v: Vec): Vec2

def -=(s: Float): Vec2

def /(v: Vec): Vec2

def /(s: Float): Vec2

def /=(v: Vec): Vec2

def /=(s: Float): Vec2

def :=(s: String): Vec2

def :=(buffer: FloatBuffer, index: Int): Vec2

def :=(s: Float): Vec2

def :=(x: Float, y: Float): Vec2

def :=(v: Vec): Vec2

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

def angleBetween(v: Vec): Float

def asInstanceOf[T0]: T0

def clone(): Vec2

def distance(x: Float, y: Float): Float

def distance(v: Vec): Float

def distanceSquared(x: Float, y: Float): Float

def distanceSquared(v: Vec): Float

def dot(v: Vec): Float

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

def hashCode(): Int

def isInstanceOf[T0]: Boolean

def isValid: Boolean

def length: Float

def lengthSquared: Float

def ne(arg0: AnyRef): Boolean

def normalize: Vec2

def notify(): Unit

def notifyAll(): Unit

def perpendiculate: Vec2

def put(buffer: FloatBuffer): Vec2

def put(buffer: FloatBuffer, index: Int): Vec2

def set(s: String): Vec2

def set(buffer: FloatBuffer, index: Int): Vec2

def set(s: Float): Vec2

def set(x: Float, y: Float): Vec2

def set(v: Vec): Vec2

def slerp(target: Vec, delta: Float): Vec2

def synchronized[T0](arg0: T0): T0

def toCartesian: Unit

def toLabel: String

def toPolar: Vec2

def toString(): String

def wait(): Unit

def wait(arg0: Long, arg1: Int): Unit

def wait(arg0: Long): Unit

var x: Float

var y: Float

def z: Float

def z_=(value: Float): Unit

def zero: Vec2