Add text class (#271)

* draft class

* corrections

* edits

* max width

* remove import

* typo

* naming

* move directories

* delete from old location

* comment

* formatting

---------

Co-authored-by: Claire Kuang <kuang.claire@gmail.com>

src/Speckle.Objects/Annotation/Text.cs

@@ -0,0 +1,69 @@
+using Speckle.Objects.Geometry;
+using Speckle.Sdk.Models;
+using Point = Speckle.Objects.Geometry.Point;
+
+namespace Speckle.Objects.Annotation;
+
+/// <summary>
+/// Text class for representation in the viewer
+/// </summary>
+[SpeckleType("Objects.Annotation.Text")]
+public class Text : Base
+{
+  /// <summary>
+  /// Plain text, without formatting
+  /// </summary>
+  public required string value { get; set; }
+
+  /// <summary>
+  /// Origin point, relation to the text is defined by AlignmentHorizontal and AlignmentVertical
+  /// </summary>
+  public required Point origin { get; set; }
+
+  /// <summary>
+  /// Height in linear units or pixels (if Units.None)
+  /// </summary>
+  public required double height { get; set; }
+
+  /// <summary>
+  /// Units will be 'Units.None' if the text size is defined in pixels (stays the same size
+  /// independently of zooming the model). Default height in pixels is 17px (used for Viewer measurements)
+  /// </summary>
+  public required string units { get; set; }
+
+  /// <summary>
+  /// Horizontal alignment: Left, Center or Right
+  /// </summary>
+  public AlignmentHorizontal alignmentH { get; set; }
+
+  /// <summary>
+  /// Vertical alignment: Top, Center or Bottom
+  /// </summary>
+  public AlignmentVertical alignmentV { get; set; }
+
+  /// <summary>
+  /// Plane will be null if the text object orientation follows camera view
+  /// </summary>
+  public Plane? plane { get; set; }
+
+  /// <summary>
+  /// Maximum width of the text field (in 'units').
+  /// Text will be split into lines (wrapped) to fit into the width.
+  /// null, if text should not be wrapped.
+  /// </summary>
+  public double? maxWidth { get; set; }
+}
+
+public enum AlignmentHorizontal
+{
+  Left,
+  Center,
+  Right,
+}
+
+public enum AlignmentVertical
+{
+  Top,
+  Center,
+  Bottom,
+}

src/Speckle.Sdk.Dependencies/Serialization/ChannelSaver.cs

@@ -8,7 +8,7 @@ namespace Speckle.Sdk.Dependencies.Serialization;
 public abstract class ChannelSaver<T>
   where T : IHasByteSize
 {
-  private const int SEND_CAPACITY = 500;
+  private const int SEND_CAPACITY = 1000;
   private const int HTTP_SEND_CHUNK_SIZE = 25_000_000; //bytes
   private static readonly TimeSpan HTTP_BATCH_TIMEOUT = TimeSpan.FromSeconds(2);
   private const int MAX_PARALLELISM_HTTP = 4;
@@ -68,14 +68,15 @@ public abstract class ChannelSaver<T>
         TaskScheduler.Current
       );
 
-  public void Save(T item)
+  public async Task SaveAsync(T item, CancellationToken cancellationToken)
   {
     if (Exception is not null)
     {
       return; //don't save if we're already done through an error
     }
-    // ReSharper disable once MethodSupportsCancellation
-    _checkCacheChannel.Writer.TryWrite(item);
+    //can switch to check then try pattern when back pressure is needed or exceptions are too much
+    //the trees don't need to respond to back pressure
+    await _checkCacheChannel.Writer.WriteAsync(item, cancellationToken).ConfigureAwait(false);
   }
 
   private async Task<IMemoryOwner<T>> SendToServer(IMemoryOwner<T> batch)

src/Speckle.Sdk/Serialisation/V2/Send/ObjectSaver.cs

@@ -12,9 +12,7 @@ public interface IObjectSaver : IDisposable
   Task Start(int? maxParallelism, int? httpBatchSize, int? cacheBatchSize, CancellationToken cancellationToken);
   void DoneTraversing();
   Task DoneSaving();
-  void SaveItem(BaseItem item);
-  long Uploaded { get; }
-  long Cached { get; }
+  Task SaveAsync(BaseItem item);
 }
 
 public sealed class ObjectSaver(
@@ -40,8 +38,6 @@ public sealed class ObjectSaver(
   private long _cached;
 
   private long _objectsSerialized;
-  public long Cached => _cached;
-  public long Uploaded => _uploaded;
 
   protected override async Task SendToServerInternal(Batch<BaseItem> batch)
   {
@@ -81,10 +77,10 @@ public sealed class ObjectSaver(
     }
   }
 
-  public void SaveItem(BaseItem item)
+  public async Task SaveAsync(BaseItem item)
   {
     Interlocked.Increment(ref _objectsSerialized);
-    Save(item);
+    await SaveAsync(item, _cancellationTokenSource.Token).ConfigureAwait(false);
   }
 
   public override void SaveToCache(List<BaseItem> batch)

src/Speckle.Sdk/Serialisation/V2/Send/SerializeProcess.cs

@@ -258,7 +258,7 @@ public sealed class SerializeProcess(
             }
 
             Interlocked.Increment(ref _objectsSerialized);
-            objectSaver.SaveItem(item);
+            await objectSaver.SaveAsync(item).ConfigureAwait(false);
           }
 
           if (!currentClosures.ContainsKey(item.Id))