Threepipe Gaussian Splatting Plugin
    Preparing search index...

    Class GaussianSplatMesh

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    assetType children dispose geometry getObjectById getObjectByName getObjectByProperty isGaussianSplatMesh material materials parent refreshUi setDirty traverse traverseAncestors traverseVisible userData

    Accessors

    modelObject

    Methods

    raycast update

    Constructors

    Properties

    assetType: "model" = ...
    children: IObject3D<
        IObject3DEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
        | undefined,
        IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
    >[]

    Array with object's children.

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

    []

    dispose: (removeFromParent?: boolean) => void

    Type Declaration

      • (removeFromParent?: boolean): void

      • Parameters

        • OptionalremoveFromParent: boolean

          remove from parent. Default true

        Returns void

    geometry: GaussianSplatGeometry

    An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.

    THREE.BufferGeometry | new THREE.BufferGeometry().

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

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

    Type Declaration

      • (
            id: number,
        ):
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined

      • Parameters

        • id: number

          Unique number of the object instance. Expects a Integer

        Returns
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined

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

    id

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

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

    Type Declaration

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

      • Parameters

        • name: string

          String to match to the children's Object3D.name property.

        Returns
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined

    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,
    ) =>
        | IObject3D<
            IObject3DEventMap,
            IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | undefined,
            IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
        >
        | undefined

    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

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

      • Parameters

        • name: string

          the property name to search for.

        • value: string

          value of the given property.

        Returns
            | IObject3D<
                IObject3DEventMap,
                IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | undefined,
                IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
            >
            | undefined

    isGaussianSplatMesh: true
    material: IMaterial

    An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.

    THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

    materials: IMaterial<IMaterialEventMap>[]

    Same as material but always returns an array. To set, just set material property

    parent:
        | IObject3D<
            IObject3DEventMap,
            IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
            | undefined,
            IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
        >
        | null

    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.

    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.

    {}

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods