 | CollisionFilter Class |
A basic collision filter supporting pairwise filtering and collision groups.
Inheritance HierarchyNamespace: DigitalRune.Geometry.Collisions
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)
SyntaxThe CollisionFilter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CollisionFilter |
Initializes a new instance of the CollisionFilter class for max. 32
different collision groups.
|
| CollisionFilter(Int32) |
Initializes a new instance of the CollisionFilter class for the given
max. number of collision groups.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
| Filter |
Determines whether the given CollisionObjects can collide.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get(Int32) |
Returns if collisions with the given collision group are enabled.
|
| Get(Int32, Int32) |
Returns if collisions between two collision groups are enabled.
|
| Get(CollisionObject, CollisionObject) |
Returns if collisions between two CollisionObjects are
enabled (without testing collision groups).
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnChanged |
Raises the Changed event.
|
| Reset |
Resets this filter. All collisions will be enabled.
|
| Set(Int32, Boolean) |
Enables or disables collisions with the given collision group.
|
| Set(Int32, Int32, Boolean) |
Enables or disables collisions between a pair of collision groups.
|
| Set(CollisionObject, CollisionObject, Boolean) |
Enables or disables collisions between the given CollisionObjects.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | MaxNumberOfGroups |
The maximum number of supported collision groups.
|
Events
RemarksPer default, all collisions are enabled. Collisions can be disabled for pairs of CollisionObjects, for a pair of collision groups, or for a whole collision group. Collision groups are identified by an Int32 ID, stored in the CollisionObject (see CollisionGroup). Per default, the collision filter supports only collision group IDs in the range 0-31. This limit can be changed in the constructor (see CollisionFilter(Int32)).
Two collision objects A and B will NOT collide if one of the following conditions is met:
- Collisions for the collision group of A are disabled (see Set(Int32, Boolean)).
- Collisions for the collision group of B are disabled (see Set(Int32, Boolean)).
- Collisions between the collision group of A and the collision group of B are disabled (see Set(Int32, Int32, Boolean)).
- Collisions between collision object A and B are disabled (see Set(CollisionObject, CollisionObject, Boolean)).
See Also