CurveIntersections

References
public class CurveIntersections : IDisposable, IList<IntersectionEvent>
Maintains an ordered list of Curve Intersection results.

Finalizer

~CurveIntersections

#
~CurveIntersections()
Destructor.

Properties

Count

#Since v5.0
public int Count { get; }
Gets the number of recorded intersection events.
Explicit

ICollection<IntersectionEvent>.IsReadOnly

#
bool ICollection<IntersectionEvent>.IsReadOnly
This collection is read-only, so this property returns always true.

Indexers

Explicit

IList<IntersectionEvent>.this[]

#
IntersectionEvent IList<IntersectionEvent>.this[int index]
Gets the intersection event data at the given index; setting always throws an exception.
Parameters:
index (int)Index of intersection event to retrieve.
Returns: The intersection event.
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown when setting this indexer.

this[]

#
public IntersectionEvent this[int index] { get; }
Gets the intersection event data at the given index.
Parameters:
index (int)Index of intersection event to retrieve.

Methods

CopyTo

#Since v5.0
public void CopyTo(IntersectionEvent[] array, int arrayIndex)
Copies all intersection results into another array, departing at an index in the target array.
Parameters:
array (IntersectionEvent[])The target array. This value cannot be null.
arrayIndex (int)Zero-based index in which to start the copy.
Exceptions:
ArgumentNullExceptionIf array is null.
ArgumentOutOfRangeExceptionIf arrayIndex is less than 0.
ArgumentExceptionIf array is multi-dimensional; or if arrayIndex is larger than or equal to the length of this collection; or this collection contains more IntersectionEvents than the ones that can be stored in array after and including arrayIndex.

Dispose

#Since v5.0
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Parameters:
disposing (bool)true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.

GetEnumerator

#Since v5.0
public IEnumerator<IntersectionEvent> GetEnumerator()
Returns an enumerator that is capable of yielding all IntersectionEvents in the collection.
Returns: The constructed enumerator.
Explicit

ICollection<IntersectionEvent>.Add

#
void ICollection<IntersectionEvent>.Add(IntersectionEvent item)
Addition is not supported and this method always throws NotSupportedException.
Parameters:
item (IntersectionEvent)Addition is not supported and this value is ignored.
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown.
Explicit

ICollection<IntersectionEvent>.Clear

#
void ICollection<IntersectionEvent>.Clear()
Clearing is not supported and this method always throws NotSupportedException.
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown.
Explicit

ICollection<IntersectionEvent>.Contains

#
bool ICollection<IntersectionEvent>.Contains(IntersectionEvent item)
Allows to establish whether this collection contains and IntersectionEvent.

This method is O(n), where n is the Count of elements in this collection.

Parameters:
item (IntersectionEvent)Object to be found.
Returns: true if element is contained; otherwise false.
Explicit

ICollection<IntersectionEvent>.Remove

#
bool ICollection<IntersectionEvent>.Remove(IntersectionEvent item)
Removal is not supported and this method always throws NotSupportedException.
Parameters:
item (IntersectionEvent)
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown.
Explicit

IList<IntersectionEvent>.IndexOf

#
int IList<IntersectionEvent>.IndexOf(IntersectionEvent item)
Determines the index of an IntersectionEvent.
Parameters:
item (IntersectionEvent)The IntersectionEvent to be found.
Returns: The index in case the IntersectionEvent was found; -1 otherwise.
Explicit

IList<IntersectionEvent>.Insert

#
void IList<IntersectionEvent>.Insert(int index, IntersectionEvent item)
Inserting is not supported and this method always throws NotSupportedException.
Parameters:
index (int)Inserting is not supported and this value is ignored.
item (IntersectionEvent)Inserting is not supported and this value is ignored.
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown.
Explicit

IList<IntersectionEvent>.RemoveAt

#
void IList<IntersectionEvent>.RemoveAt(int index)
Removal is not supported and this method always throws NotSupportedException.
Parameters:
index (int)Removal is not supported and this value is ignored.
Exceptions:
NotSupportedExceptionNotSupportedException is always thrown.
Explicit

IEnumerable.GetEnumerator

#Since v5.0
IEnumerator IEnumerable.GetEnumerator()
Returns a non-generic enumerator that is capable of yielding all IntersectionEvents in the collection. This returns the same enumerator as the generic counterpart.
Returns: The constructed enumerator.