@dcl/protocol 1.0.0-22672716807.commit-22c32c9 → 1.0.0-22917704966.commit-8d5910d

package/proto/decentraland/sdk/components/common/input_action.proto

@@ -26,11 +26,7 @@ enum PointerEventType {
   PET_DOWN = 1;
   PET_HOVER_ENTER = 2;
   PET_HOVER_LEAVE = 3;
-  PET_PROXIMITY_ENTER = 4;
-  PET_PROXIMITY_LEAVE = 5;
-}
-
-enum InteractionType {
-  CURSOR = 0;
-  PROXIMITY = 1;
+  PET_DRAG_LOCKED = 4;
+  PET_DRAG = 5;
+  PET_DRAG_END = 6;
 }

package/proto/decentraland/sdk/components/global_light.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/common/vectors.proto";
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1206;
+
+// defines the global scene light settings. must be added to the scene root.
+// to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
+message PBGlobalLight {
+  // the direction the directional light shines in.
+  // default depends on time of day and explorer implementation
+  optional decentraland.common.Vector3 direction = 1;
+  // ambient light color
+  // default: White
+  optional decentraland.common.Color3 ambient_color = 2;
+  // ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
+  // default 1
+  optional float ambient_brightness = 3; 
+}

package/proto/decentraland/sdk/components/gltf_container_loading_state.proto

@@ -10,4 +10,17 @@ import "decentraland/sdk/components/common/loading_state.proto";
 // the current state of the GltfContainer of an entity.
 message PBGltfContainerLoadingState {
   common.LoadingState current_state = 1;
+  repeated string node_paths = 2; // all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents
+  repeated string mesh_names = 3; // all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY`
+                                  // 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.
+  repeated string material_names = 4; // all materials in the gltf. unnamed materials will be auto-assigned a name of the form `MaterialX` where
+                                      // 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.
+  repeated string skin_names = 5; // all mesh skins in the gltf. unnamed skins will be auto-assigned a name of the form `SkinX` where
+                                  // 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.
+  repeated string animation_names = 6; // all animations in the gltf. unnamed animations will be auto-assigned a name of the form `AnimationX` where
+                                       // X is the animation index. note this may conflict with manually named anims - to avoid any issues make sure all 
+                                       // your animations are explicitly named.
 }

package/proto/decentraland/sdk/components/gltf_node.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1200;
+
+// 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.
+message PBGltfNode {
+  string path = 1; // the path of the target node in the Gltf.
+}

package/proto/decentraland/sdk/components/gltf_node_state.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1201;
+
+// See the details of the GltfNode component for more information.
+
+// The state of a linked gltf node.
+// If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
+message PBGltfNodeState {
+    GltfNodeStateValue state = 1;
+    optional string error = 2;
+}
+
+enum GltfNodeStateValue {
+    GNSV_PENDING = 0;
+    GNSV_FAILED = 1;
+    GNSV_READY = 2;
+}

package/proto/decentraland/sdk/components/light_source.proto

@@ -25,4 +25,4 @@ message PBLightSource {
     optional float inner_angle = 9;   // default = 21.8. Inner angle can't be higher than outer angle, otherwise will default to same value. Min value is 0. Max value is 179.
     optional float outer_angle = 10;  // default = 30. Outer angle can't be lower than inner angle, otherwise will inner angle will be set to same value. Max value is 179.
   }
-}
+}

package/proto/decentraland/sdk/components/material.proto

@@ -54,4 +54,16 @@ message PBMaterial {
     UnlitMaterial unlit = 1;
     PbrMaterial pbr = 2;
   }
-}
+
+  message GltfMaterial {
+    string gltf_src = 1;
+    string name = 2;
+  }
+  
+  // 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.
+  optional GltfMaterial gltf = 3;
+}

package/proto/decentraland/sdk/components/mesh_collider.proto

