Class StringPath

Static ID

getChanged

• getChanged(): boolean

• Returns whether this SimObject has changed, and sets the state to "unchanged".

  Returns boolean

  whether this SimObject has changed

getExpireTime

• getExpireTime(): number

• Returns the expiration time, when this SimObject should be removed from the SimList. This is intended for temporary SimObjects that illustrate, for example, contact forces or collisions.

  Returns number

  the expiration time, in time frame of the Simulation clock

getName

• getName(opt_localized?): string

• 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

isMassObject

• isMassObject(): boolean

• Whether this implements the MassObject interface.

  Returns boolean

  Whether this implements the MassObject interface.

nameEquals

• nameEquals(name): boolean

• Whether this SimObject has the given name, adjusting for transformation to the language-independent form of the name, as is done by Util.toName.

  Parameters

  • name: string

    the English or language-independent version of the name

  Returns boolean

  whether this SimObject has the given name (adjusted to language-independent form)

setChanged

• setChanged(): void

• Marks that this SimObject has changed.

  Returns void

setExpireTime

• setExpireTime(time): void

• Sets the expiration time, when this SimObject should be removed from the SimList. This is intended for temporary SimObjects that illustrate, for example, contact forces or collisions.

  Parameters

  • time: number

    the expiration time, in time frame of the Simulation clock

  Returns void

similar

• similar(obj, _opt_tolerance?): boolean

• 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

toStringShort

• toStringShort(): string

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

  Returns string

  a minimal string representation of this object.