@dcl/protocol 1.0.0-21671196520.commit-ca94ea2 → 1.0.0-22309437617.commit-6617cff

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/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/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/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";