field.kit.particle

Particle

class Particle extends Vec3 with Logger

A single particle from the flock

known subclasses: StatefulParticle
Go to: companion

Inherits

  1. Logger
  2. Vec3
  3. Product
  4. Equals
  5. Vec
  6. AnyRef
  7. Any

Value Members

  1. var age: Float

  2. def canEqual(arg0: Any): Boolean

  3. 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.

    definition classes: Vec3 ⇐ AnyRef
    Go to: companion
  4. var colour: Colour

  5. var colourSteer: HSVA

  6. var colourSteerMax: Float

  7. var colourVelocity: HSVA

  8. var colourVelocityMax: Float

  9. 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: Vec3 ⇐ Equals ⇐ AnyRef ⇐ Any
    Go to: companion
  10. def error(m: Any*): Unit

  11. def fatal(code: Int, m: Any*): Unit

  12. def fatal(m: Any*): Unit

  13. def fine(m: Any*): Unit

  14. var flock: field.kit.particle.Flock[_]

  15. 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: Vec3 ⇐ AnyRef ⇐ Any
    Go to: companion
  16. var id: Int

  17. def info(m: Any*): Unit

  18. def init: Unit

    called automatically when the particle is added to the flock

    called automatically when the particle is added to the flock

    Go to: companion
  19. var lifeTime: Float

  20. def logName: String

  21. def logName_=(name: String): Unit

  22. def productArity: Int

  23. def productElement(arg0: Int): Any

  24. def productElements: Iterator[Any]

  25. def productIterator: Iterator[Any]

  26. def productPrefix: String

  27. var ps: ParticleSystem

  28. var size: Float

  29. var steer: Vec3

  30. var steerMax: Float

  31. def toLabel: String

  32. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    Go to: companion
  33. def update(dt: Float): Unit

  34. def updateColour(dt: Float): Unit

    integrates colour steering

    integrates colour steering

    Go to: companion
  35. def updatePosition(dt: Float): Unit

  36. var velocity: Vec3

  37. var velocityMax: Float

  38. def warn(m: Any*): Unit

  39. var x: Float

  40. var y: Float

  41. var z: Float

Instance constructors

  1. new Particle()

  2. new Particle(x: Float, y: Float, z: Float)