Open 3D Engine PhysX Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
PhysX::ColliderCylinderMode Class Reference

Sub component mode for modifying the height and radius on a cylinder collider. More...

#include <ColliderCylinderMode.h>

Inherits PhysX::PhysXSubComponentModeBase, and AzFramework::EntityDebugDisplayEventBus::Handler.

Public Member Functions

AZ_CLASS_ALLOCATOR_DECL void Setup (const AZ::EntityComponentIdPair &idPair) override
 
void Refresh (const AZ::EntityComponentIdPair &idPair) override
 
void Teardown (const AZ::EntityComponentIdPair &idPair) override
 
void ResetValues (const AZ::EntityComponentIdPair &idPair) override
 
- Public Member Functions inherited from PhysX::PhysXSubComponentModeBase
virtual void HandleMouseInteraction ([[maybe_unused]] const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &mouseInteraction)
 Additional mouse handling by sub-component mode. Does not absorb mouse event.
 

Detailed Description

Sub component mode for modifying the height and radius on a cylinder collider.

Member Function Documentation

◆ Refresh()

void PhysX::ColliderCylinderMode::Refresh ( const AZ::EntityComponentIdPair &  idPair)
overridevirtual

Called when the mode needs to refresh it's values.

Parameters
idPairThe entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

◆ ResetValues()

void PhysX::ColliderCylinderMode::ResetValues ( const AZ::EntityComponentIdPair &  idPair)
overridevirtual

Called when reset hot key is pressed. Should reset values in the sub component mode to sensible defaults.

Parameters
idPairThe entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

◆ Setup()

AZ_CLASS_ALLOCATOR_DECL void PhysX::ColliderCylinderMode::Setup ( const AZ::EntityComponentIdPair &  idPair)
overridevirtual

Called when the mode is entered to initialize the mode.

Parameters
idPairThe entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

◆ Teardown()

void PhysX::ColliderCylinderMode::Teardown ( const AZ::EntityComponentIdPair &  idPair)
overridevirtual

Called when the mode exits to perform cleanup.

Parameters
idPairThe entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

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