PhysX::ColliderOffsetMode Class Reference

Sub component mode for modifying offset on a collider in the viewport. More...

#include <ColliderOffsetMode.h>

Inherits PhysX::PhysXSubComponentModeBase.

Public Member Functions
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 (const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &mouseInteraction)
	Additional mouse handling by sub-component mode. Does not absorb mouse event.

Detailed Description

Sub component mode for modifying offset on a collider in the viewport.

Member Function Documentation

Refresh()

void PhysX::ColliderOffsetMode::Refresh ( const AZ::EntityComponentIdPair &  idPair )

overridevirtual

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

Parameters

idPair

The entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

ResetValues()

void PhysX::ColliderOffsetMode::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

idPair

The entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

Setup()

void PhysX::ColliderOffsetMode::Setup ( const AZ::EntityComponentIdPair &  idPair )

overridevirtual

Called when the mode is entered to initialize the mode.

Parameters

idPair

The entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

Teardown()

void PhysX::ColliderOffsetMode::Teardown ( const AZ::EntityComponentIdPair &  idPair )

overridevirtual

Called when the mode exits to perform cleanup.

Parameters

idPair

The entity/component id pair.

Implements PhysX::PhysXSubComponentModeBase.

---

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

• Gems/PhysX/Core/Code/Editor/ColliderOffsetMode.h