ThreePipe
    Preparing search index...

    Class PivotControls2

    Extended PivotControls implementing threepipe's IWidget interface.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    activeAxes annotations assetType autoTransform axisColors camera children depthTest disableAxes disableRotations disableScaling disableSliders domElement enabled fixed getObjectById getObjectByName getObjectByProperty gizmoScale handleOpacity hoveredColor isWidget object parent refreshUi rotationLimits? rotationSnap scaleLimits? scaleSnap setDirty space translationLimits? translationSnap traverse traverseAncestors traverseVisible uniformScaleEnabled ObjectConstructors

    Accessors

    modelObject

    Methods

    attach detach dispose rebuild updateGizmoScale updateHandleVisibility

    Constructors

    Properties

    activeAxes: [boolean, boolean, boolean] = ...
    annotations: boolean

    Show value annotations during drag.

    assetType: "widget" = ...
    autoTransform: boolean = true
    axisColors: [number, number, number] = ...
    camera: Camera
    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.

    []

    depthTest: boolean

    Whether gizmo materials use depth testing. false = always visible through objects.

    disableAxes: boolean
    disableRotations: boolean
    disableScaling: boolean
    disableSliders: boolean
    domElement: HTMLCanvasElement
    enabled: boolean = true
    fixed: boolean

    When true, gizmo maintains constant screen size regardless of camera distance (default).

    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

    gizmoScale: number

    Scale multiplier for the gizmo, same as TransformControls 'size'. Applied per-frame.

    handleOpacity: number = 0.95
    hoveredColor: number = 0xffff40
    isWidget: true = ...
    object:
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >
    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: any = ...
    rotationLimits?: (undefined | [number, number])[]
    rotationSnap: null | number
    scaleLimits?: (undefined | [number, number])[]
    scaleSnap: null | number
    setDirty: any = ...

    Dispatches 'objectUpdate' event on object.

    space: "world" | "local"

    Coordinate space for transformations. 'world' or 'local'.

    translationLimits?: (undefined | [number, number])[]
    translationSnap: null | number

    Snap values when shift is held. Set to null to disable snapping for that transform.

    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.

    uniformScaleEnabled: boolean

    When true, alt/option+drag on a scale sphere applies uniform scale.

    ObjectConstructors: {
        LineBasicMaterial: typeof LineBasicMaterial;
        MeshBasicMaterial: typeof MeshBasicMaterial;
    } = ...

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods