Class RadiusBugPruner

The class that defines how to prune bugs by a radius. Bugs that aren't within the range of the radius are removed.

Inheritance

object

RadiusBugPruner

Implements

IBugPruner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.Aruba

Assembly: Phoenix.Plugin.Aruba.dll

Syntax

public class RadiusBugPruner : IBugPruner

Remarks

Initializes a new instance of RadiusBugPruner.

Constructors

RadiusBugPruner(DuplicateCheckerOptions, int, Vector3)

The class that defines how to prune bugs by a radius. Bugs that aren't within the range of the radius are removed.

Declaration

public RadiusBugPruner(DuplicateCheckerOptions settings, int radius, Vector3 currentLocation)

Parameters

Type	Name	Description
DuplicateCheckerOptions	settings	The duplicate checking settings that define the location fields.
int	radius	The radius that defines which bugs are within range.
Vector3	currentLocation	The current location of the bug to compare other bugs against.

Remarks

Initializes a new instance of RadiusBugPruner.

Properties

Center

Gets or sets the center point to compare bug locations against.

Declaration

public Vector3? Center { get; set; }

Property Value

Type	Description
Vector3?

Radius

Gets or sets the radius that defines which bugs are within range.

Declaration

public int Radius { get; set; }

Property Value

Type	Description
int

Methods

Prune(IEnumerable<BugInfo>)

Removes bugs from a given collection.

Declaration

public IEnumerable<DupeCheckBugInfo> Prune(IEnumerable<BugInfo> dupeCheckBugs)

Parameters

Type	Name	Description
IEnumerable<BugInfo>	dupeCheckBugs	The collection of potential duplicate bugs.

Returns

Type	Description
IEnumerable<DupeCheckBugInfo>	A collection of duplicate check bugs that remain after dupeCheckBugs has been pruned.

Implements

IBugPruner