Pointcloud.cs

using System.Collections.Generic;
using System.Linq;
using Objects.Other;
using Speckle.Core.Kits;
using Speckle.Core.Logging;
using Speckle.Core.Models;

namespace Objects.Geometry;

/// <summary>
/// A collection of points, with color and size support.
/// </summary>
public class Pointcloud : Base, IHasBoundingBox, ITransformable<Pointcloud>
{
  /// <summary>
  /// Constructs an empty <see cref="Pointcloud"/>
  /// </summary>
  public Pointcloud() { }

  /// <param name="points">Flat list of x,y,z coordinates</param>
  /// <param name="colors">Optional list of colors</param>
  /// <param name="sizes">Optional list of sizes</param>
  [SchemaInfo(nameof(Pointcloud), "Create a point cloud object", "Objects", "Geometry")]
  public Pointcloud(List<double> points, List<int>? colors = null, List<double>? sizes = null)
  {
    this.points = points;
    this.colors = colors ?? new();
    this.sizes = sizes ?? new();
  }

  /// <summary>
  /// Gets or sets the list of points of this <see cref="Pointcloud"/>, stored as a flat list of coordinates [x1,y1,z1,x2,y2,...]
  /// </summary>
  [DetachProperty, Chunkable(31250)]
  public List<double> points { get; set; } = new();

  /// <summary>
  /// Gets or sets the list of colors of this <see cref="Pointcloud"/>'s points., stored as ARGB <see cref="int"/>s.
  /// </summary>
  [DetachProperty, Chunkable(62500)]
  public List<int> colors { get; set; } = new();

  /// <summary>
  /// Gets or sets the list of sizes of this <see cref="Pointcloud"/>'s points.
  /// </summary>
  [DetachProperty, Chunkable(62500)]
  public List<double> sizes { get; set; } = new();

  /// <summary>
  /// The unit's this <see cref="Pointcloud"/> is in.
  /// This should be one of <see cref="Speckle.Core.Kits.Units"/>
  /// </summary>
  public string units { get; set; }

  /// <inheritdoc/>
  public Box bbox { get; set; }

  /// <inheritdoc/>
  public bool TransformTo(Transform transform, out Pointcloud transformed)
  {
    // transform points
    var transformedPoints = new List<Point>();
    foreach (var point in GetPoints())
    {
      point.TransformTo(transform, out Point transformedPoint);
      transformedPoints.Add(transformedPoint);
    }

    transformed = new Pointcloud
    {
      units = units,
      points = transformedPoints.SelectMany(o => o.ToList()).ToList(),
      colors = colors,
      sizes = sizes,
      applicationId = applicationId
    };

    return true;
  }

  /// <inheritdoc/>
  public bool TransformTo(Transform transform, out ITransformable transformed)
  {
    var res = TransformTo(transform, out Pointcloud pc);
    transformed = pc;
    return res;
  }

  /// <returns><see cref="points"/> as list of <see cref="Point"/>s</returns>
  /// <exception cref="SpeckleException">when list is malformed</exception>
  public List<Point> GetPoints()
  {
    if (points.Count % 3 != 0)
    {
      throw new SpeckleException(
        $"{nameof(Pointcloud)}.{nameof(points)} list is malformed: expected length to be multiple of 3"
      );
    }

    var pts = new List<Point>(points.Count / 3);
    for (int i = 2; i < points.Count; i += 3)
    {
      pts.Add(new Point(points[i - 2], points[i - 1], points[i], units));
    }

    return pts;
  }
}