Open 3D Engine PhysX Gem API Reference 25.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 | 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
 Additional mouse handling by sub-component mode. Does not absorb mouse event.
 
- Public Member Functions inherited from PhysX::PhysXSubComponentModeBase
virtual void ResetValues (const AZ::EntityComponentIdPair &idPair)=0
 

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 (const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay, const AZ::Vector3 &jointPosition, const AZ::Vector3 &snapDirection, 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

◆ DisplaySpecificSnapType()

virtual void PhysX::JointsSubComponentModeSnap::DisplaySpecificSnapType ( const AzFramework::ViewportInfo &  viewportInfo,
AzFramework::DebugDisplayRequests &  debugDisplay,
const AZ::Vector3 &  jointPosition,
const AZ::Vector3 &  snapDirection,
float  snapLength 
)
inlineprotectedvirtual

Override to draw specific snap type display.

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

◆ HandleMouseInteraction()

void PhysX::JointsSubComponentModeSnap::HandleMouseInteraction ( const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &  mouseInteraction)
overridevirtual

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

Reimplemented from PhysX::PhysXSubComponentModeBase.

◆ 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::JointsSubComponentModeSnapPosition, and PhysX::JointsSubComponentModeSnapRotation.

◆ 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: