Class GraphSelection

Inheritance
object
GraphSelection
Implements
Inherited Members
Namespace: Unity.VisualScripting
Assembly: Unity.VisualScripting.Core.Editor.dll
Syntax
public sealed class GraphSelection : ISet<IGraphElement>, ICollection<IGraphElement>, IEnumerable<IGraphElement>, IEnumerable

Constructors

GraphSelection()

Declaration
public GraphSelection()

Properties

Count

Declaration
public int Count { get; }
Property Value
Type Description
int

IsReadOnly

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
bool

Methods

Add(IGraphElement)

Adds the specified item to the set.

Declaration
public bool Add(IGraphElement item)
Parameters
Type Name Description
IGraphElement item

The item to add to the set.
Returns
Type Description
bool

true if the item was added to the set (i.e., it was not already present); otherwise, false.

Clear()

Declaration
public void Clear()

Contains(IGraphElement)

Declaration
public bool Contains(IGraphElement item)
Parameters
Type Name Description
IGraphElement item
Returns
Type Description
bool

CopyTo(IGraphElement[], int)

Declaration
public void CopyTo(IGraphElement[] array, int arrayIndex)
Parameters
Type Name Description
IGraphElement[] array
int arrayIndex

ExceptWith(IEnumerable<IGraphElement>)

Modifies the current set to contain only elements that are not present in the specified collection.

Declaration
public void ExceptWith(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.

GetEnumerator()

Declaration
public HashSet<IGraphElement>.Enumerator GetEnumerator()
Returns
Type Description
HashSet<IGraphElement>.Enumerator

IntersectWith(IEnumerable<IGraphElement>)

Modifies the current set to contain only elements that are present in both the current set and the specified collection.

Declaration
public void IntersectWith(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.

IsProperSubsetOf(IEnumerable<IGraphElement>)

Determines whether the current set is a proper subset of the specified collection. A proper subset is a subset that is not equal to the other set.

Declaration
public bool IsProperSubsetOf(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set is a proper subset of the specified collection; otherwise, false.

IsProperSupersetOf(IEnumerable<IGraphElement>)

Determines whether the current set is a proper superset of the specified collection. A proper superset is a superset that is not equal to the other set.

Declaration
public bool IsProperSupersetOf(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set is a proper superset of the specified collection; otherwise, false.

IsSubsetOf(IEnumerable<IGraphElement>)

Determines whether the current set is a subset of the specified collection.

Declaration
public bool IsSubsetOf(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set is a subset of the specified collection; otherwise, false.

IsSupersetOf(IEnumerable<IGraphElement>)

Determines whether the current set is a superset of the specified collection.

Declaration
public bool IsSupersetOf(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set is a superset of the specified collection; otherwise, false.

Overlaps(IEnumerable<IGraphElement>)

Determines whether the current set has any elements in common with the specified collection.

Declaration
public bool Overlaps(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set and the specified collection share at least one common element; otherwise, false.

Remove(IGraphElement)

Declaration
public bool Remove(IGraphElement item)
Parameters
Type Name Description
IGraphElement item
Returns
Type Description
bool

RemoveWhere(Predicate<IGraphElement>)

Declaration
public int RemoveWhere(Predicate<IGraphElement> match)
Parameters
Type Name Description
Predicate<IGraphElement> match
Returns
Type Description
int

Select(IEnumerable<IGraphElement>)

Declaration
public void Select(IEnumerable<IGraphElement> items)
Parameters
Type Name Description
IEnumerable<IGraphElement> items

Select(IGraphElement)

Declaration
public void Select(IGraphElement item)
Parameters
Type Name Description
IGraphElement item

SetEquals(IEnumerable<IGraphElement>)

Determines whether the current set and the specified collection contain the same elements.

Declaration
public bool SetEquals(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.
Returns
Type Description
bool

true if the current set and the specified collection contain the same elements; otherwise, false.

SymmetricExceptWith(IEnumerable<IGraphElement>)

Modifies the current set to contain only elements that are present either in the current set or in the specified collection, but not both.

Declaration
public void SymmetricExceptWith(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.

UnionWith(IEnumerable<IGraphElement>)

Modifies the current set to contain all elements that are present in either the current set or the specified collection.

Declaration
public void UnionWith(IEnumerable<IGraphElement> other)
Parameters
Type Name Description
IEnumerable<IGraphElement> other

The collection to compare to the current set.

Events

changed

Declaration
public event Action changed
Event Type
Type Description
Action

Implements

Extension Methods