field.kit.particle.behaviour

AttractorCircular

class AttractorCircular extends AttractorPoint

An attractor the drags particles on an orbit around a point It is essentially a 2D behaviour that operates on a plane (z=0)

Inherits

  1. AttractorPoint
  2. Behaviour
  3. Nameable
  4. Logger
  5. AnyRef
  6. Any

Value Members

  1. def apply(p: Particle, dt: Float): Unit

  2. 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
  3. def error(m: Any*): Unit

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

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

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

  7. var flock: field.kit.particle.Flock[_ <: field.kit.particle.Particle]

  8. 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
  9. var homing: Float

    weight of the homing force

    weight of the homing force

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

  11. def init: Unit

  12. var isEnabled: Boolean

  13. def logName: String

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

  15. var name: String

  16. var position: Vec3

    normalized value [0,1]

    normalized value [0,1]

    definition classes: AttractorPoint
  17. def prepare(dt: Float): Unit

  18. var ps: ParticleSystem

  19. var radius: Float

    normalized value [0,1]

    normalized value [0,1]

  20. var range: Float

    normalized value [0,1]

    normalized value [0,1]

    definition classes: AttractorPoint
  21. var tangential: Float

    weight of the tangential force

    weight of the tangential force

  22. 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
  23. def toggle: Unit

  24. var variation: Int

    left and right turn variation

    left and right turn variation

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

  26. var weight: Float

Instance constructors

  1. new AttractorCircular()

  2. new AttractorCircular(name: String)