Class Interval

Represents an interval in one-dimensional space that is defined as two extrema or bounds.

Hierarchy

  • Interval

Constructors

constructor

Properties

t0 t1

Accessors

IsDecreasing IsIncreasing IsSingleton IsValid Length Max Mid Min T0 T1 Empty Invalid

Methods

Add Clone CompareTo EpsilonEquals Equals GreaterThan GreaterThanOrEqual Grow IncludesInterval IncludesParameter Intersect LessThan LessThanOrEqual MakeIncreasing NormalizedIntervalAt NormalizedParameterAt ParameterAt ParameterIntervalAt Reverse Subtract Swap ToString Union CreateFromInternal Intersect Union

Constructors

constructor

  • Initializes a new instance of the Interval class.

    Parameters

    • t0: number

      The first bound of the interval.

    • t1: number

      The second bound of the interval.

    Returns Interval

Properties

Private t0

t0: number

Private t1

t1: number

Accessors

IsDecreasing

  • get IsDecreasing(): boolean

  • Returns true if T0 > T1.

    Returns boolean

IsIncreasing

  • get IsIncreasing(): boolean

  • Returns true if T0 < T1.

    Returns boolean

IsSingleton

  • get IsSingleton(): boolean

  • Returns true if T0 == T1.

    Returns boolean

IsValid

  • get IsValid(): boolean

  • Gets a value indicating whether or not this Interval is valid. Valid intervals must contain valid numbers.

    Returns boolean

Length

  • get Length(): number

  • Gets the signed length of the numeric range. If the interval is not valid, 0 is returned.

    Remarks

    If the interval is decreasing, a negative length will be returned.

    Returns number

Max

  • get Max(): number

  • Gets the larger of T0 and T1. If the interval is not valid, NaN is returned.

    Returns number

Mid

  • get Mid(): number

  • Gets the average of T0 and T1. If the interval is not valid, NaN is returned.

    Returns number

Min

  • get Min(): number

  • Gets the smaller of T0 and T1. If the interval is not valid, NaN is returned.

    Returns number

T0

  • get T0(): number

  • Gets or sets the lower bound of the Interval.

    Returns number

  • set T0(value: number): void

  • Gets or sets the lower bound of the Interval.

    Parameters

    • value: number

    Returns void

T1

  • get T1(): number

  • Gets or sets the upper bound of the Interval.

    Returns number

  • set T1(value: number): void

  • Gets or sets the upper bound of the Interval.

    Parameters

    • value: number

    Returns void

Static Empty

  • get Empty(): Interval

  • returns an empty interval that goes from 0 to 0.

    Returns Interval

Static Invalid

  • get Invalid(): Interval

  • returns an invalid interval that goes from NaN to NaN.

    Remarks

    An invalid interval is not valid and cannot be used for any calculations.

    Returns Interval

Methods

Add

  • Shifts a interval by a specific amount (addition).

    Returns

    A new interval where T0 and T1 are summed with number.

    Parameters

    • value: number

    Returns Interval

Clone

  • Clones this instance and returns a new Interval.

    Returns

    A new Interval with the same values as this instance.

    Returns Interval

CompareTo

  • Compares this interval with another interval. The lower bound has first evaluation priority.

    Returns

    0: if this is identical to other; -1: if this is less than other; 1: if this is greater than other.

    Remarks

    if either interval is invalid, the comparison is invalid and returns NaN.

    Parameters

    Returns number

EpsilonEquals

  • Check that all values in other are within epsilon of the values in this

    Returns

    Parameters

    • other: Interval
    • epsilon: number = Open3d.EPSILON

    Returns boolean

Equals

  • Determines whether the specified interval is equal to the current interval,

    Parameters

    Returns boolean

GreaterThan

  • Check if the interval is greater than another interval.

    Returns

    Parameters

    Returns boolean

GreaterThanOrEqual

  • Determines whether the first specified Interval comes after (has superior sorting value than) the second Interval, or is equal to it.

    Returns

    Parameters

    Returns boolean

Grow

  • Grows the interval to include the given number.

    Returns

    A new Interval that includes the given number.

    Parameters

    • value: number

      Number to include in this interval.

    Returns Interval

IncludesInterval

  • Tests a parameter for Interval inclusion.

    Returns

    true if the other interval is contained within or is coincident with the limits of this Interval; otherwise false.

    Parameters

    • other: Interval
    • strict: boolean = false

      If true, the parameter must be fully on the inside of the Interval. default is false.

    Returns boolean

IncludesParameter

  • Tests a parameter for Interval inclusion.

    Returns

    true if t is contained within the limits of this Interval.

    Parameters

    • parameter: number
    • strict: boolean = false

      If true, the parameter must be fully on the inside of the Interval. default is false.

    Returns boolean

Intersect

  • Intersection of two intervals.

    Returns

    A new Interval that is the intersection of this and other.

    Parameters

    Returns Interval

LessThan

  • Check if the interval is less than another interval.

    Returns

    Parameters

    Returns boolean

LessThanOrEqual

  • Determines whether the first specified Interval comes before (has inferior sorting value than) the second Interval, or is equal to it.

    Returns

    Parameters

    Returns boolean

MakeIncreasing

  • Returns a ensured increasing interval.

    Returns Interval

NormalizedIntervalAt

  • Converts interval value, or pair of values, to normalized parameter.

    Returns

    Normalized parameter x so that min*(1.0-x) + max*x = intervalParameter.

    Parameters

    Returns Interval

NormalizedParameterAt

  • Converts interval value, or pair of values, to normalized parameter.

    Returns

    Normalized parameter x so that min*(1.0-x) + max*x = intervalParameter.

    Parameters

    • intervalParameter: number

    Returns number

ParameterAt

  • Converts normalized parameter to interval value, or pair of values.

    Returns

    Interval parameter min*(1.0-normalizedParameter) + max*normalizedParameter.

    Parameters

    • normalizedParameter: number

    Returns number

ParameterIntervalAt

  • Converts normalized parameter to interval value, or pair of values.

    Returns

    Interval parameter min*(1.0-normalizedParameter) + max*normalized_paramete.

    Parameters

    Returns Interval

Reverse

  • Changes interval to [-T1, -T0].

    Returns

    A new Interval with [-T1, -T0].

    Remarks

    If the interval is not valid, an empty interval will be returned.

    Returns Interval

Subtract

  • Shifts an interval by a specific amount (subtraction).

    Returns

    A new interval with [T0-number, T1-number].

    Parameters

    • value: number

    Returns Interval

Swap

  • Exchanges T0 and T1.

    Returns

    A new Interval with T0 and T1 swapped.

    Returns Interval

ToString

  • Returns string

Union

  • Union of two intervals.

    Returns

    A new Interval that is the union of this and other.

    Parameters

    Returns Interval

Static CreateFromInternal

  • Initializes a new instance copying the other instance values.

    Returns

    Parameters

    Returns Interval

Static Intersect

Static Union

Settings

Member Visibility

Theme

Generated using TypeDoc