Class SinePulseShape

Hierarchy (view full)

AbstractStringShape
- SinePulseShape

Implements

StringShape

Index

Constructors

Methods

getClassName getLength getName position toString velocity

Constructors

constructor

new SinePulseShape(length): SinePulseShape
Parameters
- length: number
Returns SinePulseShape
Overrides AbstractStringShape.constructor
- Defined in sims/pde/StringShapes.ts:136

Methods

getClassName

getClassName(): string
Returns name of class of this object.

Returns string
name of class of this object.
Implementation of StringShape.getClassName
Overrides AbstractStringShape.getClassName
- Defined in sims/pde/StringShapes.ts:142

getLength

getLength(): number
Returns the length of the string.

Returns number
length of the string
Implementation of StringShape.getLength
Inherited from AbstractStringShape.getLength
- Defined in sims/pde/AbstractStringShape.ts:63

getName

getName(opt_localized?): string
Name of this StringShape, either a the language-independent name for scripting purposes or the localized name for display to user.
Parameters
- opt_localized: boolean = false
  true means return the localized version of the name; default is false which means return the language independent name.
Returns string
name of this StringShape
Implementation of StringShape.getName
Inherited from AbstractStringShape.getName
- Defined in sims/pde/AbstractStringShape.ts:68

position

position(x): number
Returns the initial displacement at a point on the string.
Parameters
- x: number
  the location of the point of the string
Returns number
the displacement at that point of the string
Implementation of StringShape.position
Overrides AbstractStringShape.position
- Defined in sims/pde/StringShapes.ts:147

toString

toString(): string
Returns string
Inherit Doc
Inherited from AbstractStringShape.toString
- Defined in sims/pde/AbstractStringShape.ts:53

velocity

velocity(x): number
Returns the initial velocity at a point of the string.
Parameters
- x: number
  the location of the point of the string
Returns number
the velocity at that point of the string
Implementation of StringShape.velocity
Overrides AbstractStringShape.velocity
- Defined in sims/pde/StringShapes.ts:157

Generated using TypeDoc