Open 3D Engine PhysX Gem 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 Types | Public Member Functions | Static Public Member Functions | List of all members
PhysX::SphereColliderComponent Class Reference

#include <SphereColliderComponent.h>

Inherits PhysX::BaseColliderComponent.

Public Types

using Configuration = Physics::SphereShapeConfiguration
 

Public Member Functions

 AZ_COMPONENT (SphereColliderComponent, "{108CD341-E5C3-4AE1-B712-21E81ED6C277}", BaseColliderComponent)
 
void UpdateScaleForShapeConfigs () override
 
- Public Member Functions inherited from PhysX::BaseColliderComponent
 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)
 
- Static Public Member Functions inherited from PhysX::BaseColliderComponent
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Member Functions inherited from PhysX::BaseColliderComponent
void Activate () override
 
void Deactivate () override
 
virtual void UpdateScaleForShapeConfigs ()
 
- Static Protected Member Functions inherited from PhysX::BaseColliderComponent
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
- Protected Attributes inherited from PhysX::BaseColliderComponent
ShapeInfoCache m_shapeInfoCache
 
AzPhysics::ShapeColliderPairList m_shapeConfigList
 

Detailed Description

Component that provides sphere shape collider. May be used in conjunction with a PhysX Rigid Body Component to create a dynamic rigid body, or on its own to create a static rigid body.

Member Function Documentation

◆ UpdateScaleForShapeConfigs()

void PhysX::SphereColliderComponent::UpdateScaleForShapeConfigs ( )
overridevirtual

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

Reimplemented from PhysX::BaseColliderComponent.

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