Show / Hide Table of Contents

    Class Symbol

    An alternate representation of an object.

    Inheritance
    System.Object
    Symbol
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Elements
    Assembly: Hypar.Elements.dll
    Syntax
    public class Symbol

    Constructors

    Symbol(GeometryReference, SymbolCameraPosition)

    Construct a symbol.

    Declaration
    [JsonConstructor]
    public Symbol(GeometryReference geometry, SymbolCameraPosition cameraPosition)
    Parameters
    Type Name Description
    GeometryReference geometry

    The geometry of the symbol.

    SymbolCameraPosition cameraPosition

    A named camera position for this representation.

    Properties

    CameraPosition

    A named camera position for this representation, indicating the direction from which the camera is looking (a top view looks from top down, a north view looks from north to south.)

    Declaration
    [JsonProperty("CameraPosition", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    public SymbolCameraPosition CameraPosition { get; set; }
    Property Value
    Type Description
    SymbolCameraPosition

    Geometry

    The geometry of the symbol.

    Declaration
    [JsonProperty("Geometry", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public GeometryReference Geometry { get; set; }
    Property Value
    Type Description
    GeometryReference

    Methods

    GetGeometryAsync()

    Get the geometry from this symbol.

    Declaration
    public async Task<IEnumerable<object>> GetGeometryAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.Object>>