Class SliderPath

Represents a slider's path.

Hierarchy

SliderPath

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SliderPath(values: { controlPoints: <internal>.Vector2[]; expectedDistance: number; pathType: <internal>.PathType }): <internal>.SliderPath

- Defined in osu-base/typings/index.d.ts:3091
Parameters
- values: { controlPoints: <internal>.Vector2[]; expectedDistance: number; pathType: <internal>.PathType }
  - controlPoints: <internal>.Vector2[]
    
    The anchor points of the slider.
  - expectedDistance: number
    
    The distance that is expected when calculating slider path.
  - pathType: <internal>.PathType
    
    The path type of the slider.
Returns <internal>.SliderPath

Properties

Readonly calculatedPath

calculatedPath: <internal>.Vector2[]

The calculated path of the slider.

Readonly controlPoints

controlPoints: <internal>.Vector2[]

The control points (anchor points) of the slider.

Readonly cumulativeLength

cumulativeLength: number[]

The cumulative length of the slider.

Readonly expectedDistance

expectedDistance: number

Distance that is expected when calculating slider path.

isInitialized

isInitialized: boolean

Whether or not the instance has been initialized.

Readonly pathType

pathType: <internal>.PathType

The path type of the slider.

Methods

calculateCumulativeLength

calculateCumulativeLength(): void

- Defined in osu-base/typings/index.d.ts:3120
Calculates the slider's cumulative length.

Returns void

calculatePath

calculatePath(): void

- Defined in osu-base/typings/index.d.ts:3112
Calculates the slider's path.

Returns void

calculateSubPath

calculateSubPath(subControlPoints: <internal>.Vector2[]): <internal>.Vector2[]

- Defined in osu-base/typings/index.d.ts:3116
Calculates the slider's subpath.

Parameters
- subControlPoints: <internal>.Vector2[]
Returns <internal>.Vector2[]

ensureInitialized

ensureInitialized(): void

- Defined in osu-base/typings/index.d.ts:3108
Initializes the instance.

Returns void

positionAt

positionAt(progress: number): <internal>.Vector2

- Defined in osu-base/typings/index.d.ts:3127
Computes the position on the slider at a given progress that ranges from 0 (beginning of the path) to 1 (end of the path).

Parameters
- progress: number
  
  Ranges from 0 (beginning of the path) to 1 (end of the path).
Returns <internal>.Vector2

Generated using TypeDoc