@@ -30,6 +30,12 @@ message PBMeshCollider {
   // SphereMesh is a sphere shape that contains the Entity.
   message SphereMesh {}
 
+  // A collider constructed from a Gltf Mesh.
+  message GltfMesh {
+    string gltf_src = 1; // the GLTF file path as listed in the scene's manifest.
+    string name = 2; // the name of the mesh asset
+  }
+
   optional uint32 collision_mask = 1; // enabled ColliderLayers (default CL_POINTER | CL_PHYSICS)
 
   oneof mesh {
@@ -37,6 +43,7 @@ message PBMeshCollider {
     SphereMesh sphere = 3;
     CylinderMesh cylinder = 4;
     PlaneMesh plane = 5;
+    GltfMesh gltf = 6;
   }
 }
 

package/proto/decentraland/sdk/components/mesh_renderer.proto

@@ -5,13 +5,11 @@ import "decentraland/sdk/components/common/id.proto";
 option (common.ecs_component_id) = 1018;
 
 // The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a 
-// plane, a sphere or a cylinder.
+// plane, a sphere, a cylinder, or a Gltf mesh.
 //
 // The cube and plane variants can include a UV texture mapping, so specific areas of a material 
 // texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
 // `float` coordinates, one for each corner of each side of each face.
-//
-// More complex shapes require the use of a `GltfContainer` component.
 message PBMeshRenderer {
     
     // BoxMesh renders a prism shape.
@@ -34,10 +32,17 @@ message PBMeshRenderer {
     message SphereMesh {
     }
 
+    // A mesh from a Gltf.
+    message GltfMesh {
+        string gltf_src = 1; // the GLTF file path as listed in the scene's manifest.
+        string name = 2;  // the name of the mesh asset
+    }
+
     oneof mesh {
         BoxMesh box = 1;
         SphereMesh sphere = 2;
         CylinderMesh cylinder = 3;
         PlaneMesh plane = 4;
+        GltfMesh gltf = 5;
     }
 }

package/proto/decentraland/sdk/components/pointer_events.proto

@@ -51,13 +51,11 @@ message PBPointerEvents {
     optional bool show_feedback = 4;        // enable or disable hover text and highlight (default true)
     optional bool show_highlight = 5;       // enable or disable hover highlight (default true)
     optional float max_player_distance = 6; // range of interaction from the avatar's position (default 0)
-    optional uint32 priority = 7;           // resolution order when multiple events overlap, higher wins (default 0)
   }
 
   message Entry {
     common.PointerEventType event_type = 1; // the kind of interaction to detect
     Info event_info = 2;             // additional configuration for this detection
-    optional common.InteractionType interaction_type = 3; // the type of interaction source (default 0 == CURSOR)
   }
 
   repeated Entry pointer_events = 1; // the list of relevant events to detect

package/proto/decentraland/sdk/components/primary_pointer_info.proto

@@ -28,6 +28,8 @@ message PBPrimaryPointerInfo {
   optional PointerType pointer_type = 1;  // The type of input device being used
   optional decentraland.common.Vector2 screen_coordinates = 2;  // Current position in screen space (pixels)
   optional decentraland.common.Vector2 screen_delta = 3;  // Movement since last frame (pixels)
+  // ray direction that can be used with the primary camera origin for
+  // raycasting from the cursor into the world
   optional decentraland.common.Vector3 world_ray_direction = 4; // Direction vector for 3D ray casting
 }
 
@@ -36,4 +38,7 @@ message PBPrimaryPointerInfo {
 enum PointerType {
   POT_NONE = 0;   // No pointer input
   POT_MOUSE = 1;  // Traditional mouse input
+  POT_PAD = 2;
+  POT_TOUCH = 3;
+  POT_WAND = 4;
 }

package/proto/decentraland/sdk/components/raycast.proto

@@ -45,6 +45,12 @@ message PBRaycast {
 
   // Collision mask, by default CL_POINTER | CL_PHYSICS
   optional uint32 collision_mask = 9;
+
+  // shape to cast, default ray
+  optional RaycastShape shape = 11; 
+
+  // include hits with entities from other scenes
+  optional bool include_world = 12; 
 }
 
 // RaycastQueryType indicates whether the ray should stop on the first collition, or continue.
@@ -56,3 +62,10 @@ enum RaycastQueryType {
   // Do not perform the raycast, only set the raycast result with empty hits
   RQT_NONE = 2;
 }
+
+enum RaycastShape {
+  // cast a point, get collisions along a ray
+  RS_RAY = 0;
+  // cast the avatar collider shape, get collisions from sweeping the shape
+  RS_AVATAR = 1;
+}

package/proto/decentraland/sdk/components/texture_camera.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/colors.proto";
+
+option (common.ecs_component_id) = 1207;
+
+message PBTextureCamera {
+    // rendered texture width
+    optional uint32 width = 1;
+    // rendered texture height
+    optional uint32 height = 2;
+    // which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
+    // defaults to 0
+    optional uint32 layer = 3;
+
+    // default black
+    optional decentraland.common.Color4 clear_color = 6;
+    // default infinity
+    optional float far_plane = 7;
+
+    oneof mode {
+        Perspective perspective = 8;
+        Orthographic orthographic = 9;
+        /* Portal portal = 10; */ 
+    };
+
+    // controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
+    // range: 0 (off) - 1 (full volume)
+    // default: 0
+    optional float volume = 10;
+}
+
+message Perspective {
+    // vertical field of view in radians
+    // defaults to pi/4 = 45 degrees
+    optional float field_of_view = 1;
+}
+
+message Orthographic {
+    // vertical extent of the visible range in meters
+    // defaults to 4m
+    optional float vertical_range = 1;
+}

package/proto/decentraland/sdk/components/ui_canvas.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "decentraland/sdk/components/common/id.proto";
+package decentraland.sdk.components;
+
+option (common.ecs_component_id) = 1203;
+
+import "decentraland/common/colors.proto";
+
+// The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture.
+message PBUiCanvas {
+  uint32 width = 1;
+  uint32 height = 2;
+
+  optional decentraland.common.Color4 color = 3; // default = (0.0, 0.0, 0.0, 0.0) / transparent
+}

package/proto/decentraland/sdk/components/ui_scroll_result.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/common/vectors.proto";
+
+option (common.ecs_component_id) = 1202;
+
+message PBUiScrollResult {
+  decentraland.common.Vector2 value = 1;
+}

package/proto/decentraland/sdk/components/ui_text.proto

@@ -23,4 +23,7 @@ message PBUiText {
   optional common.Font font = 4;                 // font for the text (default: sans-serif)
   optional int32 font_size = 5;                  // size of the text (default: 10)
   optional TextWrap text_wrap = 6;               // wrap text when the border is reached (default: TW_WRAP)
+  
+  optional float outline_width = 7;              // width of the outline (default: 0)
+  optional decentraland.common.Color4 outline_color = 8; // RGBA color of the outline (default: opaque black)
 }

package/proto/decentraland/sdk/components/ui_transform.proto

@@ -4,6 +4,7 @@ package decentraland.sdk.components;
 
 import "decentraland/sdk/components/common/id.proto";
 import "decentraland/common/colors.proto";
+import "decentraland/common/vectors.proto";
 
 option (common.ecs_component_id) = 1050;
 
@@ -80,6 +81,20 @@ enum PointerFilterMode {
   PFM_BLOCK = 1;
 }
 
+enum ShowScrollBar {
+  SSB_BOTH = 0;
+  SSB_ONLY_VERTICAL = 1;
+  SSB_ONLY_HORIZONTAL = 2;
+  SSB_HIDDEN = 3;
+}
+
+message ScrollPositionValue {
+  oneof value {
+    decentraland.common.Vector2 position = 1;
+    string reference = 2;
+  }
+}
+
 message PBUiTransform {
   int32 parent = 1;
   int32 right_of = 2;
@@ -174,5 +189,10 @@ message PBUiTransform {
   optional decentraland.common.Color4 border_right_color = 72;
 
   optional float opacity = 73; // default: 1
+
+  optional string element_id = 74; // reference for scroll_position. default empty
+  optional ScrollPositionValue scroll_position = 75; // default position=(0,0)
+  optional ShowScrollBar scroll_visible = 76; // default ShowScrollBar.SSB_BOTH
+
   optional int32 z_index = 77; // default: 0 — controls render stacking order. Higher values appear in front of lower values.
 }

package/proto/decentraland/sdk/components/virtual_camera.proto

@@ -10,9 +10,7 @@ option (common.ecs_component_id) = 1076;
 // an 'instant' transition (like using speed/time = 0)
 // * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from 
 // the holding entity transform).
-// * The fov defines the Field of View of the virtual camera
 message PBVirtualCamera {
   optional common.CameraTransition default_transition = 1;
   optional uint32 look_at_entity = 2;
-  optional float fov = 3; // default: 60
 }

package/public/sdk-components.proto

@@ -9,6 +9,8 @@ import public "decentraland/sdk/components/avatar_base.proto";
 import public "decentraland/sdk/components/avatar_emote_command.proto";
 import public "decentraland/sdk/components/avatar_equipped_data.proto";
 import public "decentraland/sdk/components/avatar_modifier_area.proto";
+import public "decentraland/sdk/components/avatar_movement.proto";
+import public "decentraland/sdk/components/avatar_movement_info.proto";
 import public "decentraland/sdk/components/avatar_shape.proto";
 import public "decentraland/sdk/components/billboard.proto";
 import public "decentraland/sdk/components/camera_mode_area.proto";
@@ -17,6 +19,8 @@ import public "decentraland/sdk/components/engine_info.proto";
 import public "decentraland/sdk/components/gltf_container.proto";
 import public "decentraland/sdk/components/gltf_node_modifiers.proto";
 import public "decentraland/sdk/components/gltf_container_loading_state.proto";
+import public "decentraland/sdk/components/gltf_node.proto";
+import public "decentraland/sdk/components/gltf_node_state.proto";
 import public "decentraland/sdk/components/material.proto";
 import public "decentraland/sdk/components/mesh_collider.proto";
 import public "decentraland/sdk/components/mesh_renderer.proto";

package/proto/decentraland/sdk/components/audio_analysis.proto

@@ -1,44 +0,0 @@
-syntax = "proto3";
-package decentraland.sdk.components;
-
-import "decentraland/sdk/components/common/id.proto";
-option (common.ecs_component_id) = 1212;
-
-enum PBAudioAnalysisMode {
-    MODE_RAW = 0;
-    MODE_LOGARITHMIC = 1;
-}
-
-message PBAudioAnalysis {
-
-    // Parameters section
-    PBAudioAnalysisMode mode = 1;
-
-    // Used only when mode == MODE_LOGARITHMIC
-    optional float amplitude_gain = 100;
-    optional float bands_gain = 101;
-    // End when mode == MODE_LOGARITHMIC
-
-    // End Parameters section
-
-    // Result section
-    float amplitude = 200;
-
-    // Protobuf doesn't support fixed arrays -> 8 band fields
-    float band_0 = 201;
-    float band_1 = 202;
-    float band_2 = 203;
-    float band_3 = 204;
-    float band_4 = 205;
-    float band_5 = 206;
-    float band_6 = 207;
-    float band_7 = 208;
-
-    // End Result section
-
-    // Future fields
-    // float spectral_centroid = 13;
-    // float spectral_flux = 14;
-    // bool onset = 15;
-    // float bpm = 16;
-}