DOCSEARCHbyAlgolia
Submit Docs

PlayCanvas Splat Transform API

website·Indexed 38 days ago

https://api.playcanvas.com/

A library for processing and transforming splat models, featuring functions for reading and writing PLY, voxel, and image formats, as well as tools for decimation, LOD management, and data table manipulation.

Tokens
447.7K
Snippets
3.2K
Records
4.1K
Agent score
64%

What's inside Splat Transform

  1. Overview of PlayCanvas Web Components

    The @playcanvas/web-components package provides custom HTML elements for building 3D web apps with the PlayCanvas Engine. These elements allow for declarative authoring in HTML. The JavaScript API provides element classes whose properties mirror their HTML attributes and expose the underlying engine objects.

  2. Overview of ParticleSystemComponentSystem

    The ParticleSystemComponentSystem is a PlayCanvas component system that enables an Entity to render a particle system. It inherits from ComponentSystem and includes a full suite of event handling methods (on, off, once, fire, hasEvent) for managing custom event triggers and listeners.

  3. Overview of the Mouse class

    The Mouse class manages mouse input by tracking button states and dispatching events. It extends EventHandler to fire mousedown, mouseup, mousemove, and mousewheel events. To detect mouse events, the Mouse instance must be attached to a DOM element. In a standard PlayCanvas application, the instance is managed and accessible via AppBase.mouse.

  4. Overview of DepthState in PlayCanvas

    DepthState is a descriptor that defines how the depth value of a fragment is used by the rendering pipeline. It can be applied to a material via Material#depthState or to the graphics device using GraphicsDevice#setDepthState. For optimal performance, it is recommended to create multiple DepthState instances and assign them as needed rather than modifying an existing state after creation.

  5. Overview of StandardMaterial properties

    The StandardMaterial class is a general-purpose material for rendering surfaces and simulating dynamic reflected light. It supports a comprehensive set of PBR parameters, including:

    • Basic Surface Properties: Diffuse, specular, metalness, gloss, and opacity.
    • Advanced Effects: Clear coat, iridescence, sheen, and refraction.
    • Mapping & Detail: Support for various maps (Diffuse, Normal, Gloss, Metalness, AO, Emissive, Height, etc.) with individual controls for tiling, offset, rotation, and UV channels.
    • Lighting & Environment: Ambient lighting, cube maps, and light maps.
    • Technical Controls: Alpha testing, alpha-to-coverage, anisotropy, parallax mapping, and stencil settings.

  8. Overview of PlayCanvas Web Components

    The @playcanvas/web-components package provides a set of custom HTML elements that allow developers to build 3D web applications declaratively. These elements mirror PlayCanvas Engine objects; their JavaScript properties correspond to their HTML attributes and provide access to the underlying engine objects.

  10. Overview of RigidBodyComponentSystem

    The RigidBodyComponentSystem manages the physics simulation for all rigid body components in the application. It is accessed via app.systems.rigidbody. Its primary responsibilities include owning the physics world, creating/destroying bodies for rigid body and collision components, stepping the simulation once per frame, and updating entity transforms based on simulation results. It also handles global settings like gravity, performs raycasts, and reports collisions.

    Requirement: The system is only functional after a physics backend is installed. This can be done by:

    1. Supplying physicsWorld in AppOptions during application creation.
    2. Automatically loading the Ammo.js WasmModule.

  11. Overview of AnimBlendTree

    The AnimBlendTree class is used to store and blend multiple AnimNode objects. BlendTrees can be nested as children of other AnimBlendTree instances to create a complex hierarchy of animation nodes. The blending behavior is determined by a blend type, which calculates the weights of children based on current parameter values.

  12. Overview of ScriptHandler

    The ScriptHandler class is a specialized ResourceHandler used to load JavaScript files dynamically. It supports two primary types of JS files: PlayCanvas scripts that contain calls to createScript and standard third-party JavaScript libraries.