Gondwana.Physics.Collisions.CollisionProfileRegistry Class Reference

Stores named collision-filtering profiles for a scene. Profiles resolve their group names through the scene's CollisionGroupRegistry. More...

Public Member Functions
	CollisionProfileRegistry ()
	Initializes a registry with Gondwana's standard collision profiles.
CollisionProfile	Define (string name, string collisionGroup, IEnumerable< string >? collidesWith=null, bool collidesWithAll=false)
	Defines or replaces a named profile.
CollisionProfile	Get (string name)
	Gets a previously defined profile.
bool	TryGet (string name, out CollisionProfile? profile)
	Attempts to get a previously defined profile.
IReadOnlyCollection< string >	GetProfileNames ()
	Gets the names of all defined profiles.

Detailed Description

Stores named collision-filtering profiles for a scene. Profiles resolve their group names through the scene's CollisionGroupRegistry.

Definition at line 9 of file CollisionProfileRegistry.cs.

Constructor & Destructor Documentation

CollisionProfileRegistry()

Gondwana.Physics.Collisions.CollisionProfileRegistry.CollisionProfileRegistry

(

)

Initializes a registry with Gondwana's standard collision profiles.

Definition at line 17 of file CollisionProfileRegistry.cs.

Member Function Documentation

Define()

CollisionProfile Gondwana.Physics.Collisions.CollisionProfileRegistry.Define	(	string	name,
		string	collisionGroup,
		IEnumerable< string >?	collidesWith = null,
		bool	collidesWithAll = false )

Defines or replaces a named profile.

Parameters

name	The case-insensitive collision profile name.
collisionGroup	The name of the collision group assigned to the profile.
collidesWith	The names of the groups that this profile can collide with.
collidesWithAll	Whether this profile collides with every collision group.

Returns

The profile registered under the supplied name.

Definition at line 44 of file CollisionProfileRegistry.cs.

Get()

CollisionProfile Gondwana.Physics.Collisions.CollisionProfileRegistry.Get

(

string

name

)

Gets a previously defined profile.

Parameters

name	The case-insensitive collision profile name.

Returns

The collision profile registered under the supplied name.

Definition at line 65 of file CollisionProfileRegistry.cs.

GetProfileNames()

IReadOnlyCollection< string > Gondwana.Physics.Collisions.CollisionProfileRegistry.GetProfileNames

(

)

Gets the names of all defined profiles.

Returns

The names of the currently defined collision profiles.

TryGet()

bool Gondwana.Physics.Collisions.CollisionProfileRegistry.TryGet	(	string	name,
		out CollisionProfile?	profile )

Attempts to get a previously defined profile.

Parameters

name	The case-insensitive collision profile name.
profile	When this method returns, contains the profile.

Returns

true if the profile was found; otherwise, false.

Definition at line 82 of file CollisionProfileRegistry.cs.