Scaladoc for field.kit.physics.Particle

Inherited

Hide All
Show all

Behavioural
Vec3
Product
Equals
Vec
AnyRef
Any

Visibility

Public
All

Instance constructors

new Particle(v: Vec3)

Creates a new particle at the given position

Creates a new particle at the given position
new Particle()

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): Vec3

Multiplies the given Vec3 with this Vec3 and returns the result

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

Multiplies the given float with this vector

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

attributes: final
definition classes: Vec3
def *=(s: Float): Vec3

attributes: final
definition classes: Vec3
def +(v: Vec): Vec3

Adds the given Vec3 to this Vec3 and returns the result

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

Adds the given Float to this vector

Adds the given Float to this vector
returns
result as new vector
attributes: final
definition classes: Vec3
def +=(p: Particle): ArrayBuffer[Particle]

Adds another particle as this particles neighbour

Adds another particle as this particles neighbour
def +=(s: BehaviourSet): Unit

Adds the given BehaviourSet to this Behavioural

Adds the given BehaviourSet to this Behavioural
definition classes: Behavioural
def +=(c: Constraint): Unit

Adds the given Constraint to this Behavioural

Adds the given Constraint to this Behavioural
definition classes: Behavioural
def +=(b: Behaviour): Unit

Adds the given Behaviour to this Behavioural

Adds the given Behaviour to this Behavioural
definition classes: Behavioural
def +=(v: Vec): Vec3

attributes: final
definition classes: Vec3
def +=(s: Float): Vec3

attributes: final
definition classes: Vec3
def -(v: Vec): Vec3

Subtracts the given Vec3 from this Vec3 and returns the result

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

Subtracts the given float from this vector

Subtracts the given float from this vector
returns
result as new vector
attributes: final
definition classes: Vec3
def -=(s: BehaviourSet): Unit

definition classes: Behavioural
def -=(c: Constraint): Unit

Removes the given Constraint to this Behavioural

Removes the given Constraint to this Behavioural
definition classes: Behavioural
def -=(b: Behaviour): Unit

Removes the given Behaviour to this Behavioural

Removes the given Behaviour to this Behavioural
definition classes: Behavioural
def -=(v: Vec): Vec3

attributes: final
definition classes: Vec3
def -=(s: Float): Vec3

attributes: final
definition classes: Vec3
def /(v: Vec): Vec3

Divides this Vec3 through the given Vec3 and returns the result

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

Divides this vector through the given float

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

attributes: final
definition classes: Vec3
def /=(s: Float): Vec3

attributes: final
definition classes: Vec3
def :=(s: String): Vec3

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
definition classes: Vec3
def :=(buffer: FloatBuffer, index: Int): Vec3

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
definition classes: Vec3
def :=(s: Float): Vec3

Sets all components of this Vector to the given Float

Sets all components of this Vector to the given Float
returns
itself
definition classes: Vec3
def :=(v: Vec): Vec3

Sets this Vectors components to the given Vec3

Sets this Vectors components to the given Vec3
returns
itself
definition classes: Vec3
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
var _invWeight: Float

attributes: protected
var _isLocked: Boolean

attributes: protected
var _timestep: Float

attributes: protected
var _timestepSq: Float

attributes: protected
var _weight: Float

attributes: protected
def add(s: BehaviourSet): Unit

definition classes: Behavioural
def add(c: Constraint): Unit

Adds the given Constraint to this Behavioural

Adds the given Constraint to this Behavioural
definition classes: Behavioural
def add(b: Behaviour): Unit

Adds the given Behaviour to this Behavioural

Adds the given Behaviour to this Behavioural
definition classes: Behavioural
var age: Float
def angleBetween(v: Vec3): Unit

angleBetween returns (in radians) the angle between two vectors .

angleBetween returns (in radians) the angle between two vectors . It is assumed that both this vector and the given vector are unit vectors (iow, normalized).
attributes: final
definition classes: Vec3
def applyBehaviours: Unit

Applies all assigned behaviours to this particle

Applies all assigned behaviours to this particle
def applyConstraints: Unit

Applies all assigned constraints to this particle

Applies all assigned constraints to this particle
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
var behaviours: ArrayBuffer[Behaviour]

