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

#include <EditorWhiteBoxDefaultMode.h>

Inherits EditorWhiteBoxDefaultModeRequestBus::Handler, EditorWhiteBoxPolygonModifierNotificationBus::Handler, and EditorWhiteBoxEdgeModifierNotificationBus::Handler.

Public Types

using SelectedTranslationModifier = AZStd::variant< AZStd::monostate, AZStd::unique_ptr< PolygonTranslationModifier >, AZStd::unique_ptr< EdgeTranslationModifier >, AZStd::unique_ptr< VertexTranslationModifier > >
 

Public Member Functions

 DefaultMode (const AZ::EntityComponentIdPair &entityComponentIdPair)
 
 DefaultMode (DefaultMode &&)=default
 
DefaultMode & operator= (DefaultMode &&)=default
 
void Refresh ()
 
AZStd::vector< AzToolsFramework::ActionOverride > PopulateActions (const AZ::EntityComponentIdPair &entityComponentIdPair)
 
void Display (const AZ::EntityComponentIdPair &entityComponentIdPair, const AZ::Transform &worldFromLocal, const IntersectionAndRenderData &renderData, const AzFramework::ViewportInfo &viewportInfo, AzFramework::DebugDisplayRequests &debugDisplay)
 
bool HandleMouseInteraction (const AzToolsFramework::ViewportInteraction::MouseInteractionEvent &mouseInteraction, const AZ::EntityComponentIdPair &entityComponentIdPair, const AZStd::optional< EdgeIntersection > &edgeIntersection, const AZStd::optional< PolygonIntersection > &polygonIntersection, const AZStd::optional< VertexIntersection > &vertexIntersection)
 

Static Public Member Functions

static void RegisterActionUpdaters ()
 
static void RegisterActions ()
 
static void BindActionsToModes (const AZStd::string &modeIdentifier)
 
static void BindActionsToMenus ()
 

Detailed Description

The default mode of the EditorWhiteBoxComponentMode - this state allows immediate interaction of polygons and edges.

Member Typedef Documentation

◆ SelectedTranslationModifier

using WhiteBox::DefaultMode::SelectedTranslationModifier = AZStd::variant< AZStd::monostate, AZStd::unique_ptr<PolygonTranslationModifier>, AZStd::unique_ptr<EdgeTranslationModifier>, AZStd::unique_ptr<VertexTranslationModifier> >

A variant to hold either a selected polygon translation, edge translation, or a vertex selection modifier - default is empty (monostate).

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