Class BoneHelper

Hierarchy (View Summary)

AHelperWidget
- BoneHelper

Index

Constructors

Properties

assetType autoUpdate color1 color2 isWidget lineSegments lineWidth material modelObject object uiConfig visible

Methods

_objectBeforeRender _objectUpdate attach detach dispose update updateMatrixWorld Check Create

Constructors

constructor

new BoneHelper(
    bone: Bone,
    color1?: ColorRepresentation,
    color2?: ColorRepresentation,
): BoneHelper
Parameters
- bone: Bone
- Optionalcolor1: ColorRepresentation
- Optionalcolor2: ColorRepresentation
Returns BoneHelper
Overrides AHelperWidget.constructor
- Defined in src/three/widgets/BoneHelper.ts:36

Properties

assetType

assetType: string = 'widget'

autoUpdate

autoUpdate: boolean = true

color1

color1: Color = ...

color2

color2: Color = ...

isWidget

isWidget: true = ...

lineSegments

lineSegments: LineSegments2

lineWidth

lineWidth: number = 5

material

material: LineMaterial2

modelObject

modelObject: BoneHelper = ...

Deprecated

not required

object

object: undefined | Bone & 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/BoneHelper.ts:115

update

update(setDirty?: boolean): void
Parameters
- setDirty: boolean = true
Returns void
Overrides AHelperWidget.update
- Defined in src/three/widgets/BoneHelper.ts:74

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.
Parameters
- Optionalforce: boolean
  A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.
Returns void
Overrides AHelperWidget.updateMatrixWorld
- Defined in src/three/widgets/BoneHelper.ts:69

`Static`Check

Check(object: Object3D): boolean
Parameters
- object: Object3D
Returns boolean
- Defined in src/three/widgets/BoneHelper.ts:121

`Static`Create

Create(bone: Bone): BoneHelper
Parameters
- bone: Bone
Returns BoneHelper
- Defined in src/three/widgets/BoneHelper.ts:125