Open 3D Engine WhiteBox 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 | Static Public Member Functions | Static Public Attributes | List of all members
WhiteBox::EditorWhiteBoxComponentMode Class Reference

The Component Mode responsible for handling all interactions with the White Box Tool. More...

#include <EditorWhiteBoxComponentMode.h>

Inherits AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode, AzFramework::EntityDebugDisplayEventBus::Handler, AZ::TransformNotificationBus::Handler, EditorWhiteBoxComponentNotificationBus::Handler, and EditorWhiteBoxComponentModeRequestBus::Handler.

Public Member Functions

 EditorWhiteBoxComponentMode (const AZ::EntityComponentIdPair &entityComponentIdPair, AZ::Uuid componentType)
 
 EditorWhiteBoxComponentMode (EditorWhiteBoxComponentMode &&)=delete
 
EditorWhiteBoxComponentMode & operator= (EditorWhiteBoxComponentMode &&)=delete
 
void Refresh () override
 
bool HandleMouseInteraction (const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &mouseInteraction) override
 
AZStd::vector< AzToolsFramework::ActionOverride > PopulateActionsImpl () override
 
AZStd::string GetComponentModeName () const override
 
AZ::Uuid GetComponentModeType () const override
 
void MarkWhiteBoxIntersectionDataDirty () override
 
SubMode GetCurrentSubMode () const override
 
void OverrideKeyboardModifierQuery (const KeyboardModifierQueryFn &keyboardModifierQueryFn) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void RegisterActionContextModes ()
 
static void RegisterActionUpdaters ()
 
static void RegisterActions ()
 
static void BindActionsToModes ()
 
static void BindActionsToMenus ()
 

Static Public Attributes

AZ_CLASS_ALLOCATOR_DECL static constexpr const char *const WhiteboxModeClusterEdgeRestoreTooltip = "Switch to Edge Restore mode"
 
static constexpr const char *const WhiteboxModeClusterDefaultTooltip = "Switch to Sketch mode"
 
static constexpr const char *const WhiteboxModeClusterManipulatorTooltip = "Switch to Manipulator mode"
 

Detailed Description

The Component Mode responsible for handling all interactions with the White Box Tool.

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