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 | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PhysX::JointsSubComponentModeSnap Class Reference

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

Inherited by PhysX::JointsSubComponentModeSnapPosition, and PhysX::JointsSubComponentModeSnapRotation.

Public Member Functions

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

Public Attributes

 AZ_CLASS_ALLOCATOR_DECL
 

Protected Member Functions

AZStd::string GetPickedEntityName ()
 
AZ::Vector3 GetPosition () const
 
void DisplayEntityViewport (const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay) override
 
virtual void DisplaySpecificSnapType ([[maybe_unused]] const AzFramework::ViewportInfo &viewportInfo, [[maybe_unused]] AzFramework::DebugDisplayRequests &debugDisplay, [[maybe_unused]] const AZ::Vector3 &jointPosition, [[maybe_unused]] const AZ::Vector3 &snapDirection, [[maybe_unused]] float snapLength)
 Override to draw specific snap type display.
 

Protected Attributes

EditorViewportEntityPicker m_picker
 
AZ::EntityId m_pickedEntity
 
AZ::Aabb m_pickedEntityAabb = AZ::Aabb::CreateNull()
 
AZ::Vector3 m_pickedPosition
 
AZ::EntityComponentIdPair m_entityComponentId
 
AZStd::shared_ptr< AzToolsFramework::LinearManipulator > m_manipulator
 

Member Function Documentation

◆ Refresh()

virtual void PhysX::JointsSubComponentModeSnap::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.

◆ Setup()

virtual void PhysX::JointsSubComponentModeSnap::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.

Reimplemented in PhysX::JointsSubComponentModeSnapRotation, and PhysX::JointsSubComponentModeSnapPosition.

◆ Teardown()

virtual void PhysX::JointsSubComponentModeSnap::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: