glTF-Transform GitHub stars
Options
Menu

LightsPunctual

KHR_lights_punctual defines three "punctual" light types: directional, point and spot.

Punctual lights are parameterized, infinitely small points that emit light in well-defined directions and intensities. Lights are referenced by nodes and inherit the transform of that node.

Properties:

Example

 
import { LightsPunctual, Light, LightType } from '@gltf-transform/extensions';

// Create an Extension attached to the Document.
const lightsExtension = document.createExtension(LightsPunctual);

// Create a Light property.
const light = lightsExtension.createLight()
    .setType(LightType.POINT)
    .setIntensity(2.0)
    .setColor([1.0, 0.0, 0.0]);

// Attach the property to a Material.
node.setExtension('KHR_lights_punctual', light);

Hierarchy

  • Extension
    • LightsPunctual

Properties

extensionName: "KHR_lights_punctual" = ...
EXTENSION_NAME: "KHR_lights_punctual" = ...

Methods

  • createLight(name?: string): Light
  • dispose(): void

  • Disables and removes the extension from the Document.

  • isRequired(): boolean

  • Indicates to the client whether it is OK to load the asset when this extension is not recognized. Optional extensions are generally preferred, if there is not a good reason to require a client to completely fail when an extension isn't known.

  • listProperties(): ExtensionProperty<IProperty>[]

  • Lists all ExtensionProperty instances associated with, or created by, this extension. Includes only instances that are attached to the Document's graph; detached instances will be excluded.

  • Indicates to the client whether it is OK to load the asset when this extension is not recognized. Optional extensions are generally preferred, if there is not a good reason to require a client to completely fail when an extension isn't known.

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy • TypeDoc documentation • Copyright 2021 under MIT license