Class LineCurve

An extensible curve object which contains methods for interpolation class Curve

Hierarchy

Curve<THREE.Vector2>
- LineCurve

Index

Constructors

constructor

new LineCurve(v1: THREE.Vector2, v2: THREE.Vector2): LineCurve
Parameters
- v1: THREE.Vector2
- v2: THREE.Vector2
Returns LineCurve
Overrides Curve.constructor
- Defined in node_modules/@types/three/src/extras/curves/LineCurve.d.ts:5

Properties

arcLengthDivisions

arcLengthDivisions: number

This value determines the amount of divisions when calculating the cumulative segment lengths of a curve via .getLengths. To ensure precision when using methods like .getSpacedPoints, it is recommended to increase .arcLengthDivisions if the curve is very large.

Default

200

type

type: string

Default

'LineCurve'

v1

v1: THREE.Vector2

Default

new THREE.Vector2()

v2

v2: THREE.Vector2

Default

new THREE.Vector2()

Methods

clone

clone(): LineCurve
Returns LineCurve
Inherited from Curve.clone
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:92

computeFrenetFrames

computeFrenetFrames(segments: number, closed?: boolean): {
    binormals: THREE.Vector3[];
    normals: THREE.Vector3[];
    tangents: THREE.Vector3[];
}
Generate Frenet frames of the curve
Parameters
- segments: number
- Optional closed: boolean
Returns {
    binormals: THREE.Vector3[];
    normals: THREE.Vector3[];
    tangents: THREE.Vector3[];
}
- binormals: THREE.Vector3[]
- normals: THREE.Vector3[]
- tangents: THREE.Vector3[]
Inherited from Curve.computeFrenetFrames
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:83

copy

copy(source: Curve<THREE.Vector2>): LineCurve
Parameters
- source: Curve<THREE.Vector2>
Returns LineCurve
Inherited from Curve.copy
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:93

fromJSON

fromJSON(json: object): LineCurve
Parameters
- json: object
Returns LineCurve
Inherited from Curve.fromJSON
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:95

getLength

getLength(): number
Get total curve arc length

Returns number
Inherited from Curve.getLength
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:50

getLengths

getLengths(divisions?: number): number[]
Get list of cumulative segment lengths
Parameters
- Optional divisions: number
Returns number[]
Inherited from Curve.getLengths
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:55

getPoint

getPoint(t: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a vector for point t of the curve where t is between 0 and 1 getPoint(t: number, optionalTarget?: T): T;
Parameters
- t: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Curve.getPoint
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:27

getPointAt

getPointAt(u: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a vector for point at relative position in curve according to arc length getPointAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Curve.getPointAt
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:33

getPoints

getPoints(divisions?: number): THREE.Vector2[]
Get sequence of points using getPoint( t ) getPoints(divisions?: number): T[];
Parameters
- Optional divisions: number
Returns THREE.Vector2[]
Inherited from Curve.getPoints
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:39

getSpacedPoints

getSpacedPoints(divisions?: number): THREE.Vector2[]
Get sequence of equi-spaced points using getPointAt( u ) getSpacedPoints(divisions?: number): T[];
Parameters
- Optional divisions: number
Returns THREE.Vector2[]
Inherited from Curve.getSpacedPoints
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:45

getTangent

getTangent(t: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns a unit vector tangent at t. If the subclassed curve do not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation getTangent(t: number, optionalTarget?: T): T;
Parameters
- t: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Curve.getTangent
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:72

getTangentAt

getTangentAt(u: number, optionalTarget?: THREE.Vector2): THREE.Vector2
Returns tangent at equidistance point u on the curve getTangentAt(u: number, optionalTarget?: T): T;
Parameters
- u: number
- Optional optionalTarget: THREE.Vector2
Returns THREE.Vector2
Inherited from Curve.getTangentAt
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:78

getUtoTmapping

getUtoTmapping(u: number, distance: number): number
Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equi distance
Parameters
- u: number
- distance: number
Returns number
Inherited from Curve.getUtoTmapping
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:65

toJSON

toJSON(): object
Returns object
Inherited from Curve.toJSON
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:94

updateArcLengths

updateArcLengths(): void
Update the cumlative segment distance cache

Returns void
Inherited from Curve.updateArcLengths
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:60

`Static` create

create(constructorFunc: (() => void), getPointFunc: (() => void)): (() => void)
Deprecated
since r84.
Parameters
- constructorFunc: (() => void)
  - - (): void
    - Returns void
- getPointFunc: (() => void)
  - - (): void
    - Returns void
Returns (() => void)
- - (): void
  - Deprecated
    since r84.
    
    Returns void
Inherited from Curve.create
- Defined in node_modules/@types/three/src/extras/core/Curve.d.ts:100

Class LineCurve

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

v1: THREE.Vector2

v2: THREE.Vector2

Returns LineCurve

Properties

arcLengthDivisions

Default

type

Default

v1

Default

v2

Default

Methods

clone

Returns LineCurve

computeFrenetFrames

Parameters

segments: number

Optional closed: boolean

Returns { binormals: THREE.Vector3[]; normals: THREE.Vector3[]; tangents: THREE.Vector3[]; }

binormals: THREE.Vector3[]

normals: THREE.Vector3[]

tangents: THREE.Vector3[]

copy

Parameters

source: Curve<THREE.Vector2>

Returns LineCurve

fromJSON

Parameters

json: object

Returns LineCurve

getLength

Returns number

getLengths

Parameters

Optional divisions: number

Returns number[]

getPoint

Parameters

t: number

Optional optionalTarget: THREE.Vector2

Returns THREE.Vector2

getPointAt

Parameters

u: number

Optional optionalTarget: THREE.Vector2

Returns THREE.Vector2

getPoints

Parameters

Optional divisions: number

Returns THREE.Vector2[]

getSpacedPoints

Parameters

Optional divisions: number

Returns THREE.Vector2[]

getTangent

Parameters

t: number

Optional optionalTarget: THREE.Vector2

Returns THREE.Vector2

getTangentAt

Parameters

u: number

Optional optionalTarget: THREE.Vector2

Returns THREE.Vector2

getUtoTmapping

Parameters

u: number

distance: number

Returns number

toJSON

`Optional` closed: boolean

Returns {
binormals: THREE.Vector3[];
normals: THREE.Vector3[];
tangents: THREE.Vector3[];
}

`Optional` divisions: number

`Optional` optionalTarget: THREE.Vector2

`Optional` optionalTarget: THREE.Vector2

`Optional` divisions: number

`Optional` divisions: number

`Optional` optionalTarget: THREE.Vector2

`Optional` optionalTarget: THREE.Vector2

`Static` create