Class SimpleHighlightAlgorithm<TVertex, TEdge, TGraph>

Simple highlight algorithm.

Inheritance
System.Object
HighlightAlgorithmBase<TVertex, TEdge, TGraph, IHighlightParameters>
SimpleHighlightAlgorithm<TVertex, TEdge, TGraph>
Implements
IHighlightAlgorithm<TVertex, TEdge>
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.Highlight
Assembly: GraphShape.dll
Syntax
public class SimpleHighlightAlgorithm<TVertex, TEdge, TGraph> : HighlightAlgorithmBase<TVertex, TEdge, TGraph, IHighlightParameters>, IHighlightAlgorithm<TVertex, TEdge> where TEdge : IEdge<TVertex> where TGraph : class, IBidirectionalGraph<TVertex, TEdge>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.
TGraph

Graph type.

Constructors

| Improve this Doc View Source

SimpleHighlightAlgorithm(IHighlightController<TVertex, TEdge, TGraph>, IHighlightParameters)

Initializes a new instance of the SimpleHighlightAlgorithm<TVertex, TEdge, TGraph> class.

Declaration
public SimpleHighlightAlgorithm(IHighlightController<TVertex, TEdge, TGraph> controller, IHighlightParameters parameters)
Parameters
Type Name Description
IHighlightController<TVertex, TEdge, TGraph> controller

Highlight controller.
IHighlightParameters parameters

Highlight algorithm parameters.
Exceptions
Type Condition
System.ArgumentNullException

controller is null.

Methods

| Improve this Doc View Source

OnEdgeHighlighting(TEdge)

Asks to highlight the given edge.

Declaration
public override bool OnEdgeHighlighting(TEdge edge)
Parameters
Type Name Description
TEdge edge

Edge to highlight.
Returns
Type Description
System.Boolean

True if the edge was highlighted, false otherwise.
Overrides
GraphShape.Algorithms.Highlight.HighlightAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Highlight.IHighlightParameters>.OnEdgeHighlighting(TEdge)
Exceptions
Type Condition
System.ArgumentNullException

edge is null.
| Improve this Doc View Source

OnEdgeHighlightRemoving(TEdge)

Asks to remove the highlighting of the given edge.

Declaration
public override bool OnEdgeHighlightRemoving(TEdge edge)
Parameters
Type Name Description
TEdge edge

Edge to remove its highlighting.
Returns
Type Description
System.Boolean

True if the edge highlight was removed, false otherwise.
Overrides
GraphShape.Algorithms.Highlight.HighlightAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Highlight.IHighlightParameters>.OnEdgeHighlightRemoving(TEdge)
Exceptions
Type Condition
System.ArgumentNullException

edge is null.
| Improve this Doc View Source

OnVertexHighlighting(TVertex)

Asks to highlight the given vertex.

Declaration
public override bool OnVertexHighlighting(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

Vertex to highlight.
Returns
Type Description
System.Boolean

True if the vertex was highlighted, false otherwise.
Overrides
GraphShape.Algorithms.Highlight.HighlightAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Highlight.IHighlightParameters>.OnVertexHighlighting(TVertex)
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

OnVertexHighlightRemoving(TVertex)

Asks to remove the highlighting of the given vertex.

Declaration
public override bool OnVertexHighlightRemoving(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

Vertex to remove its highlighting.
Returns
Type Description
System.Boolean

True if the vertex highlight was removed, false otherwise.
Overrides
GraphShape.Algorithms.Highlight.HighlightAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Highlight.IHighlightParameters>.OnVertexHighlightRemoving(TVertex)
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

ResetHighlight()

Resets the semi-highlights according to the actually highlighted vertices/edges.

This method should be called if the graph changed, or the highlights should be reset.

Declaration
public override void ResetHighlight()
Overrides
GraphShape.Algorithms.Highlight.HighlightAlgorithmBase<TVertex, TEdge, TGraph, GraphShape.Algorithms.Highlight.IHighlightParameters>.ResetHighlight()

Implements

Extension Methods