David Kekesi
69 lines
1.7 KiB
C#
69 lines
1.7 KiB
C#
using Speckle.Objects.Geometry;
|
|
using Speckle.Sdk.Models;
|
|
|
|
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>
|
|
/// 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>
|
|
/// If true, the text is oriented to face the screen (camera-aligned).
|
|
/// </summary>
|
|
public required bool screenOriented { 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 axis vectors will be ignored if screenOriented is true
|
|
/// </summary>
|
|
public required 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,
|
|
}
|