ContactSet Class

ContactSet Class

A collection of Contacts that describe the contact points or closest points between to collision objects.

Inheritance Hierarchy

SystemObject
DigitalRune.Geometry.CollisionsContactSet

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

Syntax

C++

Copy

public sealed class ContactSet : IList<Contact>, 
	ICollection<Contact>, IEnumerable<Contact>, IEnumerable, 
	ICollection, IRecyclable

Public NotInheritable Class ContactSet
	Implements IList(Of Contact), ICollection(Of Contact), 
	IEnumerable(Of Contact), IEnumerable, ICollection, IRecyclable

public ref class ContactSet sealed : IList<Contact^>, 
	ICollection<Contact^>, IEnumerable<Contact^>, IEnumerable, 
	ICollection, IRecyclable

[<SealedAttribute>]
type ContactSet =  
    class
        interface IList<Contact>
        interface ICollection<Contact>
        interface IEnumerable<Contact>
        interface IEnumerable
        interface ICollection
        interface IRecyclable
    end

The ContactSet type exposes the following members.

Methods

	Name	Description
	Add	Adds a Contact to the end of the ContactSet.
	AsReadOnly	Returns a read-only IListT wrapper for the current ContactSet.
	Clear	Removes and recycles all Contacts from the ContactSet.
	Contains	Determines whether the ContactSet contains a specific Contact.
	CopyTo	Copies the Contacts of the ContactSet to an Array, starting at a particular Array index.
	Create	Creates an instance of the ContactSet class. (This method reuses a previously recycled instance or allocates a new instance if necessary.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the ContactSet.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of a specific Contact in the ContactSet.
	Insert	Inserts an Contact in the ContactSet at the specified index.
	Recycle	Recycles this instance of the ContactSet class.
	Recycle(Boolean)	Recycles this instance of the ContactSet class.
	Remove	Removes the first occurrence of a specific Contact from the ContactSet.
	RemoveAt	Removes the Contact at the specified index.
	Reset	Resets this contact set to default values.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Extension Methods

	Name	Description
	AddRangeContact	Adds the specified items to the ICollectionT. (Defined by CollectionHelper.)
	DoContact(ActionContact)	Overloaded. Performs the given action on each element in a sequence when it is enumerated. (Defined by LinqHelper.)
	DoContact(ActionContact, Int32)	Overloaded. Performs the given action on each element (incorporating its index) in a sequence when it is enumerated. (Defined by LinqHelper.)
	ForEachContact(ActionContact)	Overloaded. Immediately performs the given action on each element in a sequence. (Defined by LinqHelper.)
	ForEachContact(ActionContact, Int32)	Overloaded. Immediately performs the given action on each element (incorporating its index) in a sequence. (Defined by LinqHelper.)
	IndexOfContact	Returns the index of the first element in a sequence that satisfies the specified condition. (Defined by LinqHelper.)

Top

Properties

	Name	Description
	Count	Gets the number of Contacts contained in the ContactSet.
	HaveContact	Gets or sets a value indicating whether ObjectA and ObjectB are in contact.
	Item	Gets or sets the Contact at the specified index.
	ObjectA	Gets collision object A.
	ObjectB	Gets collision object B.
	Swapped	Gets a copy of the contact set where ObjectA and ObjectB are swapped.

Top

Explicit Interface Implementations

	Name	Description
	ICollectionCopyTo	Copies the Contacts of the ContactSet to an Array, starting at a particular Array index.
	IEnumerableContactGetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.
	ICollectionContactIsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe).
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection.

Top

Remarks

A ContactSet collects Contacts between two CollisionObjects. A CollisionDomain creates one ContactSet for each pair of touching objects.

Swapped Contact Sets: The order of ObjectA and ObjectB is determined in the collision detection when the contact set is created. When the collision detection returns a contact set with a method like GetContacts(objectA, objectB), the objects in the contact set could be swapped such that contactSet.ObjectA == objectB and contactSet.ObjectB == objectA. If your algorithms rely on the order of ObjectA and ObjectB, for example when the contact normal vectors are used, you need to manually check whether the objects are in the expected order. By calling the property Swapped you can get a copy of the contact set where ObjectA and ObjectB are swapped and all contacts are updated accordingly.

Reference

DigitalRune.Geometry.Collisions Namespace