Class LineHelper

Hierarchy (View Summary)

AHelperWidget
- LineHelper

Index

Constructors

constructor

new LineHelper(line: LineType): LineHelper
Parameters
- line: LineType
Returns LineHelper
Overrides AHelperWidget.constructor
- Defined in src/three/widgets/LineHelper.ts:62

Properties

assetType

assetType: string = 'widget'

autoUpgradeChildren

autoUpgradeChildren: boolean = false

editableHandleColor

editableHandleColor: number = 0xEF0065

editableHandleSize

editableHandleSize: number = 0.1

handleColor

handleColor: number = 0x0093FD

handleSize

handleSize: number = 0.05

isWidget

isWidget: true = ...

line

line: LineType

modelObject

modelObject: LineHelper = ...

Deprecated

not required

object

object: undefined | Object3D<Object3DEventMap> & IUiConfigContainer<any, string>

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

visible

visible: boolean = true

Object gets rendered if true.

Default Value

true

Methods

`Protected`_objectBeforeRender

_objectBeforeRender(): void
Returns void
Inherited from AHelperWidget._objectBeforeRender
- Defined in src/three/widgets/AHelperWidget.ts:50

`Protected`_objectUpdate

_objectUpdate(): void
Returns void
Inherited from AHelperWidget._objectUpdate
- Defined in src/three/widgets/AHelperWidget.ts:46

attach

attach(object: Object3D): this
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D
Returns this
Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See
add
Inherited from AHelperWidget.attach
- Defined in src/three/widgets/AHelperWidget.ts:56

detach

detach(): this
Returns this
Inherited from AHelperWidget.detach
- Defined in src/three/widgets/AHelperWidget.ts:71

dispose

dispose(): void
Returns void
Overrides AHelperWidget.dispose
- Defined in src/three/widgets/LineHelper.ts:212

update

update(): void
Returns void
Overrides AHelperWidget.update
- Defined in src/three/widgets/LineHelper.ts:85

`Static`Check

Check(obj: Object3D): true
Parameters
- obj: Object3D
Returns true
- Defined in src/three/widgets/LineHelper.ts:219

`Static`Create

Create(obj: Object3D): LineHelper
Parameters
- obj: Object3D
Returns LineHelper
- Defined in src/three/widgets/LineHelper.ts:223