Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
Physics::CollisionFilteringRequests Class Referenceabstract

CollisionFilteringRequests configures filtering settings per entity. More...

#include <CollisionBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void SetCollisionLayer (const AZStd::string &layerName, AZ::Crc32 colliderTag)=0
 
virtual AZStd::string GetCollisionLayerName ()=0
 
virtual void SetCollisionGroup (const AZStd::string &groupName, AZ::Crc32 colliderTag)=0
 
virtual AZStd::string GetCollisionGroupName ()=0
 
virtual void ToggleCollisionLayer (const AZStd::string &layerName, AZ::Crc32 colliderTag, bool enabled)=0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

CollisionFilteringRequests configures filtering settings per entity.

Member Function Documentation

◆ GetCollisionGroupName()

virtual AZStd::string Physics::CollisionFilteringRequests::GetCollisionGroupName ( )
pure virtual

Gets the collision group name for a collider on an entity. If the collision group can't be found, an empty string is returned. Note: Multiple colliders on an entity are currently not supported.

◆ GetCollisionLayerName()

virtual AZStd::string Physics::CollisionFilteringRequests::GetCollisionLayerName ( )
pure virtual

Gets the collision layer name for a collider on an entity If the collision layer can't be found, an empty string is returned. Note: Multiple colliders on an entity are currently not supported.

◆ SetCollisionGroup()

virtual void Physics::CollisionFilteringRequests::SetCollisionGroup ( const AZStd::string &  groupName,
AZ::Crc32  colliderTag 
)
pure virtual

Sets the collision group on an entity. groupName should match a group defined in the PhysX configuration window. Colliders with a matching colliderTag will be updated. Specify the empty tag to update all colliders.

◆ SetCollisionLayer()

virtual void Physics::CollisionFilteringRequests::SetCollisionLayer ( const AZStd::string &  layerName,
AZ::Crc32  colliderTag 
)
pure virtual

Sets the collision layer on an entity. layerName should match a layer defined in the PhysX cConfiguration window. Colliders with a matching colliderTag will be updated. Specify the empty tag to update all colliders.

◆ ToggleCollisionLayer()

virtual void Physics::CollisionFilteringRequests::ToggleCollisionLayer ( const AZStd::string &  layerName,
AZ::Crc32  colliderTag,
bool  enabled 
)
pure virtual

Toggles a single collision layer on or off on an entity. layerName should match a layer defined in the PhysX configuration window. Colliders with a matching colliderTag will be updated. Specify the empty tag to update all colliders.

The documentation for this class was generated from the following file: