如视 Five SDK
    Preparing search index...

    Interface BaseHelper<OriginObject3D>Abstract

    interface BaseHelper<OriginObject3D extends Object3D = Object3D> {
        get helperObject(): Object3D;
        add(...objects: Object3D[]): BaseHelper<OriginObject3D>;
        addIfNotExists(...objects: Object3D[]): BaseHelper<OriginObject3D>;
        applyHelperQuaternion(quaternion: Quaternion, origin?: Vector3): void;
        applyHelperScaleMatrix4(matrix: Matrix4, origin?: Vector3): void;
        disable(): void;
        dispose(): void;
        enable(): void;
        hide(): void;
        initialPosition(offset?: Vector3): void;
        initQuaternion(
            config?: {
                xAxis?: Vector3 | (() => Vector3);
                yAxis?: Vector3 | (() => Vector3);
                zAxis?: Vector3 | (() => Vector3);
            },
        ): void;
        raycasterIntersectObject(
            raycaster: Raycaster,
            intersection?: Intersection[],
        ): Intersection[];
        remove(...objects: Object3D[]): BaseHelper<OriginObject3D>;
        removeChildren(): BaseHelper<OriginObject3D>;
        removeFromParent(): BaseHelper<OriginObject3D>;
        render(): void;
        setHelperQuaternion(quaternion: Quaternion, origin?: Vector3): void;
        setScaleByCamera(camera: PerspectiveCamera | OrthographicCamera): void;
        show(): void;
    }

    Type Parameters

    • OriginObject3D extends Object3D = Object3D

    Hierarchy (View Summary)

    Index

    Accessors

    • get helperObject(): Object3D

      Returns Object3D

    Methods

    • Adds object as child of this object.

      Parameters

      • ...objects: Object3D[]

      Returns BaseHelper<OriginObject3D>

    • Parameters

      • quaternion: Quaternion
      • Optionalorigin: Vector3

      Returns void

    • Parameters

      • matrix: Matrix4
      • Optionalorigin: Vector3

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • Optionaloffset: Vector3

      Returns void

    • Parameters

      • Optionalconfig: {
            xAxis?: Vector3 | (() => Vector3);
            yAxis?: Vector3 | (() => Vector3);
            zAxis?: Vector3 | (() => Vector3);
        }

      Returns void

    • Parameters

      • raycaster: Raycaster
      • intersection: Intersection[] = []

      Returns Intersection[]

    • Removes object as child of this object.

      Parameters

      • ...objects: Object3D[]

      Returns BaseHelper<OriginObject3D>

    • Returns void

    • Parameters

      • quaternion: Quaternion
      • Optionalorigin: Vector3

      Returns void

    • Parameters

      • camera: PerspectiveCamera | OrthographicCamera

      Returns void

    • Returns void