Show / Hide Table of Contents

    Struct EdgeInfo

    Precalculated information about the edge.

    Inherited Members
    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Elements.Spatial.AdaptiveGrid
    Assembly: Hypar.Elements.dll
    Syntax
    public struct EdgeInfo

    Constructors

    EdgeInfo(AdaptiveGrid, Edge, Double)

    Construct new EdgeInfo structure.

    Declaration
    public EdgeInfo(AdaptiveGrid grid, Edge edge, double factor = 1)
    Parameters
    Type Name Description
    AdaptiveGrid grid

    Grid, edge belongs to.

    Edge edge

    The edge.

    System.Double factor

    Edge traveling factor.

    Fields

    Edge

    The Edge.

    Declaration
    public readonly Edge Edge
    Field Value
    Type Description
    Edge

    Factor

    Edge traveling factor.

    Declaration
    public readonly double Factor
    Field Value
    Type Description
    System.Double

    Length

    Length of the edge.

    Declaration
    public readonly double Length
    Field Value
    Type Description
    System.Double

    Properties

    HasVerticalChange

    Are edge end points on different elevations.

    Declaration
    public readonly bool HasVerticalChange { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    AddFlags(EdgeFlags)

    Add a flag or combinations of flags. Adding a flag more than once has no effect.

    Declaration
    public void AddFlags(EdgeFlags flags)
    Parameters
    Type Name Description
    EdgeFlags flags

    Flag or combination of flags to add. For example: AddFlags(Hint2D) or AddFlags(Hint2D | Hint3D).

    HasAnyFlag(EdgeFlags)

    Check if edge info has a certain flag or combination of flags set.

    Declaration
    public bool HasAnyFlag(EdgeFlags flag)
    Parameters
    Type Name Description
    EdgeFlags flag

    Flag or combination of flags to check. For example: HasAnyFlag(Hint2D) or HasAnyFlag(Hint2D | Hint3D).

    Returns
    Type Description
    System.Boolean

    True if edge have the flag included.