Class LinearCurveMapper

Approximate spline curve by subdividing it into smaller linear line segments. Used to approximate length and mapping between uniform (u) and non-uniform (t) time along curve.

Hierarchy

AbstractCurveMapper
- LinearCurveMapper

Index

Constructors

constructor

new LinearCurveMapper(subDivisions?: number, onInvalidateCache?: (() => void)): LinearCurveMapper
Parameters
- subDivisions: number = 300
  
  number of sub divisions to use
- onInvalidateCache: (() => void) = null
  
  callback function to be invoked when cache is invalidated
  - - (): void
    - Returns void
Returns LinearCurveMapper
Overrides AbstractCurveMapper.constructor
- Defined in curve-mappers/segmented-curve-mapper.ts:21

Properties

_alpha

_alpha: number = 0.0

_cache

_cache: object

_closed

_closed: boolean = false

_onInvalidateCache

_onInvalidateCache: (() => void) = null

Type declaration

- (): void
- Returns void

_points

_points: Vector[]

_subDivisions

_subDivisions: number

_tension

_tension: number = 0.5

Accessors

alpha

get alpha(): number
Curve alpha parameter (0=uniform, 0.5=centripetal, 1=chordal)

Returns number
Inherited from AbstractCurveMapper.alpha
- Defined in curve-mappers/abstract-curve-mapper.ts:61
set alpha(alpha: number): void
Parameters
- alpha: number
Returns void
Inherited from AbstractCurveMapper.alpha
- Defined in curve-mappers/abstract-curve-mapper.ts:62

arcLengths

get arcLengths(): any
Returns any
- Defined in curve-mappers/segmented-curve-mapper.ts:26

closed

get closed(): boolean
Determines whether the curve should be a closed curve or not

Returns boolean
Inherited from AbstractCurveMapper.closed
- Defined in curve-mappers/abstract-curve-mapper.ts:93
set closed(closed: boolean): void
Parameters
- closed: boolean
Returns void
Inherited from AbstractCurveMapper.closed
- Defined in curve-mappers/abstract-curve-mapper.ts:94

points

get points(): Vector[]
Control points for curve

Returns Vector[]
Inherited from AbstractCurveMapper.points
- Defined in curve-mappers/abstract-curve-mapper.ts:83
set points(points: Vector[]): void
Parameters
- points: Vector[]
Returns void
Inherited from AbstractCurveMapper.points
- Defined in curve-mappers/abstract-curve-mapper.ts:84

tension

get tension(): number
Curve tension (0=Catmull-rom, 1=linear)

Returns number
Inherited from AbstractCurveMapper.tension
- Defined in curve-mappers/abstract-curve-mapper.ts:72
set tension(tension: number): void
Parameters
- tension: number
Returns void
Inherited from AbstractCurveMapper.tension
- Defined in curve-mappers/abstract-curve-mapper.ts:73

Methods

_invalidateCache

_invalidateCache(): void
Clear cache

Returns void
Overrides AbstractCurveMapper._invalidateCache
- Defined in curve-mappers/segmented-curve-mapper.ts:36

computeArcLengths

computeArcLengths(): any[]
Break curve into segments and return the curve length at each segment index. Used for mapping between t and u along the curve.

Returns any[]
- Defined in curve-mappers/segmented-curve-mapper.ts:45

evaluateForT

evaluateForT(func: SegmentFunction, t: number, target?: Vector): Vector
Evaluate curve segment function at t

Returns
vector
Parameters
- func: SegmentFunction
- t: number
  
  time along full curve (encodes segment index and segment t)
- Optional target: Vector
  
  optional target vector
Returns Vector
Inherited from AbstractCurveMapper.evaluateForT
- Defined in curve-mappers/abstract-curve-mapper.ts:112

getCoefficients

getCoefficients(idx: number): any
Get the curve function coefficients at the given segment index. The coefficients are calculated once per segment and put in cache until it is invalidated.

Returns
coefficients for the curve function at the given segment index
Parameters
- idx: number
  
  segment index
Returns any
Inherited from AbstractCurveMapper.getCoefficients
- Defined in curve-mappers/abstract-curve-mapper.ts:124

getT

getT(u: number): number
Maps a uniform time along the curve to non-uniform time (t)

Returns
t encoding segment index and local time along curve
Parameters
- u: number
  
  normalized uniform position along the spline curve
Returns number
Overrides AbstractCurveMapper.getT
- Defined in curve-mappers/segmented-curve-mapper.ts:76

getU

getU(t: number): number
Maps a non-uniform time along the curve to uniform time (u)

Returns
uniform time along curve
Parameters
- t: number
  
  non-uniform time along curve
Returns number
Overrides AbstractCurveMapper.getU
- Defined in curve-mappers/segmented-curve-mapper.ts:103

lengthAt

lengthAt(u: number): number
Get curve length at u

Returns
length in point coordinates
Parameters
- u: number
  
  normalized uniform position along the spline curve
Returns number
Overrides AbstractCurveMapper.lengthAt
- Defined in curve-mappers/segmented-curve-mapper.ts:66

reset

reset(): void
Returns void
Inherited from AbstractCurveMapper.reset
- Defined in curve-mappers/abstract-curve-mapper.ts:102

Class LinearCurveMapper

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

subDivisions: number = 300

onInvalidateCache: (() => void) = null

Returns void

Returns LinearCurveMapper

Properties

_alpha

_cache

_closed

_onInvalidateCache

Type declaration

Returns void

_points

_subDivisions

_tension

Accessors

alpha

Returns number

Parameters

alpha: number

Returns void

arcLengths

Returns any

closed

Returns boolean

Parameters

closed: boolean

Returns void

points

Returns Vector[]

Parameters

points: Vector[]

Returns void

tension

Returns number

Parameters

tension: number

Returns void

Methods

_invalidateCache

Returns void

computeArcLengths

Returns any[]

evaluateForT

Returns

Parameters

func: SegmentFunction

t: number

Optional target: Vector

Returns Vector

getCoefficients

Returns

Parameters

idx: number

Returns any

getT

Returns

Parameters

u: number

Returns number

getU

Returns

Parameters

t: number

Returns number

lengthAt

Returns

Parameters

u: number

Returns number

reset

`Optional` target: Vector