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 Member Functions | List of all members
PhysX::PhysXSubComponentModeBase Class Referenceabstract

Inherited by PhysX::ColliderAssetScaleMode, PhysX::ColliderBoxMode, PhysX::ColliderCapsuleMode, PhysX::ColliderCylinderMode, PhysX::ColliderOffsetMode, PhysX::ColliderRotationMode, PhysX::ColliderSphereMode, PhysX::JointsSubComponentModeAngleCone, PhysX::JointsSubComponentModeAnglePair, PhysX::JointsSubComponentModeLinearFloat, PhysX::JointsSubComponentModeRotation, PhysX::JointsSubComponentModeSnap, PhysX::JointsSubComponentModeTranslation, and PhysX::NullColliderComponentMode.

Public Member Functions

virtual void Setup (const AZ::EntityComponentIdPair &idPair)=0
 
virtual void Refresh (const AZ::EntityComponentIdPair &idPair)=0
 
virtual void Teardown (const AZ::EntityComponentIdPair &idPair)=0
 
virtual void ResetValues (const AZ::EntityComponentIdPair &idPair)=0
 
virtual void HandleMouseInteraction (const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &mouseInteraction)
 Additional mouse handling by sub-component mode. Does not absorb mouse event.
 

Member Function Documentation

◆ HandleMouseInteraction()

virtual void PhysX::PhysXSubComponentModeBase::HandleMouseInteraction ( const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &  mouseInteraction)
inlinevirtual

Additional mouse handling by sub-component mode. Does not absorb mouse event.

Reimplemented in PhysX::JointsSubComponentModeSnap.

◆ Refresh()

virtual void PhysX::PhysXSubComponentModeBase::Refresh ( const AZ::EntityComponentIdPair &  idPair)
pure virtual

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

Parameters
idPairThe entity/component id pair.

Implemented in PhysX::ColliderAssetScaleMode, PhysX::ColliderBoxMode, PhysX::ColliderCapsuleMode, PhysX::ColliderCylinderMode, PhysX::ColliderOffsetMode, PhysX::ColliderRotationMode, PhysX::ColliderSphereMode, PhysX::JointsSubComponentModeAngleCone, PhysX::JointsSubComponentModeAnglePair, PhysX::JointsSubComponentModeLinearFloat, PhysX::JointsSubComponentModeRotation, PhysX::JointsSubComponentModeSnap, PhysX::JointsSubComponentModeTranslation, and PhysX::NullColliderComponentMode.

◆ ResetValues()

virtual void PhysX::PhysXSubComponentModeBase::ResetValues ( const AZ::EntityComponentIdPair &  idPair)
pure virtual

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

Parameters
idPairThe entity/component id pair.

Implemented in PhysX::ColliderAssetScaleMode, PhysX::ColliderBoxMode, PhysX::ColliderCapsuleMode, PhysX::ColliderCylinderMode, PhysX::ColliderOffsetMode, PhysX::ColliderRotationMode, PhysX::ColliderSphereMode, PhysX::JointsSubComponentModeAngleCone, PhysX::JointsSubComponentModeAnglePair, PhysX::JointsSubComponentModeLinearFloat, PhysX::JointsSubComponentModeRotation, PhysX::JointsSubComponentModeSnapPosition, PhysX::JointsSubComponentModeSnapRotation, PhysX::JointsSubComponentModeTranslation, and PhysX::NullColliderComponentMode.

◆ Setup()

virtual void PhysX::PhysXSubComponentModeBase::Setup ( const AZ::EntityComponentIdPair &  idPair)
pure virtual

Called when the mode is entered to initialize the mode.

Parameters
idPairThe entity/component id pair.

Implemented in PhysX::ColliderAssetScaleMode, PhysX::ColliderBoxMode, PhysX::ColliderCapsuleMode, PhysX::ColliderCylinderMode, PhysX::ColliderOffsetMode, PhysX::ColliderRotationMode, PhysX::ColliderSphereMode, PhysX::JointsSubComponentModeAngleCone, PhysX::JointsSubComponentModeAnglePair, PhysX::JointsSubComponentModeLinearFloat, PhysX::JointsSubComponentModeRotation, PhysX::JointsSubComponentModeSnap, PhysX::JointsSubComponentModeSnapPosition, PhysX::JointsSubComponentModeSnapRotation, PhysX::JointsSubComponentModeTranslation, and PhysX::NullColliderComponentMode.

◆ Teardown()

virtual void PhysX::PhysXSubComponentModeBase::Teardown ( const AZ::EntityComponentIdPair &  idPair)
pure virtual

Called when the mode exits to perform cleanup.

Parameters
idPairThe entity/component id pair.

Implemented in PhysX::ColliderAssetScaleMode, PhysX::ColliderBoxMode, PhysX::ColliderCapsuleMode, PhysX::ColliderCylinderMode, PhysX::ColliderOffsetMode, PhysX::ColliderRotationMode, PhysX::ColliderSphereMode, PhysX::JointsSubComponentModeAngleCone, PhysX::JointsSubComponentModeAnglePair, PhysX::JointsSubComponentModeLinearFloat, PhysX::JointsSubComponentModeRotation, PhysX::JointsSubComponentModeSnap, PhysX::JointsSubComponentModeTranslation, and PhysX::NullColliderComponentMode.

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