Engine API Reference - v2.13.2
    Preparing search index...

    Class GSplatComponentSystem

    Allows an Entity to render a gsplat.

    Hierarchy (View Summary)

    Index

    Methods

    fire getGSplatMaterial hasEvent off on once

    Events

    EVENT_FRAMEREADY EVENT_MATERIALCREATED

    Methods

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Gets the GSplat material used by unified GSplat rendering for the given camera and layer.

      Returns null if the material hasn't been created yet. In unified mode, materials are created during the first frame update when the GSplat is rendered. To be notified immediately when materials are created, listen to the 'material:created' event on GSplatComponentSystem:

      Parameters

      • camera: Camera

        The camera instance.

      • layer: Layer

        The layer instance.

      Returns null | ShaderMaterial

      The material, or null if not created yet.

      app.systems.gsplat.on('material:created', (material, camera, layer) => {
          // Material is now available
          material.setParameter('myParam', value);
      });

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    Events

    EVENT_FRAMEREADY: string = 'frame:ready'

    Fired every frame for each camera and layer combination rendering GSplats in unified mode. The handler is passed the CameraComponent, the Layer, a boolean indicating if the current frame has up-to-date sorting, and a boolean indicating if resources are loading.

    The ready parameter indicates whether the current frame reflects all recent changes (camera movement, splat transforms, lod updates, etc.) with the latest sorting applied. The loading parameter indicates if octree LOD resources are still being loaded.

    This event is useful for video capture or other workflows that need to wait for frames to be fully ready. Only capture frames and move camera to next position when both ready === true and loading === false.

    app.systems.gsplat.on('frame:ready', (camera, layer, ready, loading) => {
        if (ready && !loading) {
            console.log(`Frame ready to capture for camera ${camera.entity.name}`);
            // Capture frame here
        }
    });
    EVENT_MATERIALCREATED: string = 'material:created'

    Fired when a GSplat material is created for a camera and layer combination. In unified mode, materials are created during the first frame update when the GSplat is rendered. The handler is passed the ShaderMaterial, the CameraComponent, and the Layer.

    This event is useful for setting up custom material chunks and parameters before the first render.

    app.systems.gsplat.on('material:created', (material, camera, layer) => {
        console.log(`Material created for camera ${camera.entity.name} on layer ${layer.name}`);
        // Set custom material parameters before first render
        material.setParameter('myParam', value);
    });

    Settings

    Member Visibility

    On This Page

    Methods
    Events