Open 3D Engine PhysX Gem API Reference  23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
PhysX::BaseColliderComponent Class Reference

Base class for all runtime collider components. More...

#include <BaseColliderComponent.h>

Inherits Component, Handler, Handler, Handler, and Handler.

Inherited by PhysX::BoxColliderComponent, PhysX::CapsuleColliderComponent, PhysX::MeshColliderComponent, PhysX::ShapeColliderComponent, and PhysX::SphereColliderComponent.

Classes

class  ShapeInfoCache
 

Public Member Functions

 AZ_COMPONENT (BaseColliderComponent,"{D0D48233-DCCA-4125-A6AE-4E5AC5E722D3}")
 
void SetShapeConfigurationList (const AzPhysics::ShapeColliderPairList &shapeConfigList)
 
AzPhysics::ShapeColliderPairList GetShapeConfigurations () override
 
AZStd::vector
< AZStd::shared_ptr
< Physics::Shape > > 
GetShapes () override
 
void OnTransformChanged (const AZ::Transform &local, const AZ::Transform &world) override
 
AZ::Aabb GetColliderShapeAabb () override
 
bool IsTrigger () override
 
void SetCollisionLayer (const AZStd::string &layerName, AZ::Crc32 filterTag) override
 
AZStd::string GetCollisionLayerName () override
 
void SetCollisionGroup (const AZStd::string &groupName, AZ::Crc32 filterTag) override
 
AZStd::string GetCollisionGroupName () override
 
void ToggleCollisionLayer (const AZStd::string &layerName, AZ::Crc32 filterTag, bool enabled) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
virtual void UpdateScaleForShapeConfigs ()
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices ([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 

Protected Attributes

ShapeInfoCache m_shapeInfoCache
 
AzPhysics::ShapeColliderPairList m_shapeConfigList
 

Detailed Description

Base class for all runtime collider components.

Member Function Documentation

virtual void PhysX::BaseColliderComponent::UpdateScaleForShapeConfigs ( )
protectedvirtual

Updates the scale of shape configurations to reflect the scale from the transform component. Specific collider components should override this function.

Reimplemented in PhysX::ShapeColliderComponent, PhysX::MeshColliderComponent, PhysX::SphereColliderComponent, PhysX::BoxColliderComponent, and PhysX::CapsuleColliderComponent.


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