attributes: protected
definition classes: Behavioural
var bounds: BoundingVolume
def canEqual(arg0: Any): Boolean

definition classes: Vec3 → Equals
def clamp(max: Float): Vec3

makes sure this vector does not exceed a certain length

makes sure this vector does not exceed a certain length
attributes: final
definition classes: Vec3
def clearNeighbours: Unit

Clears neighbour list (if set)

Clears neighbour list (if set)
def clearVelocity: Vec3

sets the velocity of this particle to zero

sets the velocity of this particle to zero
def clone(): Vec3

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: Vec3 → AnyRef
var colour: Colour
var constraints: ArrayBuffer[Constraint]

attributes: protected
definition classes: Behavioural
def createBounds: Sphere

attributes: protected
def cross(v: Vec3): Vec3

Calculates the cross product of this vector with a parameter vector v .

Calculates the cross product of this vector with a parameter vector v .
returns
the cross product as a new vector
attributes: final
definition classes: Vec3
def cross(v: Vec3, result: Vec3): Vec3

Calculates the cross product of this vector with a parameter vector v .

Calculates the cross product of this vector with a parameter vector v .
returns
the cross product vector
attributes: final
definition classes: Vec3
def distance(v: Vec): Float

attributes: final
definition classes: Vec3
def distanceSquared(v: Vec): Float

attributes: final
definition classes: Vec3
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
definition classes: Vec3
var drag: Float

Air resistance or fluid resistance, force opposed to the relative motion of this particle

Air resistance or fluid resistance, force opposed to the relative motion of this particle
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: Vec3 → Equals → 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
val force: Vec3

Steering force

Steering force
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: Vec3 → AnyRef → Any
def init(v: Vec3): Unit

initialises the particle at the given position

initialises the particle at the given position
def interpolate(target: Vec3, delta: Float): Vec3

Interpolates the vector towards the given target vector using linear interpolation .

Interpolates the vector towards the given target vector using linear interpolation .
attributes: final
definition classes: Vec3
def invWeight: Float
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 isLocked: Boolean
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
definition classes: Vec3
def length: Float

attributes: final
definition classes: Vec3
def lengthSquared: Float

attributes: final
definition classes: Vec3
def lock: Unit
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
var neighbours: ArrayBuffer[Particle]

List to keep track of this particles neighbours

List to keep track of this particles neighbours
def normalise: Vec3

Normalises this vector so that its magnitude = 1 .

Normalises this vector so that its magnitude = 1 .
returns
itself
attributes: final
definition classes: Vec3
def normaliseTo(len: Float): Vec3

Normalizes the vector to the given length .

Normalizes the vector to the given length .
returns
itself
attributes: final
definition classes: Vec3
def normalize: Vec3

@deprecated

@deprecated
attributes: final
definition classes: Vec3
def normalizeTo(len: Float): Vec3

@deprecated

@deprecated
attributes: final
definition classes: Vec3
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
val prev: Vec3
def productArity: Int

definition classes: Vec3 → Product
def productElement(arg0: Int): Any

definition classes: Vec3 → Product
def productElementName(n: Int): String

definition classes: Product
def productElements: Iterator[Any]
definition classes: Product
1. use productIterator instead
def productIterator: Iterator[Any]

definition classes: Product
def productPrefix: String

definition classes: Vec3 → Product
def put(buffer: FloatBuffer): Vec3

Puts this vector into the given FloatBuffer

Puts this vector into the given FloatBuffer
attributes: final
definition classes: Vec3
def put(buffer: FloatBuffer, index: Int): Vec3

Puts this vector at the given postion into a FloatBuffer

Puts this vector at the given postion into a FloatBuffer
attributes: final
definition classes: Vec3
def randomise: Vec3

Sets this vector

Sets this vector
attributes: final
definition classes: Vec3
def randomiseTo(len: Float): Vec3

attributes: final
definition classes: Vec3
def remove(s: BehaviourSet): Unit

definition classes: Behavioural
def remove(c: Constraint): Unit

Removes the given Constraint to this Behavioural

Removes the given Constraint to this Behavioural
definition classes: Behavioural
def remove(b: Behaviour): Unit

Removes the given Behaviour to this Behavioural

Removes the given Behaviour to this Behavioural
definition classes: Behavioural
def scaleVelocity(s: Float): Vec3
def set(s: String): Vec3

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
definition classes: Vec3
def set(buffer: FloatBuffer, index: Int): Vec3

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
definition classes: Vec3
def set(s: Float): Vec3

Sets all components of this Vector to the given Float

Sets all components of this Vector to the given Float
returns
itself
attributes: final
definition classes: Vec3
def set(v: Vec): Vec3

Sets this Vectors components to the given Vec3

Sets this Vectors components to the given Vec3
returns
itself
attributes: final
definition classes: Vec3
def size: Float
def size_=(value: Float): Unit
def slerp(target: Vec3, delta: Float): Vec3

interpolates towards the given target Vector
interpolates towards the given target Vector
attributes: final
definition classes: Vec3
1. spherical linear interpolation
var state: Int
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def timestep: Float

Time between updates

Time between updates
def timestep_=(value: Float): Unit
def toLabel: String

definition classes: Vec3
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: Vec3 → AnyRef → Any
def tuple: (Float, Float, Float)

attributes: final
definition classes: Vec3
def unlock: Unit
def update(dt: Float): Unit

Advances the particle one timestep

Advances the particle one timestep
def updateBounds: Unit

Updates the bounding box (if set)

Updates the bounding box (if set)
attributes: protected
def updatePosition: Unit

Updates the position based on the previous position and the steering force

Updates the position based on the previous position and the steering force
attributes: protected
def updateState(dt: Float): Unit

For now simply keeps track of the particle's age; override this method to perform custom state changes e .

For now simply keeps track of the particle's age; override this method to perform custom state changes e . g. fading in, alive, fading out etc.
attributes: protected
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
def weight: Float
def weight_=(value: Float): Unit
var x: Float

definition classes: Vec3 → Vec
var y: Float

definition classes: Vec3 → Vec
var z: Float

definition classes: Vec3 → Vec
def zero: Unit

Resets this vectors components all to zero

Resets this vectors components all to zero
attributes: final
definition classes: Vec3

Particle

class Particle extends Vec3 with Behavioural

Inherited

Visibility

Instance constructors

new Particle(v: Vec3)

new Particle()

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def *(v: Vec): Vec3

def *(s: Float): Vec3

def *=(v: Vec): Vec3

def *=(s: Float): Vec3

def +(v: Vec): Vec3

def +(s: Float): Vec3

def +=(p: Particle): ArrayBuffer[Particle]

def +=(s: BehaviourSet): Unit

def +=(c: Constraint): Unit

def +=(b: Behaviour): Unit

def +=(v: Vec): Vec3

def +=(s: Float): Vec3

def -(v: Vec): Vec3

def -(s: Float): Vec3

def -=(s: BehaviourSet): Unit

def -=(c: Constraint): Unit

def -=(b: Behaviour): Unit

def -=(v: Vec): Vec3

def -=(s: Float): Vec3

def /(v: Vec): Vec3

def /(s: Float): Vec3

def /=(v: Vec): Vec3

def /=(s: Float): Vec3

def :=(s: String): Vec3

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

def :=(s: Float): Vec3

def :=(v: Vec): Vec3

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

var _invWeight: Float

var _isLocked: Boolean

var _timestep: Float

var _timestepSq: Float

var _weight: Float

def add(s: BehaviourSet): Unit

def add(c: Constraint): Unit

def add(b: Behaviour): Unit

var age: Float

def angleBetween(v: Vec3): Unit

def applyBehaviours: Unit

def applyConstraints: Unit

def asInstanceOf[T0]: T0

var behaviours: ArrayBuffer[Behaviour]

var bounds: BoundingVolume

def canEqual(arg0: Any): Boolean

def clamp(max: Float): Vec3

def clearNeighbours: Unit

def clearVelocity: Vec3

def clone(): Vec3

var colour: Colour

var constraints: ArrayBuffer[Constraint]

def createBounds: Sphere

def cross(v: Vec3): Vec3

def cross(v: Vec3, result: Vec3): Vec3

def distance(v: Vec): Float

def distanceSquared(v: Vec): Float

def dot(v: Vec): Float

var drag: Float

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val force: Vec3

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

def hashCode(): Int

def init(v: Vec3): Unit

def interpolate(target: Vec3, delta: Float): Vec3

def invWeight: Float