Class WidgetComponentSpline

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentSpline

Index

Constructors

Properties

componentType location lockToSurface name offset splineType valid visible widget

Methods

delete getControlPoints getInterpolatedPoints setControlPoints

Constructors

`Private`constructor

new WidgetComponentSpline(): WidgetComponentSpline
Returns WidgetComponentSpline
Overrides WidgetComponentBase.constructor

Properties

`Readonly`componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

`Readonly`location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

lockToSurface

lockToSurface: boolean

Remarks

This property can't be edited in read-only mode.

`Readonly`name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

offset

offset: Vector3

Remarks

This property can't be edited in read-only mode.

splineType

splineType: SplineType

Remarks

This property can't be edited in read-only mode.

`Readonly`valid

valid: boolean

visible

visible: boolean

`Readonly`widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

Methods

delete

delete(): void
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

Inherited from WidgetComponentBase.delete

getControlPoints

getControlPoints(): Widget[]
Returns Widget[]
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

InvalidWidgetComponentError

InvalidWidgetError

getInterpolatedPoints

getInterpolatedPoints(maxPointsPerControlSegment?: number): Vector3[]
Parameters
- OptionalmaxPointsPerControlSegment: number
Returns Vector3[]
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

setControlPoints

setControlPoints(widgetList: Widget[]): void
Parameters
- widgetList: Widget[]
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

InvalidWidgetError