ThreePipe
    Preparing search index...

    Class SkeletonHelper2

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _sChildren? assetType autoUpdate bones children color1 color2 geometry getObjectById getObjectByName getObjectByProperty hMaterial isWidget lineSegments lineWidth material object parent refreshUi setDirty traverse traverseAncestors traverseVisible uiConfig userData visible

    Accessors

    modelObject

    Methods

    _objectBeforeRender _objectUpdate attach detach dispose update updateMatrixWorld Check Create

    Constructors

    Properties

    Optional Internal_sChildren

    _sChildren?: Object3D<Object3DEventMap>[]

    If this is present, only the objects in this array will be saved in the glb/gltf files, and the object.children array will be ignored. The other properties are expected to be loaded/filled at runtime by default values or from an external asset loaded from IImportResultUserData.rootPath.

    • for embedded objects.
    assetType: "widget" = ...
    autoUpdate: boolean = true
    bones: Bone<Object3DEventMap>[]
    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[]

    Array with object's children.

    THREE.Object3DGroup | Group for info on manually grouping objects.

    []

    color1: Color = ...
    color2: Color = ...
    geometry: undefined
    getObjectById: (
        id: number,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    Type declaration

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    id

    getObjectByName: (
        name: string,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    Type declaration

    Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

    getObjectByProperty: (
        name: string,
        value: string,
    ) =>
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

    Type declaration

    hMaterial: LineMaterial2
    isWidget: true = ...
    lineSegments: LineSegments2
    lineWidth: number = 5
    material: undefined
    object: undefined | Object3D<Object3DEventMap> & IUiConfigContainer<any, string>
    parent:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >

    Object's parent in the scene graph.

    An object can have at most one parent.

    null

    refreshUi: (this: IObject3D) => void = iObjectCommons.refreshUi
    setDirty: (
        this: IObject3D,
        options?: IObjectSetDirtyOptions,
        ...args: any[],
    ) => void = iObjectCommons.setDirty

    Dispatches 'objectUpdate' event on object.

    traverse: (callback: (object: IObject3D) => void) => void

    Executes the callback on this object and all descendants.

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Note: Modifying the scene graph inside the callback is discouraged.

    traverseAncestors: (callback: (object: IObject3D) => void) => void

    Executes the callback on all ancestors.

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Note: Modifying the scene graph inside the callback is discouraged.

    traverseVisible: (callback: (object: IObject3D) => void) => void

    Like traverse, but the callback will only be executed for visible objects

    Type declaration

      • (callback: (object: IObject3D) => void): void

      • Parameters

        • callback: (object: IObject3D) => void

          A function with as first argument an Object3D object.

        Returns void

    Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

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

    An object that can be used to store custom data about the Object3D.

    It should not hold references to functions as these will not be cloned.

    {}

    visible: boolean = true

    Object gets rendered if true.

    true

    Accessors

    • get modelObject(): this

      Returns this

      use this instead

    Methods

    Protected_objectBeforeRender

    Protected_objectUpdate

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods