@wonderlandengine/editor-api 1.2.0-dev.0

package/dist/data.js

@@ -0,0 +1,669 @@
+/** Project settings */
+export class ProjectSettings {
+    name = '';
+    customIndexHtml = false;
+    extraFilesFolder = 'static';
+    packageForStreaming = false;
+}
+/** Sky settings */
+export class SkySettings {
+    enabled = false;
+    material = null;
+}
+/** Bloom settings */
+export class BloomSettings {
+    enabled = false;
+    kernelSize = 6;
+    passes = 1;
+    threshold = 1.25;
+    intensity = 2.0;
+}
+/** HDR settings */
+export class HdrSettings {
+    exposure = 1.5;
+}
+/** Texture streaming settings */
+export class TextureStreamingSettings {
+    maxCacheSize = 1024;
+    maxUploadPerFrame = 10;
+}
+/** Rendering settings */
+export class RenderingSettings {
+    textureAtlasSize = [8192, 4096];
+    compressedTextureAtlasSize = [16384, 8192];
+    clearColor = [0.168, 0.168, 0.168, 1.0];
+    maxShadows = 4;
+    usePreZ = false;
+    useMultiDraw = false;
+    useFrustumCulling = true;
+    sky = new SkySettings();
+    bloom = new BloomSettings();
+    hdr = new HdrSettings();
+    textureStreaming = new TextureStreamingSettings();
+}
+/** Camera settings */
+export class CameraSettings {
+    near = 0.02;
+    far = 100.0;
+}
+/** Editor settings */
+export class EditorSettings {
+    serverPort = 8080;
+    serverCOEP = 'require-corp';
+    camera = new CameraSettings();
+    ids = 'incremental-number';
+}
+/** Plugins settings */
+export class PluginsSettings {
+}
+/** WebXR settings */
+export class WebXRSettings {
+    optionalFeatures = {
+        'local': true,
+        'local-floor': false,
+        'bounded-floor': false,
+        'unbounded': false,
+        'hand-tracking': true,
+        'hit-test': true,
+        'plane-detection': false,
+        'light-estimation': false,
+        'anchors': false,
+        'occlusion': false,
+        'marker-tracking': false,
+        'extraFeatures': '',
+    };
+    requiredFeatures = {
+        'local': true,
+        'local-floor': false,
+        'bounded-floor': false,
+        'unbounded': false,
+        'hand-tracking': false,
+        'hit-test': false,
+        'plane-detection': false,
+        'light-estimation': false,
+        'anchors': false,
+        'occlusion': false,
+        'marker-tracking': false,
+        'extraFeatures': '',
+    };
+}
+/** PWA settings */
+export class PWASettings {
+    enable = false;
+    customServiceWorker = false;
+    customManifest = false;
+    display = 'standalone';
+    ovrPackageName = '';
+    appIcon = null;
+}
+/** Runtime settings */
+export class RuntimeSettings {
+    visualizeColliders = false;
+    visualizePhysX = false;
+    visualizeOverdraw = false;
+    googleAnalytics = '';
+    googleAnalyticsSecondary = '';
+    enableRuntimeGltf = false;
+    viewObject = null;
+    webxr = new WebXRSettings();
+    xrButtonColor = 'white';
+    pwa = new PWASettings();
+}
+/** Bundling type enum */
+export var BundlingType;
+(function (BundlingType) {
+    BundlingType["None"] = "none";
+    BundlingType["Esbuild"] = "esbuild";
+    BundlingType["Npm"] = "npm";
+})(BundlingType || (BundlingType = {}));
+/** Scripting settings */
+export class ScriptingSettings {
+    sourcePaths = [];
+    libraryPaths = [];
+    bundlingType = BundlingType.Esbuild;
+    npmScript = 'build';
+    esbuildFlags = '--format=esm';
+    entryPoint = 'js/index.js';
+}
+/** VR settings */
+export class VRSettings {
+    enable = true;
+    rightEyeObject = null;
+    leftEyeObject = null;
+    framebufferScaleFactor = 1.0;
+}
+/** Physics settings */
+export class PhysXSettings {
+    enable = false;
+    maxTimestep = 0.05;
+    contactOffset = 0.02;
+    restOffset = 0.0;
+    groupNames = {
+        '0': 'static',
+        '1': 'dynamic',
+        '2': 'ui',
+        '3': 'nav',
+        '4': 'player',
+        '5': 'enemy',
+        '6': 'group6',
+        '7': 'group7',
+    };
+    gravity = [0.0, -9.81, 0.0];
+    lengthToleranceScale = 1.0;
+    speedToleranceScale = 10.0;
+}
+/** AR settings */
+export class ARSettings {
+    enable = false;
+}
+/** Localization settings */
+export class LocalizationSettings {
+    enableZipCompression = false;
+    format = 'i18next';
+    languagesFolder = 'languages';
+    defaultLanguage = 'en';
+}
+/** Settings for the currently open project */
+export class Settings {
+    project = new ProjectSettings();
+    rendering = new RenderingSettings();
+    editor = new EditorSettings();
+    runtime = new RuntimeSettings();
+    scripting = new ScriptingSettings();
+    plugins = new PluginsSettings();
+    vr = new VRSettings();
+    ar = new ARSettings();
+    physx = new PhysXSettings();
+    localization = new LocalizationSettings();
+}
+/** Image compression type */
+export var ImageCompressionType;
+(function (ImageCompressionType) {
+    ImageCompressionType["None"] = "etc1s";
+    ImageCompressionType["ETC1s"] = "etc1s";
+    ImageCompressionType["UASTC"] = "uastc";
+})(ImageCompressionType || (ImageCompressionType = {}));
+/** Image resource */
+export class ImageResource {
+    name = 'image';
+    maxSize = [8192, 8192];
+    compression = ImageCompressionType.ETC1s;
+    stream = true;
+    isProbe = false;
+    isSpecularProbe = false;
+}
+/** Texture resource */
+export class TextureResource {
+    name = 'texture';
+    image = null;
+    type = 1;
+    minFilter = 0;
+    magFilter = 0;
+    mipFilter = 0;
+    wrapping = [0, 0, 0];
+}
+/** Shader stage enum */
+export var ShaderStage;
+(function (ShaderStage) {
+    ShaderStage["Fragment"] = "fragment";
+    ShaderStage["Vertex"] = "vertex";
+})(ShaderStage || (ShaderStage = {}));
+/** Shader type enum */
+export var ShaderType;
+(function (ShaderType) {
+    ShaderType["Forward"] = "forward";
+    ShaderType["Fullscreen"] = "fullscreen";
+})(ShaderType || (ShaderType = {}));
+/** Shader resource */
+export class ShaderResource {
+    name = 'shader';
+    stage = ShaderStage.Fragment;
+    type = ShaderType.Forward;
+    packageUnused = false;
+}
+/** Mesh resource */
+export class MeshResource {
+    name = 'mesh';
+    simplify = false;
+    simplifyTarget = 0.5;
+    simplifyTargetError = 0.02;
+    importScaling = 1.0;
+}
+/** Material properties for the default Phong pipeline */
+export class PhongMaterial {
+    ambientColor = [0.05, 0.05, 0.05, 1.0];
+    diffuseTexture = null;
+    diffuseColor = [1, 1, 1, 1.0];
+    specularColor = [1.0, 1.0, 1.0, 0.0];
+    emissiveTexture = null;
+    emissiveColor = [0.0, 0.0, 0.0, 1.0];
+    fogColor = [1.0, 1.0, 1.0, 0.0];
+    normalTexture = null;
+    lightmapTexture = null;
+    lightmapFactor = 1.0;
+    shininess = 2;
+    alphaMaskThreshold = 0.5;
+    alphaMaskTexture = null;
+}
+/** Material properties for the default Phong pipeline */
+export class PhysicalMaterial {
+    albedoColor = [1.0, 1.0, 1.0, 1.0];
+    emissiveTexture = null;
+    emissiveColor = [0.0, 0.0, 0.0, 1.0];
+    albedoTexture = null;
+    metallicFactor = 1.0;
+    roughnessFactor = 1.0;
+    roughnessMetallicTexture = null;
+    specularProbeTexture = null;
+    irradianceProbeTexture = null;
+    normalTexture = null;
+    occlusionTexture = null;
+    occlusionFactor = 1.0;
+    alphaMaskThreshold = 0.5;
+    alphaMaskTexture = null;
+}
+/** Material properties for the default MeshVisualizer pipeline */
+export class MeshVisualizerMaterial {
+    color = [0.5, 0.5, 0.5, 1];
+    wireframeColor = [1, 1, 1, 1];
+}
+/** Material properties for the default Flat pipeline */
+export class FlatMaterial {
+    color = [1, 1, 1, 1];
+    flatTexture = null;
+    alphaMaskThreshold = 0.5;
+    alphaMaskTexture = null;
+}
+/** Material properties for the default Particle pipeline */
+export class ParticleMaterial {
+    color = [1, 1, 1, 1];
+    mainTexture = null;
+    noiseTexture = null;
+    offsetX = 0.0;
+    offsetY = 0.0;
+}
+/** Material properties for the default DistanceFieldVector pipeline */
+export class DistanceFieldVectorMaterial {
+    color = [1, 1, 1, 1];
+    outlineColor = [0, 0, 0, 1];
+    outlineRange = [0.4, 0.3];
+    vectorTexture = null;
+    smoothness = 0.02;
+}
+/** Material properties for the default Text pipeline */
+export class TextMaterial {
+    color = [1, 1, 1, 1];
+    effectColor = [0, 0, 0, 1];
+    font = null;
+}
+/** Material properties for the default Sky pipeline */
+export class SkyMaterial {
+    colorStop0 = [1, 1, 1, 1];
+    colorStop1 = [0.55, 0.95, 1, 1];
+    colorStop2 = [0.55, 0.95, 1, 1];
+    colorStop3 = [0.55, 0.95, 1, 1];
+    texture = null;
+}
+/** Material properties for the default Background pipeline */
+export class BackgroundMaterial {
+    colorStop0 = [1, 1, 1, 1];
+    colorStop1 = [0.55, 0.95, 1, 1];
+    colorStop2 = [0.55, 0.95, 1, 1];
+    colorStop3 = [0.55, 0.95, 1, 1];
+    texture = null;
+}
+/** Material properties for the default Particle pipeline */
+export class MaterialResource {
+    pipeline = null;
+    name = 'material';
+    Phong;
+    Physical;
+    MeshVisualizer;
+    Flat;
+    Particle;
+    DistanceFieldVector;
+    Text;
+    Sky;
+    Background;
+}
+/** 'animation' component configuration */
+export class AnimationComponent {
+    preview = false;
+    retarget = false;
+    autoplay = false;
+    playCount = 0;
+    speed = 1.0;
+    skin = null;
+    animation = null;
+}
+/** Light type enum */
+export var LightType;
+(function (LightType) {
+    /** Point light type */
+    LightType["Point"] = "point";
+    /** Spot light type */
+    LightType["Spot"] = "spot";
+    /** Sun light type */
+    LightType["Sun"] = "sun";
+})(LightType || (LightType = {}));
+/** 'light' component configuration */
+export class LightComponent {
+    type = LightType.Point;
+    color = [1.0, 1.0, 1.0];
+    intensity = 1;
+    shadowRange = 10.0;
+    outerAngle = 90;
+    innerAngle = 45;
+    shadows = false;
+    shadowBias = 0.0012;
+    shadowNormalBias = 0.001;
+    shadowTexelSize = 1.0;
+    cascadeCount = 4;
+}
+/** 'view' component configuration */
+export class ViewComponent {
+    fov = 90;
+    near = 0.01;
+    far = 100;
+}
+/** Settings for a sphere physics shape */
+export class PhysXSphereConfig {
+    radius = 0.25;
+}
+/** Settings for a box physics shape */
+export class PhysXBoxConfig {
+    extents = [0.25, 0.25, 0.25];
+}
+/** Settings for a capsule physics shape */
+export class PhysXCapsuleConfig {
+    radius = 0.15;
+    halfHeight = 0.25;
+}
+/** Settings for a triangle mesh physics shape */
+export class PhysXTriangleMeshConfig {
+    mesh = null;
+    scaling = [1, 1, 1];
+}
+/** Settings for a convex mesh physics shape */
+export class PhysXConvexMeshConfig {
+    mesh = null;
+    scaling = [1, 1, 1];
+}
+/** Physics shape type enum */
+export var PhysXShapeType;
+(function (PhysXShapeType) {
+    PhysXShapeType["Sphere"] = "sphere";
+    PhysXShapeType["Box"] = "box";
+    PhysXShapeType["Capsule"] = "capsule";
+    PhysXShapeType["TriangleMesh"] = "triangleMesh";
+    PhysXShapeType["ConvexMesh"] = "convexMesh";
+})(PhysXShapeType || (PhysXShapeType = {}));
+/** 'physx' component configuration */
+export class PhysXComponent {
+    static = false;
+    kinematic = false;
+    simulate = true;
+    allowQuery = true;
+    allowSimulation = true;
+    mass = 1.0;
+    shape = PhysXShapeType.Sphere;
+    sphere;
+    box;
+    capsule;
+    triangleMesh;
+    convexMesh;
+    linearDamping = 0.0;
+    angularDamping = 0.05;
+    staticFriction = 0.5;
+    dynamicFriction = 0.5;
+    bounciness = 0.5;
+    gravity = true;
+    trigger = false;
+    block = 255;
+    groups = 255;
+    lockAxis = 0;
+    sleepOnActivate = false;
+    translationOffset = [0, 0, 0];
+    rotationOffset = [0, 0, 0, 1];
+    solverPositionIterations = 4;
+    solverVelocityIterations = 1;
+}
+/** 'mesh' component configuration */
+export class MeshComponent {
+    material = null;
+    mesh = null;
+    skin = null;
+}
+/** Text effect type enum */
+export var TextEffectType;
+(function (TextEffectType) {
+    TextEffectType["None"] = "none";
+    TextEffectType["Outline"] = "outline";
+})(TextEffectType || (TextEffectType = {}));
+/** 'text' component configuration */
+export class TextComponent {
+    alignment = 'center';
+    justification = 'middle';
+    characterSpacing = 0.0;
+    lineSpacing = 1.2;
+    effect = TextEffectType.None;
+    text = 'Wonderland Engine';
+    material = 'DefaultFontMaterial';
+}
+/** Settings for a sphere collider */
+export class SphereConfig {
+    radius = 1.0;
+}
+/** Settings for a AxisAlignedBoundingBox collider */
+export class AABBConfig {
+    extents = [1.0, 1.0, 1.0];
+}
+/** Settings for a box collider */
+export class BoxConfig {
+    extents = [1.0, 1.0, 1.0];
+}
+/** 'collision' component configuration */
+export class CollisionComponent {
+    collider = 'sphere';
+    sphere;
+    aabb;
+    box;
+    groups = 255;
+}
+/** Input type enum */
+export var InputType;
+(function (InputType) {
+    InputType["Head"] = "head";
+    InputType["EyeLeft"] = "eye left";
+    InputType["EyeRight"] = "eye right";
+    InputType["HandLeft"] = "hand left";
+    InputType["HandRight"] = "hand right";
+    InputType["RayLeft"] = "ray left";
+    InputType["RayRight"] = "ray right";
+})(InputType || (InputType = {}));
+/** 'input' component configuration */
+export class InputComponent {
+    type = InputType.Head;
+}
+export class AnimationEvent {
+    time = 0.0;
+    name = '';
+}
+/** Animation resource */
+export class AnimationResource {
+    /** Name of the animation */
+    name = 'animation';
+    /** Whether to compress the animation */
+    pack = true;
+    /** Targets influenced per track */
+    targets = [];
+    /** Animation events track */
+    events = [];
+}
+/** Component configuration */
+export class ComponentConfig {
+    /** Component type */
+    type = null;
+    /** Whether the component is active */
+    active = true;
+    /** Configuration for animation components */
+    animation;
+    /** Configuration for collision components */
+    collision;
+    /** Configuration for input components */
+    input;
+    /** Configuration for light components */
+    light;
+    /** Configuration for mesh components */
+    mesh;
+    /** Configuration for physx components */
+    physx;
+    /** Configuration for text components */
+    text;
+    /** Configuration for view components */
+    view;
+}
+/** Object resource */
+export class ObjectResource {
+    /** Name of the object */
+    name = 'object';
+    /** Translation vector */
+    translation = [0, 0, 0];
+    /** Rotation quaternion */
+    rotation = [0, 0, 0, 1];
+    /** Scaling vector */
+    scaling = [1, 1, 1];
+    /** Parent object, or null if parent is root */
+    parent = null;
+    /** Skin this object is part of, or `null`, if not a joint. */
+    skin = null;
+    /** List of components on this object */
+    components = [];
+}
+/** Skin resource */
+export class SkinResource {
+    /** Name of the skin */
+    name = 'skin';
+    /** List of objects that make up the joints of this skin */
+    joints = [];
+}
+/** Blend function enum for {@link PipelineResource} */
+export var BlendFunction;
+(function (BlendFunction) {
+    BlendFunction["Zero"] = "zero";
+    BlendFunction["One"] = "one";
+    BlendFunction["SourceColor"] = "source color";
+    BlendFunction["OnceMinusSourceColor"] = "one minus source color";
+    BlendFunction["SourceAlpha"] = "source alpha";
+    BlendFunction["SourceAlphaSaturate"] = "source alpha saturate";
+    BlendFunction["OneMinusSourceAlpha"] = "one minus source alpha";
+    BlendFunction["DestinationColor"] = "destination color";
+    BlendFunction["OneMinusDestinationColor"] = "one minus destination color";
+    BlendFunction["DestinationAlpha"] = "destination alpha";
+    BlendFunction["OneMinusDestinationAlpha"] = "one minus destination alpha";
+})(BlendFunction || (BlendFunction = {}));
+/** Blend equation enum for {@link PipelineResource} */
+export var BlendEquation;
+(function (BlendEquation) {
+    BlendEquation["Add"] = "add";
+    BlendEquation["Subtract"] = "subtract";
+    BlendEquation["ReverseSubtract"] = "reverse subtract";
+    BlendEquation["Min"] = "min";
+    BlendEquation["Max"] = "max";
+})(BlendEquation || (BlendEquation = {}));
+/** Depth function enum for {@link PipelineResource} */
+export var DepthFunction;
+(function (DepthFunction) {
+    DepthFunction["Never"] = "never";
+    DepthFunction["Always"] = "always";
+    DepthFunction["Less"] = "less";
+    DepthFunction["LessOrEqual"] = "less or equal";
+    DepthFunction["Equal"] = "equal";
+    DepthFunction["NotEqual"] = "not equal";
+    DepthFunction["GreaterOrEqual"] = "greater or equal";
+    DepthFunction["Greater"] = "greater";
+})(DepthFunction || (DepthFunction = {}));
+/** Pipeline resource */
+export class PipelineResource {
+    name = 'pipeline';
+    doubleSided = false;
+    castShadows = false;
+    depthTest = true;
+    depthWrite = true;
+    blending = false;
+    sampleAlphaToCoverage = false;
+    shader = null;
+    viewVertexShader = null;
+    features = {};
+    blendSrcRgb = BlendFunction.One;
+    blendSrcAlpha = BlendFunction.One;
+    blendDestRgb = BlendFunction.Zero;
+    blendDestAlpha = BlendFunction.Zero;
+    blendEqRgb = BlendEquation.Add;
+    blendEqAlpha = BlendEquation.Add;
+    depthFunction = DepthFunction.Less;
+}
+/** Font resource */
+export class FontResource {
+    /** Name of the font */
+    name = 'font';
+    /** Which characters need to be renderable with this font */
+    characters = 'abcdefghijklmnopqrstuvwxyz\nABCDEFGHIJKLMNOPQRSTUVWXYZ\n0123456789\n:-_+*,.!`"\'?°=\\/\n()[]<>{}$&%@|’‘ ';
+    /** Whether to support the "outline" effect with this font */
+    outline = false;
+    /** Size of the outline */
+    outlineSize = 0.1;
+}
+/** Language resource */
+export class LanguageResource {
+    /** Name of the language */
+    name = 'language';
+    /** Custom terms */
+    strings = {};
+}
+/**
+ * @brief Access to Wonderland Editor's data
+ *
+ * Hold control and hover any field in Wonderland Editor to see its JSON path.
+ * The path is equivalent to how you find the matching chain of properties.
+ * @example
+ *
+ * ```
+ *    /objects/123/components/0/text/text
+ * ```
+ *
+ * Will match the following code:
+ *
+ * ```ts
+ *    WL.data.objects[123].components[0].text.text
+ * ```
+ */
+export class EditorData {
+    /** Project settings */
+    settings = new Settings();
+    /** List of scene file paths */
+    files = [];
+    /** Animation resources */
+    animations = [];
+    /** Object resources */
+    objects = [];
+    /** Skin resources */
+    skins = [];
+    /** Image resources */
+    images = [];
+    /** Shader resources */
+    shaders = [];
+    /** Mesh resources */
+    meshes = [];
+    /** Texture resources */
+    textures = [];
+    /** Material resources */
+    materials = [];
+    /** Font resources */
+    fonts = [];
+    /** Pipeline resources */
+    pipelines = [];
+    /** Language resources */
+    languages = [];
+}
+export let data = (global._wl_internalBinding ?? (() => { }))('data');

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export * from './data.js';
+export * as ui from './ui.js';
+export * as tools from './tools.js';
+/** Editor plugin */
+export declare class EditorPlugin {
+    name: string;
+    draw?: () => void;
+    preProjectSave?: () => boolean;
+    postProjectLoad?: () => boolean;
+    prePackage?: () => boolean;
+    postPackage?: () => boolean;
+}

package/dist/index.js

@@ -0,0 +1,14 @@
+export * from './data.js';
+import * as ui_1 from './ui.js';
+export { ui_1 as ui };
+import * as tools_1 from './tools.js';
+export { tools_1 as tools };
+/** Editor plugin */
+export class EditorPlugin {
+    name = 'Editor Plugin';
+    draw;
+    preProjectSave;
+    postProjectLoad;
+    prePackage;
+    postPackage;
+}