BasePartition(T).Filter Property

BasePartition<T>.Filter Property

Gets or sets the filter that is used to filter overlaps of two items.

Namespace: DigitalRune.Geometry.Partitioning
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)

Syntax

C++

Copy

public IPairFilter<T> Filter { get; set; }

Public Property Filter As IPairFilter(Of T)
	Get
	Set

public:
virtual property IPairFilter<T>^ Filter {
	IPairFilter<T>^ get () sealed;
	void set (IPairFilter<T>^ value) sealed;
}

abstract Filter : IPairFilter<'T> with get, set
override Filter : IPairFilter<'T> with get, set

Property Value

Type: IPairFilter<T>
The filter that is used to filter item overlap pairs.

Implements

ISpatialPartition<T>.Filter

Remarks

The GetOverlaps() methods check whether the items overlap. Then - when a Filter is set - the GetOverlaps() methods apply the filter to all pairs of overlapping items. A Filter can be set to check the item pairs for additional criteria and reject item pairs that do not meet these criteria.

Reference

BasePartition<T> Class

DigitalRune.Geometry.Partitioning Namespace