Class CustomPath

A path defined by custom equations. The equations are JavaScript string expressions where the parameter is t. There is an equation for both the x and y value.

NOTE: This class creates a global variable named t.

Hierarchy (view full)

AbstractPath
- CustomPath

Implements

ParametricPath

Index

Constructors

constructor

Methods

getClassName getFinishTValue getName getStartTValue getXEquation getYEquation isClosedLoop nameEquals setClosedLoop setFinishTValue setStartTValue setXEquation setYEquation toString x_func y_func

Constructors

constructor

new CustomPath(start_t?, finish_t?, name?, localName?): CustomPath
Parameters
- Optional start_t: number
  starting t value
- Optional finish_t: number
  ending t value
- Optional name: string
- Optional localName: string
Returns CustomPath
Overrides AbstractPath.constructor
- Defined in sims/roller/CustomPath.ts:41

Methods

getClassName

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

Returns string
name of class of this object.
Overrides AbstractPath.getClassName
- Defined in sims/roller/CustomPath.ts:60

getFinishTValue

getFinishTValue(): number
The ending value for t in the parameteric equation defining the path.

Returns number
ending value for t
Implementation of ParametricPath.getFinishTValue
Inherited from AbstractPath.getFinishTValue
- Defined in sims/roller/AbstractPath.ts:70

getName

getName(opt_localized?): string
Name of this object, 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 and nameEquals.
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 object
Implementation of ParametricPath.getName
Inherited from AbstractPath.getName
- Defined in sims/roller/AbstractPath.ts:65

getStartTValue

getStartTValue(): number
The starting value for t in the parameteric equation defining the path.

Returns number
starting value for t
Implementation of ParametricPath.getStartTValue
Inherited from AbstractPath.getStartTValue
- Defined in sims/roller/AbstractPath.ts:75

getXEquation

getXEquation(): string
Returns the parameteric X equation defining the path.

Returns string
the parameteric X equation defining the path
- Defined in sims/roller/CustomPath.ts:67

getYEquation

getYEquation(): string
Returns the parameteric Y equation defining the path.

Returns string
the parameteric Y equation defining the path
- Defined in sims/roller/CustomPath.ts:74

isClosedLoop

isClosedLoop(): boolean
Whether the path is a closed loop, ending at the same point it starts.

Returns boolean
whether the path is a closed loop
Implementation of ParametricPath.isClosedLoop
Inherited from AbstractPath.isClosedLoop
- Defined in sims/roller/AbstractPath.ts:80

nameEquals

nameEquals(name): boolean
Whether this ParametricPath has the given name, adjusting for the transformation to a 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 ParametricPath has the given name (adjusted to language-independent form)
Implementation of ParametricPath.nameEquals
Inherited from AbstractPath.nameEquals
- Defined in sims/roller/AbstractPath.ts:85

setClosedLoop

setClosedLoop(value): void
Sets whether the path is a closed loop, ending at the same point it starts.
Parameters
- value: boolean
  whether the path is a closed loop
Returns void
Inherited from AbstractPath.setClosedLoop
- Defined in sims/roller/AbstractPath.ts:92

setFinishTValue

setFinishTValue(value): void
Sets the ending value for t in the parameteric equation defining the path.
Parameters
- value: number
  ending value for t
Returns void
Inherited from AbstractPath.setFinishTValue
- Defined in sims/roller/AbstractPath.ts:99

setStartTValue

setStartTValue(value): void
Sets the starting value for t in the parameteric equation defining the path.
Parameters
- value: number
  starting value for t
Returns void
Inherited from AbstractPath.setStartTValue
- Defined in sims/roller/AbstractPath.ts:106

setXEquation

setXEquation(value): void
Sets the parameteric X equation defining the path. A JavaScript expression where the parameter is t.
Parameters
- value: string
  the parameteric X equation defining the path
Returns void
- Defined in sims/roller/CustomPath.ts:82

setYEquation

setYEquation(value): void
Sets the parameteric Y equation defining the path. A JavaScript expression where the parameter is t.
Parameters
- value: string
  the parameteric Y equation defining the path
Returns void
- Defined in sims/roller/CustomPath.ts:90

toString

toString(): string
Returns string
Inherit Doc
Overrides AbstractPath.toString
- Defined in sims/roller/CustomPath.ts:52

x_func

x_func(t): number
Returns the x value for the given value of t in the parametric equation.
Parameters
- t: number
  the value of t in the parametric equation
Returns number
the x value for the given value of t
Implementation of ParametricPath.x_func
Overrides AbstractPath.x_func
- Defined in sims/roller/CustomPath.ts:95

y_func

y_func(t): number
Returns the y value for the given value of t in the parametric equation.
Parameters
- t: number
  the value of t in the parametric equation
Returns number
the y value for the given value of t
Implementation of ParametricPath.y_func
Overrides AbstractPath.y_func
- Defined in sims/roller/CustomPath.ts:106

Class CustomPath

Hierarchy (view full)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional start_t: number

Optional finish_t: number

Optional name: string

Optional localName: string

Returns CustomPath

Methods

getClassName

Returns string

getFinishTValue

Returns number

getName

Parameters

Optional opt_localized: boolean

Returns string

getStartTValue

Returns number

getXEquation

Returns string

getYEquation

Returns string

isClosedLoop

Returns boolean

nameEquals

Parameters

name: string

Returns boolean

setClosedLoop

Parameters

value: boolean

Returns void

setFinishTValue

Parameters

value: number

Returns void

setStartTValue

Parameters

value: number

Returns void

setXEquation

Parameters

value: string

Returns void

setYEquation

Parameters

value: string

Returns void

toString

Returns string

Inherit Doc

x_func

Parameters

t: number

Returns number

y_func

Parameters

t: number

Returns number

Settings

Member Visibility

Theme

On This Page

`Optional` start_t: number

`Optional` finish_t: number

`Optional` name: string

`Optional` localName: string

`Optional` opt_localized: boolean