magnitude of gravity
Optional opt_simList: SimListoptional SimList to observe for when objects are added; also adds all existing bodies on that SimList.
Adds any MassObjects with finite mass among the given list of SimObjects.
set of SimObjects to possibly add
Adds the SimObject to list of objects that GravityLaw applies forces to, but only if it has positive finite mass
the SimObject to possibly add
Adds the given Observer to this Subject's list of Observers, so that the Observer
will be notified of changes in this Subject. An Observer may call Subject.addObserver
during its observe method.
the Observer to add
Adds the Parameter to the list of this Subject's available Parameters.
the Parameter to add
if a Parameter with the same name already exists.
Notifies all Observers that this Subject has changed by calling observe on each Observer.
An Observer may call addObserver or removeObserver during its observe
method.
a SubjectEvent with information relating to the change
Notifies all Observers that the Parameter with the given name has changed by calling observe on each Observer.
the language-independent or English name of the Parameter that has changed
if there is no Parameter with the given name
Connect to the given SimList, so that the force applies to all objects in the SimList. Also adds all existing bodies on that SimList. *
the SimList to connect with
Ensures this ForceLaw is not connected to anything and so can be garbage collected. For example, if this ForceLaw is an Observer, this will stop observing its Subject.
Returns list of MassObjects being affected by this ForceLaw.
list of MassObjects being affected by this ForceLaw
Protected getReturns whether broadcasting is enabled for this Subject. See setBroadcast.
whether broadcasting is enabled for this Subject
Returns the ParameterBoolean with the given name.
the language-independent or English name of the ParameterBoolean
the ParameterBoolean with the given name
if there is no ParameterBoolean with the given name
Returns the ParameterNumber with the given name.
the language-independent or English name of the ParameterNumber
the ParameterNumber with the given name
if there is no ParameterNumber with the given name
Returns the ParameterString with the given name.
the language-independent or English name of the ParameterString
the ParameterString with the given name
if there is no ParameterString with the given name
Returns the vertical world coordinate where a body has zero potential energy. Can override for a particular body with MassObject.setZeroEnergyLevel.
the vertical world coordinate where a body has zero potential energy
Notifies this Observer that a change has occurred in the Subject.
contains information about what has changed in the Subject: typically either a one-time GenericEvent, or a change to the value of a Parameter
Removes the Observer from this Subject's list of Observers. An Observer may
call removeObserver during its observe method.
the Observer to detach from list of Observers
Removes the Parameter from the list of this Subject's available Parameters.
the Parameter to remove
Protected setSets whether this Subject will broadcast events, typically used to temporarily disable broadcasting. Intended to be used in situations where a subclass overrides a method that broadcasts an event. This allows the subclass to prevent the superclass broadcasting that event, so that the subclass can broadcast the event when the method is completed.
whether this Subject should broadcast events
the previous value
Sets the vertical world coordinate where a body has zero potential energy. Can override for a particular body with MassObject.setZeroEnergyLevel.
the vertical world coordinate where a body has zero potential energy
Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.
For an object whose main purpose is to represent another Printable object, it is
recommended to include the result of calling toStringShort on that other object.
For example, calling toStringShort() on a DisplayShape might return something like
this:
DisplayShape{polygon:Polygon{'chain3'}}
a minimal string representation of this object.
Generated using TypeDoc
Applies constant downward gravitational force to a set of MassObjects.
The set of objects can be specified with the addBody method, or the GravityLaw can observe a SimList and automatically add all bodies that have mass to the set of objects.
Zero Energy Level
GravityLaw has a default zero potential energy level which is used for MassObjects that return null from getZeroEnergyLevel. This allows adding objects to a simulation without needing to set the zero energy level on each object. You can override this default zero energy level for an object with MassObject.setZeroEnergyLevel.
Parameters Created
ParameterNumber named
GRAVITY, see setGravityParameterNumber named
ZERO_ENERGY, see setZeroEnergyLevel