Class OverlapRemovalAlgorithmBase<TObject, TParameters>

Base class for all overlap removal algorithm.

Inheritance
System.Object
AlgorithmBase
OverlapRemovalAlgorithmBase<TObject, TParameters>
FSAAlgorithm<TObject, TParameters>
Implements
IOverlapRemovalAlgorithm<TObject, TParameters>
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: GraphShape.Algorithms.OverlapRemoval
Assembly: GraphShape.dll
Syntax
public abstract class OverlapRemovalAlgorithmBase<TObject, TParameters> : AlgorithmBase, IOverlapRemovalAlgorithm<TObject, TParameters>, IOverlapRemovalAlgorithm<TObject>, IAlgorithm where TParameters : IOverlapRemovalParameters
Type Parameters
Name Description
TObject

Object type.
TParameters

Algorithm parameters type.

Constructors

| Improve this Doc View Source

OverlapRemovalAlgorithmBase(IDictionary<TObject, Rect>, TParameters)

Initializes a new instance of the OverlapRemovalAlgorithmBase<TObject, TParameters> class.

Declaration
protected OverlapRemovalAlgorithmBase(IDictionary<TObject, Rect> rectangles, TParameters parameters)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<TObject, Rect> rectangles

Overlap rectangles.
TParameters parameters

Algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

rectangles is null.
System.ArgumentNullException

parameters is null.

Fields

| Improve this Doc View Source

WrappedRectangles

Wrapped rectangles.

Declaration
protected List<RectangleWrapper<TObject>> WrappedRectangles
Field Value
Type Description
System.Collections.Generic.List<RectangleWrapper<TObject>>

Properties

| Improve this Doc View Source

Parameters

Overlap removal parameters.

Declaration
public TParameters Parameters { get; }
Property Value
Type Description
TParameters
| Improve this Doc View Source

Rectangles

Overlap rectangles.

Declaration
public IDictionary<TObject, Rect> Rectangles { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<TObject, Rect>

Methods

| Improve this Doc View Source

AddGaps()

Adds gaps between rectangles.

Declaration
protected virtual void AddGaps()
| Improve this Doc View Source

GetParameters()

Gets overlap removal parameters.

Declaration
public IOverlapRemovalParameters GetParameters()
Returns
Type Description
IOverlapRemovalParameters

Overlap removal parameters.
| Improve this Doc View Source

InternalCompute()

Algorithm compute step.

Declaration
protected sealed override void InternalCompute()
Overrides
| Improve this Doc View Source

RemoveGaps()

Removes gaps between rectangles.

Declaration
protected virtual void RemoveGaps()
| Improve this Doc View Source

RemoveOverlap()

Removes overlap.

Declaration
protected abstract void RemoveOverlap()

Implements

Extension Methods