@dcl/protocol 1.0.0-10047077926.commit-ea61304 → 1.0.0-10170032882.commit-971bcef

package/out-ts/decentraland/sdk/components/gltf_container_loading_state.gen.ts

@@ -10,10 +10,29 @@ export const protobufPackage = "decentraland.sdk.components";
  */
 export interface PBGltfContainerLoadingState {
   currentState: LoadingState;
+  /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
+  nodePaths: string[];
+  /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
+  meshNames: string[];
+  /**
+   * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
+   * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
+   */
+  materialNames: string[];
+  /**
+   * X is the material index. note this may conflict with manually named materials - to avoid any issues make
+   * sure all your materials are explicitly named.
+   */
+  skinNames: string[];
+  /**
+   * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
+   * your skins are explicitly named.
+   */
+  animationNames: string[];
 }
 
 function createBasePBGltfContainerLoadingState(): PBGltfContainerLoadingState {
-  return { currentState: 0 };
+  return { currentState: 0, nodePaths: [], meshNames: [], materialNames: [], skinNames: [], animationNames: [] };
 }
 
 export namespace PBGltfContainerLoadingState {
@@ -21,6 +40,21 @@ export namespace PBGltfContainerLoadingState {
     if (message.currentState !== 0) {
       writer.uint32(8).int32(message.currentState);
     }
+    for (const v of message.nodePaths) {
+      writer.uint32(18).string(v!);
+    }
+    for (const v of message.meshNames) {
+      writer.uint32(26).string(v!);
+    }
+    for (const v of message.materialNames) {
+      writer.uint32(34).string(v!);
+    }
+    for (const v of message.skinNames) {
+      writer.uint32(42).string(v!);
+    }
+    for (const v of message.animationNames) {
+      writer.uint32(50).string(v!);
+    }
     return writer;
   }
 
@@ -38,6 +72,41 @@ export namespace PBGltfContainerLoadingState {
 
           message.currentState = reader.int32() as any;
           continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.nodePaths.push(reader.string());
+          continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.meshNames.push(reader.string());
+          continue;
+        case 4:
+          if (tag !== 34) {
+            break;
+          }
+
+          message.materialNames.push(reader.string());
+          continue;
+        case 5:
+          if (tag !== 42) {
+            break;
+          }
+
+          message.skinNames.push(reader.string());
+          continue;
+        case 6:
+          if (tag !== 50) {
+            break;
+          }
+
+          message.animationNames.push(reader.string());
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -48,12 +117,44 @@ export namespace PBGltfContainerLoadingState {
   }
 
   export function fromJSON(object: any): PBGltfContainerLoadingState {
-    return { currentState: isSet(object.currentState) ? loadingStateFromJSON(object.currentState) : 0 };
+    return {
+      currentState: isSet(object.currentState) ? loadingStateFromJSON(object.currentState) : 0,
+      nodePaths: Array.isArray(object?.nodePaths) ? object.nodePaths.map((e: any) => String(e)) : [],
+      meshNames: Array.isArray(object?.meshNames) ? object.meshNames.map((e: any) => String(e)) : [],
+      materialNames: Array.isArray(object?.materialNames) ? object.materialNames.map((e: any) => String(e)) : [],
+      skinNames: Array.isArray(object?.skinNames) ? object.skinNames.map((e: any) => String(e)) : [],
+      animationNames: Array.isArray(object?.animationNames) ? object.animationNames.map((e: any) => String(e)) : [],
+    };
   }
 
   export function toJSON(message: PBGltfContainerLoadingState): unknown {
     const obj: any = {};
     message.currentState !== undefined && (obj.currentState = loadingStateToJSON(message.currentState));
+    if (message.nodePaths) {
+      obj.nodePaths = message.nodePaths.map((e) => e);
+    } else {
+      obj.nodePaths = [];
+    }
+    if (message.meshNames) {
+      obj.meshNames = message.meshNames.map((e) => e);
+    } else {
+      obj.meshNames = [];
+    }
+    if (message.materialNames) {
+      obj.materialNames = message.materialNames.map((e) => e);
+    } else {
+      obj.materialNames = [];
+    }
+    if (message.skinNames) {
+      obj.skinNames = message.skinNames.map((e) => e);
+    } else {
+      obj.skinNames = [];
+    }
+    if (message.animationNames) {
+      obj.animationNames = message.animationNames.map((e) => e);
+    } else {
+      obj.animationNames = [];
+    }
     return obj;
   }
 
@@ -68,6 +169,11 @@ export namespace PBGltfContainerLoadingState {
   ): PBGltfContainerLoadingState {
     const message = createBasePBGltfContainerLoadingState();
     message.currentState = object.currentState ?? 0;
+    message.nodePaths = object.nodePaths?.map((e) => e) || [];
+    message.meshNames = object.meshNames?.map((e) => e) || [];
+    message.materialNames = object.materialNames?.map((e) => e) || [];
+    message.skinNames = object.skinNames?.map((e) => e) || [];
+    message.animationNames = object.animationNames?.map((e) => e) || [];
     return message;
   }
 }

package/out-ts/decentraland/sdk/components/gltf_node.gen.ts

@@ -0,0 +1,116 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "decentraland.sdk.components";
+
+/**
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
+ * This component must be added to a direct child of an entity with a PbGltfContainer component, or
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
+ * in the parent.
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
+ *
+ * The renderer will attach a PbGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
+ *
+ * After creation, if an animation moves the node, the `Transform` will be updated.
+ *
+ * From the scene, you can modify various components to alter the gltf node:
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
+ *   regardless of any intermediate gltf node hierarchy.
+ *   If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
+ *   used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the
+ *   PbMaterial will be maintained.
+ *
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
+ *   change the state to `GNS_FAILED`.
+ * - deleting the scene entity will not delete the gltf node.
+ *
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
+ * the gltf node will also be displayed.
+ */
+export interface PBGltfNode {
+  /** the path of the target node in the Gltf. */
+  path: string;
+}
+
+function createBasePBGltfNode(): PBGltfNode {
+  return { path: "" };
+}
+
+export namespace PBGltfNode {
+  export function encode(message: PBGltfNode, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.path !== "") {
+      writer.uint32(10).string(message.path);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBGltfNode();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.path = reader.string();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBGltfNode {
+    return { path: isSet(object.path) ? String(object.path) : "" };
+  }
+
+  export function toJSON(message: PBGltfNode): unknown {
+    const obj: any = {};
+    message.path !== undefined && (obj.path = message.path);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBGltfNode>, I>>(base?: I): PBGltfNode {
+    return PBGltfNode.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBGltfNode>, I>>(object: I): PBGltfNode {
+    const message = createBasePBGltfNode();
+    message.path = object.path ?? "";
+    return message;
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}

package/out-ts/decentraland/sdk/components/gltf_node_state.gen.ts

@@ -0,0 +1,139 @@
+/* eslint-disable */
+import _m0 from "protobufjs/minimal";
+
+export const protobufPackage = "decentraland.sdk.components";
+
+export enum GltfNodeStateValue {
+  GNSV_PENDING = 0,
+  GNSV_FAILED = 1,
+  GNSV_READY = 2,
+  UNRECOGNIZED = -1,
+}
+
+export function gltfNodeStateValueFromJSON(object: any): GltfNodeStateValue {
+  switch (object) {
+    case 0:
+    case "GNSV_PENDING":
+      return GltfNodeStateValue.GNSV_PENDING;
+    case 1:
+    case "GNSV_FAILED":
+      return GltfNodeStateValue.GNSV_FAILED;
+    case 2:
+    case "GNSV_READY":
+      return GltfNodeStateValue.GNSV_READY;
+    case -1:
+    case "UNRECOGNIZED":
+    default:
+      return GltfNodeStateValue.UNRECOGNIZED;
+  }
+}
+
+export function gltfNodeStateValueToJSON(object: GltfNodeStateValue): string {
+  switch (object) {
+    case GltfNodeStateValue.GNSV_PENDING:
+      return "GNSV_PENDING";
+    case GltfNodeStateValue.GNSV_FAILED:
+      return "GNSV_FAILED";
+    case GltfNodeStateValue.GNSV_READY:
+      return "GNSV_READY";
+    case GltfNodeStateValue.UNRECOGNIZED:
+    default:
+      return "UNRECOGNIZED";
+  }
+}
+
+/**
+ * The state of a linked gltf node.
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
+ */
+export interface PBGltfNodeState {
+  state: GltfNodeStateValue;
+  error?: string | undefined;
+}
+
+function createBasePBGltfNodeState(): PBGltfNodeState {
+  return { state: 0, error: undefined };
+}
+
+export namespace PBGltfNodeState {
+  export function encode(message: PBGltfNodeState, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.state !== 0) {
+      writer.uint32(8).int32(message.state);
+    }
+    if (message.error !== undefined) {
+      writer.uint32(18).string(message.error);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBGltfNodeState();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 8) {
+            break;
+          }
+
+          message.state = reader.int32() as any;
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.error = reader.string();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBGltfNodeState {
+    return {
+      state: isSet(object.state) ? gltfNodeStateValueFromJSON(object.state) : 0,
+      error: isSet(object.error) ? String(object.error) : undefined,
+    };
+  }
+
+  export function toJSON(message: PBGltfNodeState): unknown {
+    const obj: any = {};
+    message.state !== undefined && (obj.state = gltfNodeStateValueToJSON(message.state));
+    message.error !== undefined && (obj.error = message.error);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBGltfNodeState>, I>>(base?: I): PBGltfNodeState {
+    return PBGltfNodeState.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBGltfNodeState>, I>>(object: I): PBGltfNodeState {
+    const message = createBasePBGltfNodeState();
+    message.state = object.state ?? 0;
+    message.error = object.error ?? undefined;
+    return message;
+  }
+}
+
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+
+export type DeepPartial<T> = T extends Builtin ? T
+  : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
+  : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
+  : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
+  : Partial<T>;
+
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P
+  : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}

package/out-ts/decentraland/sdk/components/material.gen.ts

@@ -61,6 +61,14 @@ export interface PBMaterial {
     | { $case: "unlit"; unlit: PBMaterial_UnlitMaterial }
     | { $case: "pbr"; pbr: PBMaterial_PbrMaterial }
     | undefined;
+  /**
+   * A gltf material that may provide additional features not supported by the PbMaterial fields.
+   * If both gltf and material fields are provided, the gltf will be used only for extended features not
+   * supported by the PbMaterial.
+   * If this is provided and the `material` field is not provided, the renderer will update the material
+   * field with data that reflects the gltf material once it is loaded.
+   */
+  gltf?: PBMaterial_GltfMaterial | undefined;
 }
 
 export interface PBMaterial_UnlitMaterial {
@@ -141,8 +149,13 @@ export interface PBMaterial_PbrMaterial {
   directIntensity?: number | undefined;
 }
 
+export interface PBMaterial_GltfMaterial {
+  gltfSrc: string;
+  name: string;
+}
+
 function createBasePBMaterial(): PBMaterial {
-  return { material: undefined };
+  return { material: undefined, gltf: undefined };
 }
 
 export namespace PBMaterial {
@@ -155,6 +168,9 @@ export namespace PBMaterial {
         PBMaterial_PbrMaterial.encode(message.material.pbr, writer.uint32(18).fork()).ldelim();
         break;
     }
+    if (message.gltf !== undefined) {
+      PBMaterial_GltfMaterial.encode(message.gltf, writer.uint32(26).fork()).ldelim();
+    }
     return writer;
   }
 
@@ -179,6 +195,13 @@ export namespace PBMaterial {
 
           message.material = { $case: "pbr", pbr: PBMaterial_PbrMaterial.decode(reader, reader.uint32()) };
           continue;
+        case 3:
+          if (tag !== 26) {
+            break;
+          }
+
+          message.gltf = PBMaterial_GltfMaterial.decode(reader, reader.uint32());
+          continue;
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -195,6 +218,7 @@ export namespace PBMaterial {
         : isSet(object.pbr)
         ? { $case: "pbr", pbr: PBMaterial_PbrMaterial.fromJSON(object.pbr) }
         : undefined,
+      gltf: isSet(object.gltf) ? PBMaterial_GltfMaterial.fromJSON(object.gltf) : undefined,
     };
   }
 
@@ -204,6 +228,7 @@ export namespace PBMaterial {
       (obj.unlit = message.material?.unlit ? PBMaterial_UnlitMaterial.toJSON(message.material?.unlit) : undefined);
     message.material?.$case === "pbr" &&
       (obj.pbr = message.material?.pbr ? PBMaterial_PbrMaterial.toJSON(message.material?.pbr) : undefined);
+    message.gltf !== undefined && (obj.gltf = message.gltf ? PBMaterial_GltfMaterial.toJSON(message.gltf) : undefined);
     return obj;
   }
 
@@ -219,6 +244,9 @@ export namespace PBMaterial {
     if (object.material?.$case === "pbr" && object.material?.pbr !== undefined && object.material?.pbr !== null) {
       message.material = { $case: "pbr", pbr: PBMaterial_PbrMaterial.fromPartial(object.material.pbr) };
     }
+    message.gltf = (object.gltf !== undefined && object.gltf !== null)
+      ? PBMaterial_GltfMaterial.fromPartial(object.gltf)
+      : undefined;
     return message;
   }
 }
@@ -612,6 +640,79 @@ export namespace PBMaterial_PbrMaterial {
   }
 }
 
+function createBasePBMaterial_GltfMaterial(): PBMaterial_GltfMaterial {
+  return { gltfSrc: "", name: "" };
+}
+
+export namespace PBMaterial_GltfMaterial {
+  export function encode(message: PBMaterial_GltfMaterial, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.gltfSrc !== "") {
+      writer.uint32(10).string(message.gltfSrc);
+    }
+    if (message.name !== "") {
+      writer.uint32(18).string(message.name);
+    }
+    return writer;
+  }
+
+  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial {
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBasePBMaterial_GltfMaterial();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          if (tag !== 10) {
+            break;
+          }
+
+          message.gltfSrc = reader.string();
+          continue;
+        case 2:
+          if (tag !== 18) {
+            break;
+          }
+
+          message.name = reader.string();
+          continue;
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skipType(tag & 7);
+    }
+    return message;
+  }
+
+  export function fromJSON(object: any): PBMaterial_GltfMaterial {
+    return {
+      gltfSrc: isSet(object.gltfSrc) ? String(object.gltfSrc) : "",
+      name: isSet(object.name) ? String(object.name) : "",
+    };
+  }
+
+  export function toJSON(message: PBMaterial_GltfMaterial): unknown {
+    const obj: any = {};
+    message.gltfSrc !== undefined && (obj.gltfSrc = message.gltfSrc);
+    message.name !== undefined && (obj.name = message.name);
+    return obj;
+  }
+
+  export function create<I extends Exact<DeepPartial<PBMaterial_GltfMaterial>, I>>(base?: I): PBMaterial_GltfMaterial {
+    return PBMaterial_GltfMaterial.fromPartial(base ?? {});
+  }
+
+  export function fromPartial<I extends Exact<DeepPartial<PBMaterial_GltfMaterial>, I>>(
+    object: I,
+  ): PBMaterial_GltfMaterial {
+    const message = createBasePBMaterial_GltfMaterial();
+    message.gltfSrc = object.gltfSrc ?? "";
+    message.name = object.name ?? "";
+    return message;
+  }
+}
+
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 
 export type DeepPartial<T> = T extends Builtin ? T