DualPartition(T) Class

DualPartitionT Class

Represents a spatial partition that internally uses two spatial partitions to manage items: one for static/sleeping items and one for dynamic items.

Inheritance Hierarchy

SystemObject
DigitalRune.Geometry.PartitioningBasePartitionT
DigitalRune.Geometry.PartitioningDualPartitionT

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

Syntax

C++

Copy

public class DualPartition<T> : BasePartition<T>, 
	ISupportBroadPhase<T>, ISupportFrustumCulling<T>

Public Class DualPartition(Of T)
	Inherits BasePartition(Of T)
	Implements ISupportBroadPhase(Of T), ISupportFrustumCulling(Of T)

generic<typename T>
public ref class DualPartition : public BasePartition<T>, 
	ISupportBroadPhase<T>, ISupportFrustumCulling<T>

type DualPartition<'T> =  
    class
        inherit BasePartition<'T>
        interface ISupportBroadPhase<'T>
        interface ISupportFrustumCulling<'T>
    end

Type Parameters

T: The type of item in the spatial partition.

The DualPartitionT type exposes the following members.

Constructors

	Name	Description
	DualPartitionT	Initializes a new instance of the DualPartitionT class which uses two DynamicAabbTreeT partitions.
	DualPartitionT(ISpatialPartitionT, ISpatialPartitionT)	Initializes a new instance of the DualPartitionT class using the given pair of spatial partitions.

Top

Methods

	Name	Description
	Add	Adds an item to the BasePartitionT. (Inherited from BasePartitionT.)
	Clear	Removes all items from the BasePartitionT. (Inherited from BasePartitionT.)
	Clone	Creates a new BasePartitionT that is a clone (deep copy) of the current instance. (Inherited from BasePartitionT.)
	CloneCore	Makes the instance a clone (deep copy) of the specified BasePartitionT. (Overrides BasePartitionTCloneCore(BasePartitionT).)
	Contains	Determines whether the BasePartitionT contains a specific value. (Inherited from BasePartitionT.)
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from BasePartitionT.)
	CreateInstanceCore	When implemented in a derived class, creates a new instance of the BasePartitionT derived class. (Overrides BasePartitionTCreateInstanceCore.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from BasePartitionT.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetOverlaps	Gets overlaps of all items contained in this spatial partition. (Inherited from BasePartitionT.)
	GetOverlaps(Aabb)	Gets the items that touch the given axis-aligned bounding box (AABB). (Inherited from BasePartitionT.)
	GetOverlaps(Aabb)	Gets the items that touch the given axis-aligned bounding box (AABB). (Overrides BasePartitionTGetOverlaps(Aabb).)
	GetOverlaps(ISpatialPartitionT)	Gets overlaps between all items of this spatial partition and the items of another spatial partition. (Overrides BasePartitionTGetOverlaps(ISpatialPartitionT).)
	GetOverlaps(IListPlane)	Gets the items that touch the bounding volume ("k-DOP") defined by a set of planes.
	GetOverlaps(Ray)	Gets the items that touch the given ray. (Overrides BasePartitionTGetOverlaps(Ray).)
	GetOverlaps(Vector3F, Pose, ISpatialPartitionT, Vector3F, Pose)	Gets overlaps between all items of this spatial partition and the items of another spatial partition. (Overrides BasePartitionTGetOverlaps(Vector3F, Pose, ISpatialPartitionT, Vector3F, Pose).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate	Invalidates the cached spatial information of all items in the spatial partition. (Inherited from BasePartitionT.)
	Invalidate(T)	Invalidates the cached spatial information of the specified item. (Inherited from BasePartitionT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific object from the BasePartitionT. (Inherited from BasePartitionT.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Updates the internal structure of this ISpatialPartitionT. (Inherited from BasePartitionT.)

Top

Properties

	Name	Description
	Aabb	Gets the axis-aligned bounding box (AABB) that contains all items. (Inherited from BasePartitionT.)
	Count	Gets the number of items contained in the ICollectionT. (Inherited from BasePartitionT.)
	EnableSelfOverlaps	Gets or sets a value indicating whether self-overlaps are computed. (Inherited from BasePartitionT.)
	Filter	Gets or sets the filter that is used to filter overlaps of two items. (Inherited from BasePartitionT.)
	GetAabbForItem	Gets or sets the method that computes the Aabb of an item. (Inherited from BasePartitionT.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableTGetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from BasePartitionT.)
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from BasePartitionT.)
	ICollectionTIsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from BasePartitionT.)
	ISpatialPartitionTClone	Creates a new spatial partition that is a clone (deep copy) of the current instance. (Inherited from BasePartitionT.)

Top

Remarks

The DualPartitionT can be used as a broad-phase algorithm (see BroadPhase). It can in certain cases outperform the default SweepAndPruneSpaceT.

By default, two spatial partitions of type DynamicAabbTreeT are used (with settings optimized for the static and dynamic case).

Reference

DigitalRune.Geometry.Partitioning Namespace