An Impulse is a sudden change in momentum, it acts on a given MassObject at a defined location and with a defined direction and magnitude.

The method getStartPoint gives the location in world coordinates where the Impulse is applied. The method getVector gives the direction and magnitude of the Impulse in world coordinates.

Hierarchy (view full)

Implements

Constructors

  • Parameters

    • name: string

      string indicating the type of impulse

    • body: MassObject

      the MassObject that the Impulse is applied to

    • magnitude: number

      the size of the impulse

    • location: Vector

      the location on the body where the impulse is applied, in world coordinates

    • direction: Vector

      a unit Vector giving the direction and magnitude of the Impulse, in world coordinates

    • offset: Vector

      vector from CM (center of mass) of body to point of impact, in world coords

    Returns Impulse

Properties

body_: MassObject

which body the impulse is applied to

direction_: Vector

direction of impulse, a unit vector, in world coords

location_: Vector

where the impulse is applied, in world coords

magnitude_: number

magnitude of impulse

offset_: Vector

offset vector from CM (center of mass) of body to point of impact, in world coords

ID: number = 1

Counter used for naming SimObjects.

Methods

  • Returns the magnitude of the impulse.

    Returns number

    the magnitude of the impulse.

  • Name of this SimObject, either the language-independent name for scripting purposes or the localized name for display to user.

    The language-independent name should be the same as the English version but capitalized and with spaces and dashes replaced by underscore, see Util.toName, nameEquals.

    The name should give an idea of the role of the SimObject in the simulation. This allows us to to treat an object in a special way depending on its name. For example, we might use the name to decide what type of DisplayObject to create to represent the SimObject.

    Parameters

    • Optional opt_localized: boolean

      true means return the localized version of the name; default is false which means return the language independent name.

    Returns string

    name of this SimObject

  • Returns the offset vector from CM (center of mass) of body to point of impact, in world coords

    Returns Vector

    the offset vector of the impulse.

  • Returns true if the given SimObject is similar to this SimObject for display purposes. SimObjects are similar when they are the same type and nearly the same size and location. Mainly used when showing forces - to avoid adding too many objects to the display. See SimList.getSimilar.

    Parameters

    • obj: SimObject

      the SimObject to compare to

    • Optional opt_tolerance: number

      the amount the object components can differ by

    Returns boolean

    true if this SimObject is similar to obj for display purposes

  • 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'}}
    

    Returns string

    a minimal string representation of this object.

Generated using TypeDoc