12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351 |
- /*
- * Copyright (c) Contributors to the Open 3D Engine Project.
- * For complete copyright and license terms please see the LICENSE at the root of this distribution.
- *
- * SPDX-License-Identifier: Apache-2.0 OR MIT
- *
- */
- // Description : implementation filefov
- #include "EditorDefs.h"
- #include "EditorViewportWidget.h"
- // Qt
- #include <QBoxLayout>
- #include <QCheckBox>
- #include <QMessageBox>
- #include <QPainter>
- #include <QScopedValueRollback>
- #include <QTimer>
- // AzCore
- #include <AzCore/Component/EntityId.h>
- #include <AzCore/Console/IConsole.h>
- #include <AzCore/Interface/Interface.h>
- #include <AzCore/Math/MathUtils.h>
- #include <AzCore/Math/VectorConversions.h>
- // AzFramework
- #include <AzFramework/Components/CameraBus.h>
- #if defined(AZ_PLATFORM_WINDOWS)
- #include <AzFramework/Input/Buses/Notifications/RawInputNotificationBus_Platform.h>
- #endif // defined(AZ_PLATFORM_WINDOWS)
- #include <AzFramework/Input/Devices/Mouse/InputDeviceMouse.h> // for AzFramework::InputDeviceMouse
- #include <AzFramework/Viewport/ViewportControllerList.h>
- // AzQtComponents
- #include <AzQtComponents/Utilities/QtWindowUtilities.h>
- // AzToolsFramework
- #include <AzToolsFramework/API/ComponentEntityObjectBus.h>
- #include <AzToolsFramework/API/EditorCameraBus.h>
- #include <AzToolsFramework/API/ViewportEditorModeTrackerInterface.h>
- #include <AzToolsFramework/Editor/ActionManagerUtils.h>
- #include <AzToolsFramework/Manipulators/ManipulatorManager.h>
- #include <AzToolsFramework/Viewport/ViewBookmarkLoaderInterface.h>
- #include <AzToolsFramework/Viewport/ViewportSettings.h>
- #include <AzToolsFramework/ViewportSelection/EditorInteractionSystemViewportSelectionRequestBus.h>
- #include <AzToolsFramework/ViewportSelection/EditorTransformComponentSelectionRequestBus.h>
- // AtomToolsFramework
- #include <AtomToolsFramework/Viewport/RenderViewportWidget.h>
- // AzFramework
- #include <AzFramework/Render/IntersectorInterface.h>
- // Editor
- #include "AnimationContext.h"
- #include "Core/QtEditorApplication.h"
- #include "CryCommon/MathConversion.h"
- #include "CryEditDoc.h"
- #include "CustomResolutionDlg.h"
- #include "DisplaySettings.h"
- #include "EditorPreferencesPageGeneral.h"
- #include "EditorViewportCamera.h"
- #include "EditorViewportSettings.h"
- #include "GameEngine.h"
- #include "Include/IDisplayViewport.h"
- #include "Include/IObjectManager.h"
- #include "LayoutWnd.h"
- #include "MainWindow.h"
- #include "Objects/EntityObject.h"
- #include "Objects/ObjectManager.h"
- #include "ProcessInfo.h"
- #include "Util/fastlib.h"
- #include "ViewManager.h"
- #include "ViewPane.h"
- #include "ViewportManipulatorController.h"
- // Atom
- #include <Atom/RPI.Public/RenderPipeline.h>
- #include <Atom/RPI.Public/View.h>
- #include <Atom/RPI.Public/ViewProviderBus.h>
- #include <Atom/RPI.Public/ViewportContextManager.h>
- #include <AzCore/Console/IConsole.h>
- #include <AzCore/Math/MatrixUtils.h>
- #include <QtGui/private/qhighdpiscaling_p.h>
- AZ_CVAR(
- bool, ed_visibility_logTiming, false, nullptr, AZ::ConsoleFunctorFlags::Null, "Output the timing of the new IVisibilitySystem query");
- EditorViewportWidget* EditorViewportWidget::m_pPrimaryViewport = nullptr;
- #if AZ_TRAIT_OS_PLATFORM_APPLE
- void StopFixedCursorMode();
- void StartFixedCursorMode(QObject* viewport);
- #endif
- #define RENDER_MESH_TEST_DISTANCE (0.2f)
- #define CURSOR_FONT_HEIGHT 8.0f
- namespace AZ::ViewportHelpers
- {
- static const char TextCantCreateCameraNoLevel[] = "Cannot create camera when no level is loaded.";
- class EditorEntityNotifications : public AzToolsFramework::EditorEntityContextNotificationBus::Handler
- {
- public:
- EditorEntityNotifications(EditorViewportWidget& editorViewportWidget)
- : m_editorViewportWidget(editorViewportWidget)
- {
- AzToolsFramework::EditorEntityContextNotificationBus::Handler::BusConnect();
- }
- ~EditorEntityNotifications() override
- {
- AzToolsFramework::EditorEntityContextNotificationBus::Handler::BusDisconnect();
- }
- // AzToolsFramework::EditorEntityContextNotificationBus overrides ...
- void OnStartPlayInEditor() override
- {
- m_editorViewportWidget.OnStartPlayInEditor();
- }
- void OnStopPlayInEditor() override
- {
- m_editorViewportWidget.OnStopPlayInEditor();
- }
- void OnStartPlayInEditorBegin() override
- {
- m_editorViewportWidget.OnStartPlayInEditorBegin();
- }
- private:
- EditorViewportWidget& m_editorViewportWidget;
- };
- } // namespace AZ::ViewportHelpers
- // helper to mark the view entity dirty that was moved using the 'Be this camera' functionality
- static void MarkCameraEntityDirty(const AZ::EntityId entityId)
- {
- using AzToolsFramework::ToolsApplicationRequests;
- AzToolsFramework::UndoSystem::URSequencePoint* undoBatch = nullptr;
- ToolsApplicationRequests::Bus::BroadcastResult(
- undoBatch, &ToolsApplicationRequests::Bus::Events::BeginUndoBatch, "EditorCameraComponentEntityChange");
- ToolsApplicationRequests::Bus::Broadcast(&ToolsApplicationRequests::Bus::Events::AddDirtyEntity, entityId);
- ToolsApplicationRequests::Bus::Broadcast(&ToolsApplicationRequests::Bus::Events::EndUndoBatch);
- }
- static void PopViewGroupForDefaultContext()
- {
- auto* atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
- if (!atomViewportRequests)
- {
- return;
- }
- auto viewSystem = AZ::RPI::ViewportContextRequests::Get();
- if (!viewSystem)
- {
- return;
- }
- if (auto viewGroup = viewSystem->GetCurrentViewGroup(viewSystem->GetDefaultViewportContextName()))
- {
- const AZ::Name contextName = atomViewportRequests->GetDefaultViewportContextName();
- atomViewportRequests->PopViewGroup(contextName, viewGroup);
- }
- }
- static void PushViewGroupForDefaultContext()
- {
- auto* atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
- if (!atomViewportRequests)
- {
- return;
- }
- auto viewSystem = AZ::RPI::ViewportContextRequests::Get();
- if (!viewSystem)
- {
- return;
- }
- if (auto viewGroup = viewSystem->GetCurrentViewGroup(viewSystem->GetDefaultViewportContextName()))
- {
- const AZ::Name contextName = atomViewportRequests->GetDefaultViewportContextName();
- atomViewportRequests->PushViewGroup(contextName, viewGroup);
- }
- }
- EditorViewportWidget::EditorViewportWidget(const QString& name, QWidget* parent)
- : QtViewport(parent)
- , m_defaultViewName(name)
- , m_renderViewport(nullptr) // m_renderViewport is initialized later, in SetViewportId
- {
- // need this to be set in order to allow for language switching on Windows
- setAttribute(Qt::WA_InputMethodEnabled);
- if (GetIEditor()->GetViewManager()->GetSelectedViewport() == nullptr)
- {
- GetIEditor()->GetViewManager()->SelectViewport(this);
- }
- GetIEditor()->RegisterNotifyListener(this);
- GetIEditor()->GetUndoManager()->AddListener(this);
- // The renderer requires something, so don't allow us to shrink to absolutely nothing
- // This won't in fact stop the viewport from being shrunk, when it's the centralWidget for
- // the MainWindow, but it will stop the viewport from getting resize events
- // once it's smaller than that, which from the renderer's perspective works out
- // to be the same thing.
- setMinimumSize(50, 50);
- setMouseTracking(true);
- Camera::EditorCameraRequestBus::Handler::BusConnect();
- Camera::CameraNotificationBus::Handler::BusConnect();
- m_editorEntityNotifications = AZStd::make_unique<AZ::ViewportHelpers::EditorEntityNotifications>(*this);
- AzFramework::AssetCatalogEventBus::Handler::BusConnect();
- AzToolsFramework::Prefab::PrefabPublicNotificationBus::Handler::BusConnect();
- m_manipulatorManager = GetIEditor()->GetViewManager()->GetManipulatorManager();
- if (!m_pPrimaryViewport)
- {
- SetAsActiveViewport();
- }
- }
- //////////////////////////////////////////////////////////////////////////
- EditorViewportWidget::~EditorViewportWidget()
- {
- if (m_pPrimaryViewport == this)
- {
- m_pPrimaryViewport = nullptr;
- }
- AzToolsFramework::Prefab::PrefabPublicNotificationBus::Handler::BusDisconnect();
- m_editorViewportSettings.Disconnect();
- DisconnectViewportInteractionRequestBus();
- m_editorEntityNotifications.reset();
- Camera::EditorCameraRequestBus::Handler::BusDisconnect();
- Camera::CameraNotificationBus::Handler::BusDisconnect();
- GetIEditor()->GetUndoManager()->RemoveListener(this);
- GetIEditor()->UnregisterNotifyListener(this);
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::resizeEvent(QResizeEvent* event)
- {
- // Call base class resize event while not rendering
- PushDisableRendering();
- QtViewport::resizeEvent(event);
- PopDisableRendering();
- // Emit Legacy system events about the viewport size change
- const QRect rcWindow = rect().translated(mapToGlobal(QPoint()));
- gEnv->pSystem->GetISystemEventDispatcher()->OnSystemEvent(ESYSTEM_EVENT_MOVE, rcWindow.left(), rcWindow.top());
- m_rcClient = rect();
- m_rcClient.setBottomRight(WidgetToViewport(m_rcClient.bottomRight()));
- gEnv->pSystem->GetISystemEventDispatcher()->OnSystemEvent(ESYSTEM_EVENT_RESIZE, width(), height());
- // In the case of the default viewport camera, we must re-set the FOV, which also updates the aspect ratio
- // Component cameras hand this themselves
- if (m_viewSourceType == ViewSourceType::None)
- {
- SetFOV(GetFOV());
- }
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::paintEvent([[maybe_unused]] QPaintEvent* event)
- {
- // Do not call CViewport::OnPaint() for painting messages
- // FIXME: paintEvent() isn't the best place for such logic. Should listen to proper eNotify events and to the stuff there instead.
- // (Repeats for other view port classes too).
- CGameEngine* ge = GetIEditor()->GetGameEngine();
- if ((ge && ge->IsLevelLoaded()) || (GetType() != ET_ViewportCamera))
- {
- setRenderOverlayVisible(true);
- }
- else
- {
- setRenderOverlayVisible(false);
- QPainter painter(this); // device context for painting
- // draw gradient background
- const QRect rc = rect();
- QLinearGradient gradient(rc.topLeft(), rc.bottomLeft());
- gradient.setColorAt(0, QColor(80, 80, 80));
- gradient.setColorAt(1, QColor(200, 200, 200));
- painter.fillRect(rc, gradient);
- // if we have some level loaded/loading/new
- // we draw a text
- if (!GetIEditor()->GetLevelFolder().isEmpty())
- {
- const int kFontSize = 200;
- const char* kFontName = "Arial";
- const QColor kTextColor(255, 255, 255);
- const QColor kTextShadowColor(0, 0, 0);
- const QFont font(kFontName, static_cast<int>(kFontSize / 10.0f));
- painter.setFont(font);
- QString friendlyName = QFileInfo(GetIEditor()->GetLevelName()).fileName();
- const QString strMsg = tr("Preparing level %1...").arg(friendlyName);
- // draw text shadow
- painter.setPen(kTextShadowColor);
- painter.drawText(rc, Qt::AlignCenter, strMsg);
- painter.setPen(kTextColor);
- // offset rect for normal text
- painter.drawText(rc.translated(-1, -1), Qt::AlignCenter, strMsg);
- }
- }
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::mousePressEvent(QMouseEvent* event)
- {
- GetIEditor()->GetViewManager()->SelectViewport(this);
- QtViewport::mousePressEvent(event);
- }
- AzToolsFramework::ViewportInteraction::MousePick EditorViewportWidget::BuildMousePick(const QPoint& point) const
- {
- AzToolsFramework::ViewportInteraction::MousePick mousePick;
- mousePick.m_screenCoordinates = AzToolsFramework::ViewportInteraction::ScreenPointFromQPoint(point * devicePixelRatioF());
- const auto [origin, direction] = m_renderViewport->ViewportScreenToWorldRay(mousePick.m_screenCoordinates);
- mousePick.m_rayOrigin = origin;
- mousePick.m_rayDirection = direction;
- return mousePick;
- }
- AzToolsFramework::ViewportInteraction::MouseInteraction EditorViewportWidget::BuildMouseInteractionInternal(
- const AzToolsFramework::ViewportInteraction::MouseButtons buttons,
- const AzToolsFramework::ViewportInteraction::KeyboardModifiers modifiers,
- const AzToolsFramework::ViewportInteraction::MousePick& mousePick) const
- {
- AzToolsFramework::ViewportInteraction::MouseInteraction mouse;
- mouse.m_interactionId.m_cameraId = m_viewEntityId;
- mouse.m_interactionId.m_viewportId = GetViewportId();
- mouse.m_mouseButtons = buttons;
- mouse.m_mousePick = mousePick;
- mouse.m_keyboardModifiers = modifiers;
- return mouse;
- }
- AzToolsFramework::ViewportInteraction::MouseInteraction EditorViewportWidget::BuildMouseInteraction(
- const Qt::MouseButtons buttons, const Qt::KeyboardModifiers modifiers, const QPoint& point)
- {
- namespace AztfVi = AzToolsFramework::ViewportInteraction;
- return BuildMouseInteractionInternal(
- AztfVi::BuildMouseButtons(buttons), AztfVi::BuildKeyboardModifiers(modifiers), BuildMousePick(WidgetToViewport(point)));
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::event(QEvent* event)
- {
- switch (event->type())
- {
- case QEvent::WindowActivate:
- GetIEditor()->GetViewManager()->SelectViewport(this);
- // also kill the keys; if we alt-tab back to the viewport, or come back from the debugger, it's done (and there's no guarantee we'll
- // get the keyrelease event anyways)
- m_keyDown.clear();
- break;
- case QEvent::Shortcut:
- // a shortcut should immediately clear us, otherwise the release event never gets sent
- m_keyDown.clear();
- break;
- }
- return QtViewport::event(event);
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::UpdateContent(int flags)
- {
- QtViewport::UpdateContent(flags);
- if (flags & eUpdateObjects)
- {
- m_bUpdateViewport = true;
- }
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::Update()
- {
- if (Editor::EditorQtApplication::instance()->isMovingOrResizing())
- {
- return;
- }
- if (m_rcClient.isEmpty())
- {
- return;
- }
- if (!isVisible())
- {
- return;
- }
- // Don't wait for changes to update the focused viewport.
- if (CheckRespondToInput())
- {
- m_bUpdateViewport = true;
- }
- // While Renderer doesn't support fast rendering of the scene to more then 1 viewport
- // render only focused viewport if more then 1 are opened and always update is off.
- if (!m_isOnPaint && m_viewManager->GetNumberOfGameViewports() > 1 && GetType() == ET_ViewportCamera)
- {
- if (m_pPrimaryViewport != this)
- {
- if (CheckRespondToInput()) // If this is the focused window, set primary viewport.
- {
- SetAsActiveViewport();
- }
- else if (!m_bUpdateViewport) // Skip this viewport.
- {
- return;
- }
- }
- }
- const bool isGameMode = GetIEditor()->IsInGameMode();
- const bool isSimulationMode = GetIEditor()->GetGameEngine()->GetSimulationMode();
- // Allow debug visualization in both 'game' (Ctrl-G) and 'simulation' (Ctrl-P) modes
- if (isGameMode || isSimulationMode)
- {
- if (!IsRenderingDisabled())
- {
- // Disable rendering to avoid recursion into Update()
- PushDisableRendering();
- // get debug display interface for the viewport
- AzFramework::DebugDisplayRequestBus::BusPtr debugDisplayBus;
- AzFramework::DebugDisplayRequestBus::Bind(debugDisplayBus, GetViewportId());
- AZ_Assert(debugDisplayBus, "Invalid DebugDisplayRequestBus.");
- AzFramework::DebugDisplayRequests* debugDisplay = AzFramework::DebugDisplayRequestBus::FindFirstHandler(debugDisplayBus);
- // draw debug visualizations
- if (debugDisplay)
- {
- const AZ::u32 prevState = debugDisplay->GetState();
- debugDisplay->SetState(AzFramework::e_Mode3D | AzFramework::e_AlphaBlended | AzFramework::e_FillModeSolid | AzFramework::e_CullModeBack | AzFramework::e_DepthWriteOn | AzFramework::e_DepthTestOn);
- AzFramework::EntityDebugDisplayEventBus::Broadcast(
- &AzFramework::EntityDebugDisplayEvents::DisplayEntityViewport, AzFramework::ViewportInfo{ GetViewportId() },
- *debugDisplay);
- debugDisplay->SetState(prevState);
- }
- QtViewport::Update();
- PopDisableRendering();
- }
- // Game mode rendering is handled by CryAction
- if (isGameMode)
- {
- return;
- }
- }
- if (m_playInEditorState == PlayInEditorState::Stopping)
- {
- m_playInEditorState = PlayInEditorState::Editor;
- // Note that:
- // - this is assuming that the Atom camera components will share the same view ptr in editor as in game mode.
- // - if `m_viewEntityIdCachedForEditMode' is invalid, the camera before game mode was the default editor camera
- // - we must set the camera again when exiting game mode, because when rendering with track view, the editor camera gets set again
- SetViewFromEntityPerspective(m_viewEntityIdCachedForEditMode);
- m_viewEntityIdCachedForEditMode.SetInvalid();
- }
- // Prevents rendering recursion due to recursive Paint messages.
- if (IsRenderingDisabled())
- {
- return;
- }
- PushDisableRendering();
- // Render
- {
- // Post Render Callback
- {
- PostRenderers::iterator itr = m_postRenderers.begin();
- PostRenderers::iterator end = m_postRenderers.end();
- for (; itr != end; ++itr)
- {
- (*itr)->OnPostRender();
- }
- }
- }
- if(!m_hasUpdatedVisibility)
- {
- auto start = std::chrono::steady_clock::now();
- m_entityVisibilityQuery.UpdateVisibility(m_renderViewport->GetCameraState());
- if (ed_visibility_logTiming)
- {
- auto stop = std::chrono::steady_clock::now();
- std::chrono::duration<double> diff = stop - start;
- AZ_Printf("Visibility", "FindVisibleEntities (new) - Duration: %f", diff);
- }
- m_hasUpdatedVisibility = true;
- }
- QtViewport::Update();
- PopDisableRendering();
- m_bUpdateViewport = false;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::PostCameraSet()
- {
- // CryLegacy notify
- GetIEditor()->Notify(eNotify_CameraChanged);
- // Special case in the editor; if the camera is the default editor camera,
- // notify that the active view changed. In game mode, it is a hard error to not have
- // any cameras on the view stack!
- if (m_viewSourceType == ViewSourceType::None)
- {
- m_sendingOnActiveChanged = true;
- Camera::CameraNotificationBus::Broadcast(&Camera::CameraNotificationBus::Events::OnActiveViewChanged, AZ::EntityId());
- m_sendingOnActiveChanged = false;
- }
- // Notify about editor camera change
- Camera::EditorCameraNotificationBus::Broadcast(
- &Camera::EditorCameraNotificationBus::Events::OnViewportViewEntityChanged, m_viewEntityId);
- // The editor view entity ID has changed, and the editor camera component "Be This Camera" text needs to be updated
- AzToolsFramework::PropertyEditorGUIMessages::Bus::Broadcast(
- &AzToolsFramework::PropertyEditorGUIMessages::RequestRefresh,
- AzToolsFramework::PropertyModificationRefreshLevel::Refresh_AttributesAndValues);
- }
- //////////////////////////////////////////////////////////////////////////
- CBaseObject* EditorViewportWidget::GetCameraObject() const
- {
- CBaseObject* pCameraObject = nullptr;
- if (m_viewSourceType == ViewSourceType::CameraComponent)
- {
- AzToolsFramework::ComponentEntityEditorRequestBus::EventResult(
- pCameraObject, m_viewEntityId, &AzToolsFramework::ComponentEntityEditorRequests::GetSandboxObject);
- }
- return pCameraObject;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::OnEditorNotifyEvent(EEditorNotifyEvent event)
- {
- switch (event)
- {
- case eNotify_OnBeginGameMode:
- {
- if (GetIEditor()->GetViewManager()->GetGameViewport() == this)
- {
- if (m_viewEntityId.IsValid())
- {
- MarkCameraEntityDirty(m_viewEntityId);
- }
- m_preGameModeViewTM = GetViewTM();
- // this should only occur for the main viewport and no others.
- ShowCursor();
- SetCurrentCursor(STD_CURSOR_GAME);
- if (ShouldPreviewFullscreen())
- {
- StartFullscreenPreview();
- }
- }
- if (m_renderViewport)
- {
- m_renderViewport->SetInputProcessingEnabled(false);
- }
- }
- break;
- case eNotify_OnEndGameMode:
- if (GetIEditor()->GetViewManager()->GetGameViewport() == this)
- {
- SetCurrentCursor(STD_CURSOR_DEFAULT);
- if (m_inFullscreenPreview)
- {
- StopFullscreenPreview();
- }
- RestoreViewportAfterGameMode();
- }
- if (m_renderViewport)
- {
- m_renderViewport->SetInputProcessingEnabled(true);
- }
- break;
- case eNotify_OnCloseScene:
- // we restore the default viewport camera when closing the level to ensure if there is a pushed view group for a particular
- // editor camera component (view entity) it is popped/cleared to return to a default state when opening the next level
- SetDefaultCamera();
- m_renderViewport->SetScene(nullptr);
- break;
- case eNotify_OnEndLoad:
- case eNotify_OnEndCreate:
- UpdateScene();
- break;
- case eNotify_OnBeginNewScene:
- PushDisableRendering();
- break;
- case eNotify_OnEndNewScene:
- PopDisableRendering();
- UpdateScene();
- break;
- case eNotify_OnBeginLayerExport:
- case eNotify_OnBeginSceneSave:
- PushDisableRendering();
- break;
- case eNotify_OnEndLayerExport:
- case eNotify_OnEndSceneSave:
- PopDisableRendering();
- break;
- }
- }
- void EditorViewportWidget::OnBeginPrepareRender()
- {
- AZ_PROFILE_FUNCTION(Editor);
- m_hasUpdatedVisibility = false;
- if (!m_debugDisplay)
- {
- AzFramework::DebugDisplayRequestBus::BusPtr debugDisplayBus;
- AzFramework::DebugDisplayRequestBus::Bind(debugDisplayBus, GetViewportId());
- AZ_Assert(debugDisplayBus, "Invalid DebugDisplayRequestBus.");
- m_debugDisplay = AzFramework::DebugDisplayRequestBus::FindFirstHandler(debugDisplayBus);
- }
- if (!m_debugDisplay)
- {
- return;
- }
- m_isOnPaint = true;
- Update();
- m_isOnPaint = false;
- if (GetIEditor()->IsInGameMode())
- {
- return;
- }
- RenderAll();
- // Draw 2D helpers.
- m_debugDisplay->DepthTestOff();
- auto prevState = m_debugDisplay->GetState();
- m_debugDisplay->SetState(AzFramework::e_Mode3D | AzFramework::e_AlphaBlended | AzFramework::e_FillModeSolid | AzFramework::e_CullModeBack | AzFramework::e_DepthWriteOn | AzFramework::e_DepthTestOn);
- AzFramework::ViewportDebugDisplayEventBus::Event(
- AzToolsFramework::GetEntityContextId(), &AzFramework::ViewportDebugDisplayEvents::DisplayViewport2d,
- AzFramework::ViewportInfo{ GetViewportId() }, *m_debugDisplay);
- m_debugDisplay->SetState(prevState);
- m_debugDisplay->DepthTestOn();
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::RenderAll()
- {
- if (!m_debugDisplay)
- {
- return;
- }
- // allow the override of in-editor visualization
- AzFramework::ViewportDebugDisplayEventBus::Event(
- AzToolsFramework::GetEntityContextId(), &AzFramework::ViewportDebugDisplayEvents::DisplayViewport,
- AzFramework::ViewportInfo{ GetViewportId() }, *m_debugDisplay);
- m_entityVisibilityQuery.DisplayVisibility(*m_debugDisplay);
- if (m_manipulatorManager != nullptr)
- {
- namespace AztfVi = AzToolsFramework::ViewportInteraction;
- AztfVi::KeyboardModifiers keyboardModifiers;
- AztfVi::EditorModifierKeyRequestBus::BroadcastResult(
- keyboardModifiers, &AztfVi::EditorModifierKeyRequestBus::Events::QueryKeyboardModifiers);
- m_debugDisplay->DepthTestOff();
- m_manipulatorManager->DrawManipulators(
- *m_debugDisplay, m_renderViewport->GetCameraState(),
- BuildMouseInteractionInternal(
- AztfVi::MouseButtons(AztfVi::TranslateMouseButtons(QGuiApplication::mouseButtons())), keyboardModifiers,
- BuildMousePick(WidgetToViewport(mapFromGlobal(QCursor::pos())))));
- m_debugDisplay->DepthTestOn();
- }
- }
- //////////////////////////////////////////////////////////////////////////
- float EditorViewportWidget::GetAspectRatio() const
- {
- return gSettings.viewports.fDefaultAspectRatio;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::OnMenuCreateCameraEntityFromCurrentView()
- {
- Camera::EditorCameraSystemRequestBus::Broadcast(&Camera::EditorCameraSystemRequests::CreateCameraEntityFromViewport);
- }
- void EditorViewportWidget::FindVisibleEntities(AZStd::vector<AZ::EntityId>& visibleEntitiesOut)
- {
- visibleEntitiesOut.assign(m_entityVisibilityQuery.Begin(), m_entityVisibilityQuery.End());
- }
- QWidget* EditorViewportWidget::GetWidgetForViewportContextMenu()
- {
- return this;
- }
- bool EditorViewportWidget::ShowingWorldSpace()
- {
- namespace AztfVi = AzToolsFramework::ViewportInteraction;
- AztfVi::KeyboardModifiers keyboardModifiers;
- AztfVi::EditorModifierKeyRequestBus::BroadcastResult(
- keyboardModifiers, &AztfVi::EditorModifierKeyRequestBus::Events::QueryKeyboardModifiers);
- return keyboardModifiers.Shift();
- }
- void EditorViewportWidget::SetViewportId(int id)
- {
- CViewport::SetViewportId(id);
- // Clear the cached DebugDisplay pointer. we're about to delete that render viewport, and deleting the render
- // viewport invalidates the DebugDisplay.
- m_debugDisplay = nullptr;
- // First delete any existing layout
- // This also deletes any existing render viewport widget (since it will be added to the layout)
- // Below is the typical method of clearing a QLayout, see e.g. https://doc.qt.io/qt-5/qlayout.html#takeAt
- if (QLayout* thisLayout = layout())
- {
- QLayoutItem* item;
- while ((item = thisLayout->takeAt(0)) != nullptr)
- {
- if (QWidget* widget = item->widget())
- {
- delete widget;
- }
- thisLayout->removeItem(item);
- delete item;
- }
- delete thisLayout;
- }
- // Now that we have an ID, we can initialize our viewport.
- m_renderViewport = new AtomToolsFramework::RenderViewportWidget(this, false);
- if (!m_renderViewport->InitializeViewportContext(id))
- {
- AZ_Warning("EditorViewportWidget", false, "Failed to initialize RenderViewportWidget's ViewportContext");
- delete m_renderViewport;
- m_renderViewport = nullptr;
- return;
- }
- QBoxLayout* layout = new QBoxLayout(QBoxLayout::Direction::TopToBottom, this);
- layout->setContentsMargins(QMargins());
- layout->addWidget(m_renderViewport);
- UpdateScene();
- if (m_pPrimaryViewport == this)
- {
- SetAsActiveViewport();
- }
- m_renderViewport->GetControllerList()->Add(AZStd::make_shared<SandboxEditor::ViewportManipulatorController>());
- m_editorModularViewportCameraComposer =
- AZStd::make_unique<SandboxEditor::EditorModularViewportCameraComposer>(AzFramework::ViewportId(id));
- m_renderViewport->GetControllerList()->Add(m_editorModularViewportCameraComposer->CreateModularViewportCameraController());
- m_editorViewportSettings.Connect(AzFramework::ViewportId(id));
- m_editorViewportSettingsCallbacks = SandboxEditor::CreateEditorViewportSettingsCallbacks();
- m_gridShowingHandler = SandboxEditor::GridShowingChangedEvent::Handler(
- [id](const bool showing)
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Event(
- id, &AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Events::OnGridShowingChanged, showing);
- });
- m_editorViewportSettingsCallbacks->SetGridShowingChangedEvent(m_gridShowingHandler);
- m_gridSnappingHandler = SandboxEditor::GridSnappingChangedEvent::Handler(
- [id](const bool snapping)
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Event(
- id, &AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Events::OnGridSnappingChanged, snapping);
- });
- m_editorViewportSettingsCallbacks->SetGridSnappingChangedEvent(m_gridSnappingHandler);
- m_angleSnappingHandler = SandboxEditor::AngleSnappingChangedEvent::Handler(
- [id](const bool snapping)
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Event(
- id, &AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Events::OnAngleSnappingChanged, snapping);
- });
- m_editorViewportSettingsCallbacks->SetAngleSnappingChangedEvent(m_angleSnappingHandler);
- m_cameraSpeedScaleHandler = SandboxEditor::CameraSpeedScaleChangedEvent::Handler(
- [id](const float scale)
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Event(
- id, &AzToolsFramework::ViewportInteraction::ViewportSettingsNotificationBus::Events::OnCameraSpeedScaleChanged, scale);
- });
- m_editorViewportSettingsCallbacks->SetCameraSpeedScaleChangedEvent(m_cameraSpeedScaleHandler);
- m_perspectiveChangeHandler = SandboxEditor::PerspectiveChangedEvent::Handler(
- [this](const float fovRadians)
- {
- if (m_viewSourceType == ViewSourceType::None)
- {
- if (m_viewPane)
- {
- m_viewPane->OnFOVChanged(fovRadians);
- }
- SetFOV(fovRadians);
- }
- });
- m_editorViewportSettingsCallbacks->SetPerspectiveChangedEvent(m_perspectiveChangeHandler);
- m_nearPlaneDistanceHandler = SandboxEditor::NearFarPlaneChangedEvent::Handler(
- [this]([[maybe_unused]] float nearPlaneDistance)
- {
- OnDefaultCameraNearFarChanged();
- });
- m_editorViewportSettingsCallbacks->SetNearPlaneDistanceChangedEvent(m_nearPlaneDistanceHandler);
- m_farPlaneDistanceHandler = SandboxEditor::NearFarPlaneChangedEvent::Handler(
- [this]([[maybe_unused]] float farPlaneDistance)
- {
- OnDefaultCameraNearFarChanged();
- });
- m_editorViewportSettingsCallbacks->SetFarPlaneDistanceChangedEvent(m_farPlaneDistanceHandler);
- }
- void EditorViewportWidget::ConnectViewportInteractionRequestBus()
- {
- AzToolsFramework::ViewportInteraction::MainEditorViewportInteractionRequestBus::Handler::BusConnect(GetViewportId());
- AzToolsFramework::ViewportInteraction::EditorEntityViewportInteractionRequestBus::Handler::BusConnect(GetViewportId());
- m_viewportUi.ConnectViewportUiBus(GetViewportId());
- AzFramework::ViewportBorderRequestBus::Handler::BusConnect(GetViewportId());
- AzFramework::InputSystemCursorConstraintRequestBus::Handler::BusConnect();
- }
- void EditorViewportWidget::DisconnectViewportInteractionRequestBus()
- {
- AzFramework::InputSystemCursorConstraintRequestBus::Handler::BusDisconnect();
- AzFramework::ViewportBorderRequestBus::Handler::BusDisconnect();
- m_viewportUi.DisconnectViewportUiBus();
- AzToolsFramework::ViewportInteraction::EditorEntityViewportInteractionRequestBus::Handler::BusDisconnect();
- AzToolsFramework::ViewportInteraction::MainEditorViewportInteractionRequestBus::Handler::BusDisconnect();
- }
- namespace AZ::ViewportHelpers
- {
- void ToggleBool(bool* variable, bool* disableVariableIfOn)
- {
- *variable = !*variable;
- if (*variable && disableVariableIfOn)
- {
- *disableVariableIfOn = false;
- }
- }
- void ToggleInt(int* variable)
- {
- *variable = !*variable;
- }
- void AddCheckbox(QMenu* menu, const QString& text, bool* variable, bool* disableVariableIfOn = nullptr)
- {
- QAction* action = menu->addAction(text);
- QObject::connect(
- action, &QAction::triggered, action,
- [variable, disableVariableIfOn]
- {
- ToggleBool(variable, disableVariableIfOn);
- });
- action->setCheckable(true);
- action->setChecked(*variable);
- }
- void AddCheckbox(QMenu* menu, const QString& text, int* variable)
- {
- QAction* action = menu->addAction(text);
- QObject::connect(
- action, &QAction::triggered, action,
- [variable]
- {
- ToggleInt(variable);
- });
- action->setCheckable(true);
- action->setChecked(*variable);
- }
- } // namespace AZ::ViewportHelpers
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::OnTitleMenu(QMenu* menu)
- {
- const bool bDisplayLabels = GetIEditor()->GetDisplaySettings()->IsDisplayLabels();
- QAction* action = menu->addAction(tr("Labels"));
- connect(
- action, &QAction::triggered, this,
- [bDisplayLabels]
- {
- GetIEditor()->GetDisplaySettings()->DisplayLabels(!bDisplayLabels);
- });
- action->setCheckable(true);
- action->setChecked(bDisplayLabels);
- AZ::ViewportHelpers::AddCheckbox(menu, tr("Show Construction Plane"), &gSettings.snap.constructPlaneDisplay);
- AZ::ViewportHelpers::AddCheckbox(menu, tr("Show Trigger Bounds"), &gSettings.viewports.bShowTriggerBounds);
- AZ::ViewportHelpers::AddCheckbox(menu, tr("Show Helpers of Frozen Objects"), &gSettings.viewports.nShowFrozenHelpers);
- if (!m_predefinedAspectRatios.IsEmpty())
- {
- QMenu* aspectRatiosMenu = menu->addMenu(tr("Target Aspect Ratio"));
- for (size_t i = 0; i < m_predefinedAspectRatios.GetCount(); ++i)
- {
- const QString& aspectRatioString = m_predefinedAspectRatios.GetName(i);
- QAction* aspectRatioAction = aspectRatiosMenu->addAction(aspectRatioString);
- connect(
- aspectRatioAction, &QAction::triggered, this,
- [i, this]
- {
- const float aspect = m_predefinedAspectRatios.GetValue(i);
- gSettings.viewports.fDefaultAspectRatio = aspect;
- });
- aspectRatioAction->setCheckable(true);
- aspectRatioAction->setChecked(m_predefinedAspectRatios.IsCurrent(i));
- }
- }
- // Set ourself as the active viewport so the following actions create a camera from this view
- GetIEditor()->GetViewManager()->SelectViewport(this);
- CGameEngine* gameEngine = GetIEditor()->GetGameEngine();
- if (Camera::EditorCameraSystemRequestBus::HasHandlers())
- {
- action = menu->addAction(tr("Create camera entity from current view"));
- connect(action, &QAction::triggered, this, &EditorViewportWidget::OnMenuCreateCameraEntityFromCurrentView);
- const auto prefabEditorEntityOwnershipInterface = AZ::Interface<AzToolsFramework::PrefabEditorEntityOwnershipInterface>::Get();
- if (!gameEngine || !gameEngine->IsLevelLoaded() ||
- (prefabEditorEntityOwnershipInterface && !prefabEditorEntityOwnershipInterface->IsRootPrefabAssigned()))
- {
- action->setEnabled(false);
- action->setToolTip(tr(AZ::ViewportHelpers::TextCantCreateCameraNoLevel));
- menu->setToolTipsVisible(true);
- }
- }
- if (!gameEngine || !gameEngine->IsLevelLoaded())
- {
- action->setEnabled(false);
- action->setToolTip(tr(AZ::ViewportHelpers::TextCantCreateCameraNoLevel));
- menu->setToolTipsVisible(true);
- }
- // Add Cameras.
- bool bHasCameras = AddCameraMenuItems(menu);
- EditorViewportWidget* pFloatingViewport = nullptr;
- if (GetIEditor()->GetViewManager()->GetViewCount() > 1)
- {
- for (int i = 0; i < GetIEditor()->GetViewManager()->GetViewCount(); ++i)
- {
- CViewport* vp = GetIEditor()->GetViewManager()->GetView(i);
- if (!vp)
- {
- continue;
- }
- if (viewport_cast<EditorViewportWidget*>(vp) == nullptr)
- {
- continue;
- }
- if (vp->GetViewportId() == MAX_NUM_VIEWPORTS - 1)
- {
- menu->addSeparator();
- QMenu* floatViewMenu = menu->addMenu(tr("Floating View"));
- pFloatingViewport = (EditorViewportWidget*)vp;
- pFloatingViewport->AddCameraMenuItems(floatViewMenu);
- if (bHasCameras)
- {
- floatViewMenu->addSeparator();
- }
- }
- }
- }
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::AddCameraMenuItems(QMenu* menu)
- {
- if (!menu->isEmpty())
- {
- menu->addSeparator();
- }
- menu->addSeparator();
- // Camera Sub menu
- QMenu* customCameraMenu = menu->addMenu(tr("Camera"));
- QAction* action = customCameraMenu->addAction("Editor Camera");
- action->setCheckable(true);
- action->setChecked(m_viewSourceType == ViewSourceType::None);
- connect(action, &QAction::triggered, this, &EditorViewportWidget::SetDefaultCamera);
- AZ::EBusAggregateResults<AZ::EntityId> getCameraResults;
- Camera::CameraBus::BroadcastResult(getCameraResults, &Camera::CameraRequests::GetCameras);
- QVector<QAction*> additionalCameras;
- additionalCameras.reserve(static_cast<int>(getCameraResults.values.size()));
- for (const AZ::EntityId& entityId : getCameraResults.values)
- {
- AZStd::string entityName;
- AZ::ComponentApplicationBus::BroadcastResult(entityName, &AZ::ComponentApplicationRequests::GetEntityName, entityId);
- action = new QAction(QString(entityName.c_str()), nullptr);
- additionalCameras.append(action);
- action->setCheckable(true);
- action->setChecked(m_viewEntityId == entityId && m_viewSourceType == ViewSourceType::CameraComponent);
- connect(
- action, &QAction::triggered, this,
- [this, entityId](bool isChecked)
- {
- if (isChecked)
- {
- SetEntityAsCamera(entityId);
- }
- else
- {
- SetDefaultCamera();
- }
- });
- }
- std::sort(
- additionalCameras.begin(), additionalCameras.end(),
- [](QAction* a1, QAction* a2)
- {
- return QString::compare(a1->text(), a2->text(), Qt::CaseInsensitive) < 0;
- });
- for (QAction* cameraAction : additionalCameras)
- {
- customCameraMenu->addAction(cameraAction);
- }
- return true;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::ResizeView(int width, int height)
- {
- const QRect rView = rect().translated(mapToGlobal(QPoint()));
- int deltaWidth = width - rView.width();
- int deltaHeight = height - rView.height();
- if (window()->isFullScreen())
- {
- setGeometry(rView.left(), rView.top(), rView.width() + deltaWidth, rView.height() + deltaHeight);
- }
- else
- {
- QWidget* window = this->window();
- if (window->isMaximized())
- {
- window->showNormal();
- }
- const QSize deltaSize = QSize(width, height) - size();
- window->move(0, 0);
- window->resize(window->size() + deltaSize);
- }
- }
- //////////////////////////////////////////////////////////////////////////
- EditorViewportWidget* EditorViewportWidget::GetPrimaryViewport()
- {
- return m_pPrimaryViewport;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::focusOutEvent([[maybe_unused]] QFocusEvent* event)
- {
- // if we lose focus, the keyboard map needs to be cleared immediately
- if (!m_keyDown.isEmpty())
- {
- m_keyDown.clear();
- releaseKeyboard();
- }
- }
- void EditorViewportWidget::keyPressEvent(QKeyEvent* event)
- {
- // NOTE: we keep track of key presses and releases explicitly because the OS/Qt will insert a slight delay between sending
- // key events when the key is held down. This is standard, but makes responding to key events for game style input silly
- // because we want the movement to be butter smooth.
- if (!event->isAutoRepeat())
- {
- m_keyDown.insert(event->key());
- }
- QtViewport::keyPressEvent(event);
- #if defined(AZ_PLATFORM_WINDOWS)
- // In game mode on windows we need to forward raw text events to the input system.
- if (GetIEditor()->IsInGameMode() && GetType() == ET_ViewportCamera)
- {
- // Get the QString as a '\0'-terminated array of unsigned shorts.
- // The result remains valid until the string is modified.
- const ushort* codeUnitsUTF16 = event->text().utf16();
- while (ushort codeUnitUTF16 = *codeUnitsUTF16)
- {
- AzFramework::RawInputNotificationBusWindows::Broadcast(
- &AzFramework::RawInputNotificationsWindows::OnRawInputCodeUnitUTF16Event, codeUnitUTF16);
- ++codeUnitsUTF16;
- }
- }
- #endif // defined(AZ_PLATFORM_WINDOWS)
- }
- void EditorViewportWidget::SetViewTM(const Matrix34& tm)
- {
- SetViewTM(tm, false);
- }
- void EditorViewportWidget::SetViewTM(const Matrix34& camMatrix, bool bMoveOnly)
- {
- AZ_Warning("EditorViewportWidget", !bMoveOnly, "'Move Only' mode is deprecated");
- CBaseObject* cameraObject = GetCameraObject();
- // Check if the active view entity is the same as the entity having the current view
- // Sometimes this isn't the case because the active view is in the process of changing
- // If it isn't, then we're doing the wrong thing below: we end up copying data from one (seemingly random)
- // camera to another (seemingly random) camera
- enum class ShouldUpdateObject
- {
- Yes,
- No,
- YesButViewsOutOfSync
- };
- const ShouldUpdateObject shouldUpdateObject = [&]()
- {
- if (!cameraObject)
- {
- return ShouldUpdateObject::No;
- }
- if (m_viewSourceType == ViewSourceType::CameraComponent)
- {
- if (!m_viewEntityId.IsValid())
- {
- // Should be impossible anyways
- AZ_Assert(false, "Internal logic error - view entity Id and view source type out of sync. Please report this as a bug");
- return ShouldUpdateObject::No;
- }
- // Check that the current view is the same view as the view entity view
- AZ::RPI::ViewPtr viewEntityView;
- AZ::RPI::ViewProviderBus::EventResult(viewEntityView, m_viewEntityId, &AZ::RPI::ViewProviderBus::Events::GetView);
- return viewEntityView == GetCurrentAtomView() ? ShouldUpdateObject::Yes : ShouldUpdateObject::YesButViewsOutOfSync;
- }
- else
- {
- AZ_Assert(
- false,
- "Internal logic error - view source type is the default camera, but there is somehow a camera object. Please report this "
- "as a bug.");
- // For non-component cameras, can't do any complicated view-based checks
- return ShouldUpdateObject::No;
- }
- }();
- if (shouldUpdateObject == ShouldUpdateObject::Yes)
- {
- int flags = 0;
- {
- // It isn't clear what this logic is supposed to do (it's legacy code)...
- // For now, instead of removing it, just assert if the m_pressedKeyState isn't as expected
- // Do not touch unless you really know what you're doing!
- AZ_Assert(
- m_pressedKeyState == KeyPressedState::AllUp,
- "Internal logic error - key pressed state got changed. Please report this as a bug");
- AZStd::optional<CUndo> undo;
- if (m_pressedKeyState != KeyPressedState::PressedInPreviousFrame)
- {
- flags = eObjectUpdateFlags_UserInput;
- undo.emplace("Move Camera");
- }
- if (bMoveOnly)
- {
- cameraObject->SetWorldPos(camMatrix.GetTranslation(), flags);
- }
- else
- {
- cameraObject->SetWorldTM(camMatrix, flags);
- }
- }
- }
- else if (shouldUpdateObject == ShouldUpdateObject::YesButViewsOutOfSync)
- {
- // Technically this should not cause anything to go wrong, but may indicate some underlying bug by a caller
- // of SetViewTm, for example, trying to set the view TM in the middle of a camera change.
- // If this is an important case, it can potentially be supported by caching the requested view TM
- // until the entity and view ptr become synchronized.
- AZ_Error(
- "EditorViewportWidget", m_playInEditorState == PlayInEditorState::Editor,
- "Viewport camera entity ID and view out of sync; request view transform will be ignored. "
- "Please report this as a bug.");
- }
- else if (shouldUpdateObject == ShouldUpdateObject::No)
- {
- GetCurrentAtomView()->SetCameraTransform(LYTransformToAZMatrix3x4(camMatrix));
- }
- if (m_pressedKeyState == KeyPressedState::PressedThisFrame)
- {
- m_pressedKeyState = KeyPressedState::PressedInPreviousFrame;
- }
- }
- const Matrix34& EditorViewportWidget::GetViewTM() const
- {
- // `m_viewTmStorage' is only required because we must return a reference
- m_viewTmStorage = AZTransformToLYTransform(GetCurrentAtomView()->GetCameraTransform());
- return m_viewTmStorage;
- };
- AZ::EntityId EditorViewportWidget::GetCurrentViewEntityId()
- {
- // Sanity check that this camera entity ID is actually the camera entity which owns the current active render view
- if (m_viewSourceType == ViewSourceType::CameraComponent)
- {
- // Check that the current view is the same view as the view entity view
- AZ::RPI::ViewPtr viewEntityView;
- AZ::RPI::ViewProviderBus::EventResult(viewEntityView, m_viewEntityId, &AZ::RPI::ViewProviderBus::Events::GetView);
- [[maybe_unused]] const bool isViewEntityCorrect = viewEntityView == GetCurrentAtomView();
- AZ_Error(
- "EditorViewportWidget", isViewEntityCorrect,
- "GetCurrentViewEntityId called while the current view is being changed. "
- "You may get inconsistent results if you make use of the returned entity ID. "
- "This is an internal error, please report it as a bug.");
- }
- return m_viewEntityId;
- }
- Vec3 EditorViewportWidget::WorldToView3D(const Vec3& wp, [[maybe_unused]] int nFlags) const
- {
- Vec3 out(0, 0, 0);
- float x, y;
- ProjectToScreen(wp.x, wp.y, wp.z, &x, &y);
- if (_finite(x) && _finite(y))
- {
- out.x = (x / 100) * m_rcClient.width();
- out.y = (y / 100) * m_rcClient.height();
- out.x /= static_cast<float>(QHighDpiScaling::factor(windowHandle()->screen()));
- out.y /= static_cast<float>(QHighDpiScaling::factor(windowHandle()->screen()));
- }
- return out;
- }
- //////////////////////////////////////////////////////////////////////////
- QPoint EditorViewportWidget::WorldToView(const Vec3& wp) const
- {
- return AzToolsFramework::ViewportInteraction::QPointFromScreenPoint(m_renderViewport->ViewportWorldToScreen(LYVec3ToAZVec3(wp)));
- }
- //////////////////////////////////////////////////////////////////////////
- Vec3 EditorViewportWidget::ViewToWorld(
- const QPoint& vp, bool* collideWithTerrain, bool onlyTerrain, bool bSkipVegetation, bool bTestRenderMesh, bool* collideWithObject) const
- {
- AZ_PROFILE_FUNCTION(Editor);
- AZ_UNUSED(collideWithTerrain);
- AZ_UNUSED(onlyTerrain);
- AZ_UNUSED(bTestRenderMesh);
- AZ_UNUSED(bSkipVegetation);
- AZ_UNUSED(bSkipVegetation);
- AZ_UNUSED(collideWithObject);
- auto ray =
- m_renderViewport->ViewportScreenToWorldRay(AzToolsFramework::ViewportInteraction::ScreenPointFromQPoint(vp * devicePixelRatioF()));
- const float maxDistance = 10000.f;
- Vec3 v = AZVec3ToLYVec3(ray.m_direction) * maxDistance;
- if (!_finite(v.x) || !_finite(v.y) || !_finite(v.z))
- {
- return Vec3(0, 0, 0);
- }
- Vec3 colp = AZVec3ToLYVec3(ray.m_origin) + 0.002f * v;
- return colp;
- }
- //////////////////////////////////////////////////////////////////////////
- Vec3 EditorViewportWidget::ViewToWorldNormal(const QPoint& vp, bool onlyTerrain, bool bTestRenderMesh)
- {
- AZ_UNUSED(vp);
- AZ_UNUSED(onlyTerrain);
- AZ_UNUSED(bTestRenderMesh);
- AZ_PROFILE_FUNCTION(Editor);
- return Vec3(0, 0, 1);
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::RayRenderMeshIntersection(
- IRenderMesh* pRenderMesh, const Vec3& vInPos, const Vec3& vInDir, Vec3& vOutPos, Vec3& vOutNormal) const
- {
- AZ_UNUSED(pRenderMesh);
- AZ_UNUSED(vInPos);
- AZ_UNUSED(vInDir);
- AZ_UNUSED(vOutPos);
- AZ_UNUSED(vOutNormal);
- return false;
- /*SRayHitInfo hitInfo;
- hitInfo.bUseCache = false;
- hitInfo.bInFirstHit = false;
- hitInfo.inRay.origin = vInPos;
- hitInfo.inRay.direction = vInDir.GetNormalized();
- hitInfo.inReferencePoint = vInPos;
- hitInfo.fMaxHitDistance = 0;
- bool bRes = ???->RenderMeshRayIntersection(pRenderMesh, hitInfo, nullptr);
- vOutPos = hitInfo.vHitPos;
- vOutNormal = hitInfo.vHitNormal;
- return bRes;*/
- }
- void EditorViewportWidget::UnProjectFromScreen(float sx, float sy, float* px, float* py, float* pz) const
- {
- const AZ::Vector3 wp = m_renderViewport->ViewportScreenToWorld(AzFramework::ScreenPoint{ (int)sx, m_rcClient.bottom() - ((int)sy) });
- *px = wp.GetX();
- *py = wp.GetY();
- *pz = wp.GetZ();
- }
- void EditorViewportWidget::ProjectToScreen(float ptx, float pty, float ptz, float* sx, float* sy) const
- {
- AzFramework::ScreenPoint screenPosition = m_renderViewport->ViewportWorldToScreen(AZ::Vector3{ ptx, pty, ptz });
- *sx = static_cast<float>(screenPosition.m_x);
- *sy = static_cast<float>(screenPosition.m_y);
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::ViewToWorldRay(const QPoint& vp, Vec3& raySrc, Vec3& rayDir) const
- {
- QRect rc = m_rcClient;
- Vec3 pos0, pos1;
- float wx, wy, wz;
- UnProjectFromScreen(static_cast<float>(vp.x()), static_cast<float>(rc.bottom() - vp.y()), &wx, &wy, &wz);
- if (!_finite(wx) || !_finite(wy) || !_finite(wz))
- {
- return;
- }
- if (fabs(wx) > 1000000 || fabs(wy) > 1000000 || fabs(wz) > 1000000)
- {
- return;
- }
- pos0(wx, wy, wz);
- raySrc = pos0;
- rayDir = (pos0 - AZVec3ToLYVec3(m_renderViewport->GetCameraState().m_position)).GetNormalized();
- }
- //////////////////////////////////////////////////////////////////////////
- float EditorViewportWidget::GetScreenScaleFactor([[maybe_unused]] const Vec3& worldPoint) const
- {
- AZ_Error("CryLegacy", false, "EditorViewportWidget::GetScreenScaleFactor not implemented");
- return 1.f;
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::CheckRespondToInput() const
- {
- if (!Editor::EditorQtApplication::IsActive())
- {
- return false;
- }
- if (!hasFocus() && !m_renderViewport->hasFocus())
- {
- return false;
- }
- return true;
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::HitTest(const QPoint& point, HitContext& hitInfo)
- {
- hitInfo.pExcludedObject = GetCameraObject();
- return QtViewport::HitTest(point, hitInfo);
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::IsBoundsVisible(const AABB&) const
- {
- AZ_Assert(false, "Not supported");
- return false;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::CenterOnAABB(const AABB& aabb)
- {
- Vec3 selectionCenter = aabb.GetCenter();
- // Minimum center size is 40cm
- const float minSelectionRadius = 0.4f;
- const float selectionSize = std::max(minSelectionRadius, aabb.GetRadius());
- // Move camera 25% further back than required
- const float centerScale = 1.25f;
- // Decompose original transform matrix
- const Matrix34& originalTM = GetViewTM();
- AffineParts affineParts;
- affineParts.SpectralDecompose(originalTM);
- // Forward vector is y component of rotation matrix
- Matrix33 rotationMatrix(affineParts.rot);
- const Vec3 viewDirection = rotationMatrix.GetColumn1().GetNormalized();
- // Compute adjustment required by FOV != 90 degrees
- const float fov = GetFOV();
- const float fovScale = (1.0f / tan(fov * 0.5f));
- // Compute new transform matrix
- const float distanceToTarget = selectionSize * fovScale * centerScale;
- const Vec3 newPosition = selectionCenter - (viewDirection * distanceToTarget);
- Matrix34 newTM = Matrix34(rotationMatrix, newPosition);
- // Set new orbit distance
- float orbitDistance = distanceToTarget;
- orbitDistance = fabs(orbitDistance);
- SetViewTM(newTM);
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::SetFOV(const float fov)
- {
- if (m_viewEntityId.IsValid())
- {
- Camera::CameraRequestBus::Event(m_viewEntityId, &Camera::CameraComponentRequests::SetFovRadians, fov);
- }
- else
- {
- auto viewSystem = AZ::RPI::ViewportContextRequests::Get();
- if (!viewSystem)
- {
- return;
- }
- if (auto viewGroup = viewSystem->GetCurrentViewGroup(viewSystem->GetDefaultViewportContextName()))
- {
- auto viewToClip = viewGroup->GetView()->GetViewToClipMatrix();
- AZ::SetPerspectiveMatrixFOV(viewToClip, fov, aznumeric_cast<float>(width()) / aznumeric_cast<float>(height()));
- viewGroup->GetView()->SetViewToClipMatrix(viewToClip);
- }
- }
- }
- //////////////////////////////////////////////////////////////////////////
- float EditorViewportWidget::GetFOV() const
- {
- if (m_viewEntityId.IsValid())
- {
- float fov = 0.f;
- Camera::CameraRequestBus::EventResult(fov, m_viewEntityId, &Camera::CameraComponentRequests::GetFovRadians);
- return fov;
- }
- else
- {
- auto viewSystem = AZ::RPI::ViewportContextRequests::Get();
- if (!viewSystem)
- {
- return AZ::Constants::HalfPi; // 90 degrees (default)
- }
- if (auto viewGroup = viewSystem->GetCurrentViewGroup(viewSystem->GetDefaultViewportContextName()))
- {
- return AZ::GetPerspectiveMatrixFOV(viewGroup->GetView()->GetViewToClipMatrix());
- }
- }
- return AZ::Constants::HalfPi; // 90 degrees (default)
- }
- void EditorViewportWidget::OnActiveViewChanged(const AZ::EntityId& viewEntityId)
- {
- // Avoid re-entry
- if (m_sendingOnActiveChanged)
- {
- return;
- }
- // Ignore any changes in simulation mode
- if (m_playInEditorState != PlayInEditorState::Editor)
- {
- return;
- }
- // if they've picked the same camera, then that means they want to toggle
- if (viewEntityId.IsValid())
- {
- // Any such events for game entities should be filtered out by the check above
- AZ_Error(
- "EditorViewportWidget", Camera::EditorCameraViewRequestBus::FindFirstHandler(viewEntityId) != nullptr,
- "Internal logic error - active view changed to an entity which is not an editor camera. "
- "Please report this as a bug.");
- m_viewEntityId = viewEntityId;
- m_viewSourceType = ViewSourceType::CameraComponent;
- AZStd::string entityName;
- AZ::ComponentApplicationBus::BroadcastResult(entityName, &AZ::ComponentApplicationRequests::GetEntityName, viewEntityId);
- SetName(QString("Camera entity: %1").arg(entityName.c_str()));
- PostCameraSet();
- }
- else
- {
- SetDefaultCamera();
- }
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::SetDefaultCamera()
- {
- if (m_viewEntityId.IsValid())
- {
- // remove pushed view group for view entity (editor camera component in 'Be this camera' mode
- PopViewGroupForDefaultContext();
- }
- m_viewEntityId.SetInvalid();
- m_viewSourceType = ViewSourceType::None;
- GetViewManager()->SetCameraObjectId(GUID_NULL);
- SetName(m_defaultViewName);
- // synchronize the configured editor viewport FOV to the default camera
- if (m_viewPane)
- {
- const float fovRadians = SandboxEditor::CameraDefaultFovRadians();
- m_viewPane->OnFOVChanged(fovRadians);
- SetFOV(fovRadians);
- }
- // update camera matrix according to near / far values
- SetDefaultCameraNearFar();
- PushViewGroupForDefaultContext();
- PostCameraSet();
- }
- void EditorViewportWidget::SetDefaultCameraNearFar()
- {
- auto viewSystem = AZ::RPI::ViewportContextRequests::Get();
- if (!viewSystem)
- {
- return;
- }
- if (auto viewGroup = viewSystem->GetCurrentViewGroup(viewSystem->GetDefaultViewportContextName()))
- {
- auto viewToClip = viewGroup->GetView()->GetViewToClipMatrix();
- AZ::SetPerspectiveMatrixNearFar(viewToClip, SandboxEditor::CameraDefaultNearPlaneDistance(), SandboxEditor::CameraDefaultFarPlaneDistance());
- viewGroup->GetView()->SetViewToClipMatrix(viewToClip);
- }
- }
- void EditorViewportWidget::OnDefaultCameraNearFarChanged()
- {
- if (m_viewSourceType == ViewSourceType::None)
- {
- SetDefaultCameraNearFar();
- }
- }
- //////////////////////////////////////////////////////////////////////////
- AZ::RPI::ViewPtr EditorViewportWidget::GetCurrentAtomView() const
- {
- if (m_renderViewport && m_renderViewport->GetViewportContext())
- {
- return m_renderViewport->GetViewportContext()->GetDefaultView();
- }
- else
- {
- return nullptr;
- }
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::SetEntityAsCamera(const AZ::EntityId& entityId)
- {
- SetViewFromEntityPerspective(entityId);
- }
- void EditorViewportWidget::SetFirstComponentCamera()
- {
- AZ::EBusAggregateResults<AZ::EntityId> results;
- Camera::CameraBus::BroadcastResult(results, &Camera::CameraRequests::GetCameras);
- AZStd::sort_heap(results.values.begin(), results.values.end());
- AZ::EntityId entityId;
- if (!results.values.empty())
- {
- entityId = results.values[0];
- }
- SetEntityAsCamera(entityId);
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::SetSelectedCamera()
- {
- AZ::EBusAggregateResults<AZ::EntityId> cameraList;
- Camera::CameraBus::BroadcastResult(cameraList, &Camera::CameraRequests::GetCameras);
- if (cameraList.values.size() > 0)
- {
- AzToolsFramework::EntityIdList selectedEntityList;
- AzToolsFramework::ToolsApplicationRequests::Bus::BroadcastResult(
- selectedEntityList, &AzToolsFramework::ToolsApplicationRequests::GetSelectedEntities);
- for (const AZ::EntityId& entityId : selectedEntityList)
- {
- if (AZStd::find(cameraList.values.begin(), cameraList.values.end(), entityId) != cameraList.values.end())
- {
- SetEntityAsCamera(entityId);
- }
- }
- }
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::IsSelectedCamera() const
- {
- AzToolsFramework::EntityIdList selectedEntityList;
- AzToolsFramework::ToolsApplicationRequests::Bus::BroadcastResult(
- selectedEntityList, &AzToolsFramework::ToolsApplicationRequests::GetSelectedEntities);
- if ((m_viewSourceType == ViewSourceType::CameraComponent) && !selectedEntityList.empty() &&
- AZStd::find(selectedEntityList.begin(), selectedEntityList.end(), m_viewEntityId) != selectedEntityList.end())
- {
- return true;
- }
- return false;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::CycleCamera()
- {
- // None -> Sequence -> LegacyCamera -> ... LegacyCamera -> CameraComponent -> ... CameraComponent -> None
- // AZ_Entity has been intentionally left out of the cycle for now.
- switch (m_viewSourceType)
- {
- case EditorViewportWidget::ViewSourceType::None:
- {
- SetFirstComponentCamera();
- break;
- }
- case EditorViewportWidget::ViewSourceType::CameraComponent:
- {
- AZ::EBusAggregateResults<AZ::EntityId> results;
- Camera::CameraBus::BroadcastResult(results, &Camera::CameraRequests::GetCameras);
- AZStd::sort_heap(results.values.begin(), results.values.end());
- auto&& currentCameraIterator = AZStd::find(results.values.begin(), results.values.end(), m_viewEntityId);
- if (currentCameraIterator != results.values.end())
- {
- ++currentCameraIterator;
- if (currentCameraIterator != results.values.end())
- {
- SetEntityAsCamera(*currentCameraIterator);
- break;
- }
- }
- SetDefaultCamera();
- break;
- }
- default:
- {
- SetDefaultCamera();
- break;
- }
- }
- }
- void EditorViewportWidget::SetViewFromEntityPerspective(const AZ::EntityId& entityId)
- {
- // This is an editor event, so is only serviced during edit mode, not play game mode
- if (m_playInEditorState != PlayInEditorState::Editor)
- {
- AZ_Warning(
- "EditorViewportWidget", false, "Tried to change the editor camera during play game in editor; this is currently unsupported");
- return;
- }
- // when changing view, if an editor camera component (view entity) was in use, ensure we attempt to record an undo operation
- // in case the transform of the entity changed (if no changes occurred then no undo operation will be stored)
- if (m_viewEntityId.IsValid())
- {
- MarkCameraEntityDirty(m_viewEntityId);
- }
- if (entityId.IsValid())
- {
- // if we are switching between editor camera components (view entities) in the scene, if one is currently
- // assigned, ensure we pop it from the stack before assigning a new one
- if (m_viewEntityId.IsValid())
- {
- PopViewGroupForDefaultContext();
- }
- Camera::CameraRequestBus::Event(entityId, &Camera::CameraRequestBus::Events::MakeActiveView);
- }
- else
- {
- // note: SetDefaultCamera internally handles popping the current view group if an editor camera component
- // (view entity) is assigned
- SetDefaultCamera();
- }
- }
- bool EditorViewportWidget::GetActiveCameraPosition(AZ::Vector3& cameraPos)
- {
- if (m_pPrimaryViewport == this)
- {
- if (GetIEditor()->IsInGameMode())
- {
- cameraPos = m_renderViewport->GetViewportContext()->GetCameraTransform().GetTranslation();
- }
- else
- {
- // Use viewTM, which is synced with the camera and guaranteed to be up-to-date
- cameraPos = LYVec3ToAZVec3(GetViewTM().GetTranslation());
- }
- return true;
- }
- return false;
- }
- AZStd::optional<AZ::Transform> EditorViewportWidget::GetActiveCameraTransform()
- {
- if (m_pPrimaryViewport == this)
- {
- if (GetIEditor()->IsInGameMode())
- {
- return m_renderViewport->GetViewportContext()->GetCameraTransform();
- }
- else
- {
- // Use viewTM, which is synced with the camera and guaranteed to be up-to-date
- return GetCurrentAtomView()->GetCameraTransform();
- }
- }
- return AZStd::nullopt;
- }
- AZStd::optional<float> EditorViewportWidget::GetCameraFoV()
- {
- if (m_pPrimaryViewport == this)
- {
- return GetFOV();
- }
- return AZStd::nullopt;
- }
- bool EditorViewportWidget::GetActiveCameraState(AzFramework::CameraState& cameraState)
- {
- if (m_pPrimaryViewport == this)
- {
- cameraState = m_renderViewport->GetCameraState();
- return true;
- }
- return false;
- }
- void EditorViewportWidget::OnStartPlayInEditorBegin()
- {
- m_playInEditorState = PlayInEditorState::Starting;
- }
- void EditorViewportWidget::OnRootPrefabInstanceLoaded()
- {
- // set the default camera on level/prefab load
- SetDefaultCamera();
- // set the camera position once we know the entire scene (level) has finished loading
- Matrix34 defaultView = Matrix34::CreateIdentity();
- // check to see if we have an existing last known location for this level
- auto* viewBookmarkInterface = AZ::Interface<AzToolsFramework::ViewBookmarkInterface>::Get();
- if (const AZStd::optional<AzToolsFramework::ViewBookmark> lastKnownLocationBookmark = viewBookmarkInterface->LoadLastKnownLocation();
- lastKnownLocationBookmark.has_value())
- {
- defaultView.SetTranslation(Vec3(lastKnownLocationBookmark->m_position));
- defaultView.SetRotation33(AZMatrix3x3ToLYMatrix3x3(AZ::Matrix3x3::CreateFromQuaternion(SandboxEditor::CameraRotation(
- AZ::DegToRad(lastKnownLocationBookmark->m_rotation.GetX()), AZ::DegToRad(lastKnownLocationBookmark->m_rotation.GetZ())))));
- }
- else
- {
- // set the default editor camera position and orientation if there was no last known location
- const AZ::Vector2 pitchYawDegrees = m_editorViewportSettings.DefaultEditorCameraOrientation();
- defaultView.SetTranslation(Vec3(m_editorViewportSettings.DefaultEditorCameraPosition()));
- defaultView.SetRotation33(AZMatrix3x3ToLYMatrix3x3(AZ::Matrix3x3::CreateFromQuaternion(
- SandboxEditor::CameraRotation(AZ::DegToRad(pitchYawDegrees.GetX()), AZ::DegToRad(pitchYawDegrees.GetY())))));
- }
- SetViewTM(defaultView);
- }
- void EditorViewportWidget::OnStartPlayInEditor()
- {
- m_playInEditorState = PlayInEditorState::Started;
- if (m_viewEntityId.IsValid())
- {
- // Note that this is assuming that the Atom camera components will share the same view ptr
- // in editor as in game mode
- m_viewEntityIdCachedForEditMode = m_viewEntityId;
- AZ::EntityId runtimeEntityId;
- AzToolsFramework::EditorEntityContextRequestBus::Broadcast(
- &AzToolsFramework::EditorEntityContextRequestBus::Events::MapEditorIdToRuntimeId, m_viewEntityId, runtimeEntityId);
- m_viewEntityId = runtimeEntityId;
- }
- }
- void EditorViewportWidget::OnStopPlayInEditor()
- {
- m_playInEditorState = PlayInEditorState::Stopping;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::HideCursor()
- {
- if (m_bCursorHidden || !gSettings.viewports.bHideMouseCursorWhenCaptured)
- {
- return;
- }
- qApp->setOverrideCursor(Qt::BlankCursor);
- #if AZ_TRAIT_OS_PLATFORM_APPLE
- StartFixedCursorMode(this);
- #endif
- m_bCursorHidden = true;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::ShowCursor()
- {
- if (!m_bCursorHidden || !gSettings.viewports.bHideMouseCursorWhenCaptured)
- {
- return;
- }
- #if AZ_TRAIT_OS_PLATFORM_APPLE
- StopFixedCursorMode();
- #endif
- qApp->restoreOverrideCursor();
- m_bCursorHidden = false;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::PushDisableRendering()
- {
- ++m_disableRenderingCount;
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::PopDisableRendering()
- {
- assert(m_disableRenderingCount >= 1);
- --m_disableRenderingCount;
- }
- //////////////////////////////////////////////////////////////////////////
- bool EditorViewportWidget::IsRenderingDisabled() const
- {
- return m_disableRenderingCount > 0;
- }
- //////////////////////////////////////////////////////////////////////////
- QPoint EditorViewportWidget::WidgetToViewport(const QPoint& point) const
- {
- return point * WidgetToViewportFactor();
- }
- QPoint EditorViewportWidget::ViewportToWidget(const QPoint& point) const
- {
- return point / WidgetToViewportFactor();
- }
- //////////////////////////////////////////////////////////////////////////
- QSize EditorViewportWidget::WidgetToViewport(const QSize& size) const
- {
- return size * WidgetToViewportFactor();
- }
- //////////////////////////////////////////////////////////////////////////
- double EditorViewportWidget::WidgetToViewportFactor() const
- {
- #if defined(AZ_PLATFORM_WINDOWS)
- // Needed for high DPI mode on windows
- return devicePixelRatioF();
- #else
- return 1.0;
- #endif
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::BeginUndoTransaction()
- {
- PushDisableRendering();
- }
- //////////////////////////////////////////////////////////////////////////
- void EditorViewportWidget::EndUndoTransaction()
- {
- PopDisableRendering();
- Update();
- }
- void* EditorViewportWidget::GetSystemCursorConstraintWindow() const
- {
- // Even when the mouse cursor is not in a constrained mode, we still return the viewport as the constraint window,
- // so that the engine's mouse coordinates will be normalized to the editor viewport rather than the entire application window.
- // This ensures that viewport mouse interactions are in the correct 2D coordinate space, for example when using ImGuiManager's
- // debug tools.
- return renderOverlayHWND();
- }
- void EditorViewportWidget::BuildDragDropContext(
- AzQtComponents::ViewportDragContext& context, const AzFramework::ViewportId viewportId, const QPoint& point)
- {
- QtViewport::BuildDragDropContext(context, viewportId, point);
- }
- void EditorViewportWidget::RestoreViewportAfterGameMode()
- {
- Matrix34 preGameModeViewTM = m_preGameModeViewTM;
- QString text = QString(
- tr("When leaving \" Game Mode \" the engine will automatically restore your camera position to the default position before you "
- "had entered Game mode.<br/><br/><small>If you dislike this setting you can always change this anytime in the global "
- "preferences.</small><br/><br/>"));
- QString restoreOnExitGameModePopupDisabledRegKey("Editor/AutoHide/ViewportCameraRestoreOnExitGameMode");
- // Read the popup disabled registry value
- QSettings settings;
- QVariant restoreOnExitGameModePopupDisabledRegValue = settings.value(restoreOnExitGameModePopupDisabledRegKey);
- // Has the user previously disabled being asked about restoring the camera on exiting game mode?
- if (restoreOnExitGameModePopupDisabledRegValue.isNull())
- {
- // No, ask them now
- QMessageBox messageBox(QMessageBox::Question, "O3DE", text, QMessageBox::StandardButtons(QMessageBox::No | QMessageBox::Yes), this);
- messageBox.setDefaultButton(QMessageBox::Yes);
- QCheckBox* checkBox = new QCheckBox(QStringLiteral("Do not show this message again"));
- checkBox->setChecked(true);
- messageBox.setCheckBox(checkBox);
- // Unconstrain the system cursor and make it visible before we show the dialog box, otherwise the user can't see the cursor.
- AzFramework::InputSystemCursorRequestBus::Event(
- AzFramework::InputDeviceMouse::Id, &AzFramework::InputSystemCursorRequests::SetSystemCursorState,
- AzFramework::SystemCursorState::UnconstrainedAndVisible);
- int response = messageBox.exec();
- if (checkBox->isChecked())
- {
- settings.setValue(restoreOnExitGameModePopupDisabledRegKey, response);
- }
- // Update the value only if the popup hasn't previously been disabled and the value has changed
- bool newSetting = (response == QMessageBox::Yes);
- if (newSetting != GetIEditor()->GetEditorSettings()->restoreViewportCamera)
- {
- GetIEditor()->GetEditorSettings()->restoreViewportCamera = newSetting;
- GetIEditor()->GetEditorSettings()->Save();
- }
- }
- bool restoreViewportCamera = GetIEditor()->GetEditorSettings()->restoreViewportCamera;
- if (restoreViewportCamera)
- {
- SetViewTM(preGameModeViewTM);
- }
- else
- {
- AZ_Warning("CryLegacy", false, "Not restoring the editor viewport camera is currently unsupported");
- SetViewTM(preGameModeViewTM);
- }
- }
- void EditorViewportWidget::UpdateScene()
- {
- auto sceneSystem = AzFramework::SceneSystemInterface::Get();
- if (sceneSystem)
- {
- AZStd::shared_ptr<AzFramework::Scene> mainScene = sceneSystem->GetScene(AzFramework::Scene::MainSceneName);
- if (mainScene)
- {
- AZ::RPI::SceneNotificationBus::Handler::BusDisconnect();
- m_renderViewport->SetScene(mainScene);
- auto viewportContext = m_renderViewport->GetViewportContext();
- AZ::RPI::SceneNotificationBus::Handler::BusConnect(viewportContext->GetRenderScene()->GetId());
- // Don't enable the render pipeline until a level has been loaded
- // Also show/hide the RenderViewportWidget accordingly so that we get the
- // expected gradient background when no level is loaded
- auto renderPipeline = viewportContext->GetCurrentPipeline();
- if (renderPipeline)
- {
- if (GetIEditor()->IsLevelLoaded())
- {
- m_renderViewport->show();
- renderPipeline->AddToRenderTick();
- }
- else
- {
- m_renderViewport->hide();
- renderPipeline->RemoveFromRenderTick();
- }
- }
- }
- }
- }
- void EditorViewportWidget::SetAsActiveViewport()
- {
- auto viewportContextManager = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
- const AZ::Name defaultContextName = viewportContextManager->GetDefaultViewportContextName();
- // If another viewport was active before, restore its name to its per-ID one.
- if (m_pPrimaryViewport && m_pPrimaryViewport != this && m_pPrimaryViewport->m_renderViewport)
- {
- auto viewportContext = m_pPrimaryViewport->m_renderViewport->GetViewportContext();
- if (viewportContext)
- {
- // Remove the old viewport's camera from the stack, as it's no longer the owning viewport
- viewportContextManager->PopViewGroup(defaultContextName, viewportContext->GetViewGroup());
- viewportContextManager->RenameViewportContext(viewportContext, defaultContextName);
- }
- }
- m_pPrimaryViewport = this;
- if (m_renderViewport)
- {
- auto viewportContext = m_renderViewport->GetViewportContext();
- if (viewportContext)
- {
- // Push our camera onto the default viewport's view stack to preserve camera state continuity
- // Other views can still be pushed on top of our view for e.g. game mode
- viewportContextManager->RenameViewportContext(viewportContext, defaultContextName);
- viewportContextManager->PushViewGroup(defaultContextName, viewportContext->GetViewGroup());
- }
- }
- }
- void EditorViewportSettings::Connect(const AzFramework::ViewportId viewportId)
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsRequestBus::Handler::BusConnect(viewportId);
- }
- void EditorViewportSettings::Disconnect()
- {
- AzToolsFramework::ViewportInteraction::ViewportSettingsRequestBus::Handler::BusDisconnect();
- }
- bool EditorViewportSettings::GridSnappingEnabled() const
- {
- return SandboxEditor::GridSnappingEnabled();
- }
- float EditorViewportSettings::GridSize() const
- {
- return SandboxEditor::GridSnappingSize();
- }
- bool EditorViewportSettings::ShowGrid() const
- {
- return SandboxEditor::ShowingGrid();
- }
- bool EditorViewportSettings::AngleSnappingEnabled() const
- {
- return SandboxEditor::AngleSnappingEnabled();
- }
- float EditorViewportSettings::AngleStep() const
- {
- return SandboxEditor::AngleSnappingSize();
- }
- float EditorViewportSettings::ManipulatorLineBoundWidth() const
- {
- return SandboxEditor::ManipulatorLineBoundWidth();
- }
- float EditorViewportSettings::ManipulatorCircleBoundWidth() const
- {
- return SandboxEditor::ManipulatorCircleBoundWidth();
- }
- bool EditorViewportSettings::StickySelectEnabled() const
- {
- return SandboxEditor::StickySelectEnabled();
- }
- AZ::Vector3 EditorViewportSettings::DefaultEditorCameraPosition() const
- {
- return SandboxEditor::CameraDefaultEditorPosition();
- }
- AZ::Vector2 EditorViewportSettings::DefaultEditorCameraOrientation() const
- {
- return SandboxEditor::CameraDefaultEditorOrientation();
- }
- bool EditorViewportSettings::IconsVisible() const
- {
- return AzToolsFramework::IconsVisible();
- }
- bool EditorViewportSettings::HelpersVisible() const
- {
- return AzToolsFramework::HelpersVisible();
- }
- bool EditorViewportSettings::OnlyShowHelpersForSelectedEntities() const
- {
- return AzToolsFramework::OnlyShowHelpersForSelectedEntities();
- }
- AZ_CVAR_EXTERNED(bool, ed_previewGameInFullscreen_once);
- bool EditorViewportWidget::ShouldPreviewFullscreen() const
- {
- CLayoutWnd* layout = GetIEditor()->GetViewManager()->GetLayout();
- if (!layout)
- {
- AZ_Assert(false, "CRenderViewport: No View Manager layout");
- return false;
- }
- // Doesn't work with split layout
- if (layout->GetLayout() != EViewLayout::ET_Layout0)
- {
- return false;
- }
- // If level not loaded, don't preview in fullscreen (preview shouldn't work at all without a level, but it does)
- if (auto ge = GetIEditor()->GetGameEngine())
- {
- if (!ge->IsLevelLoaded())
- {
- return false;
- }
- }
- // Check 'ed_previewGameInFullscreen_once'
- if (ed_previewGameInFullscreen_once)
- {
- ed_previewGameInFullscreen_once = false;
- return true;
- }
- else
- {
- return false;
- }
- }
- void EditorViewportWidget::StartFullscreenPreview()
- {
- AZ_Assert(!m_inFullscreenPreview, "EditorViewportWidget::StartFullscreenPreview called when already in full screen preview");
- m_inFullscreenPreview = true;
- // Pick the screen on which the main window lies to use as the screen for the full screen preview
- const QScreen* screen = MainWindow::instance()->screen();
- const QRect screenGeometry = screen->geometry();
- // Unparent this and show it, which turns it into a free floating window
- // Also set style to frameless and disable resizing by user
- setParent(nullptr);
- setWindowFlag(Qt::FramelessWindowHint, true);
- setWindowFlag(Qt::MSWindowsFixedSizeDialogHint, true);
- setFixedSize(screenGeometry.size());
- move(QPoint(screenGeometry.x(), screenGeometry.y()));
- showMaximized();
- // This must be done after unparenting this widget above
- MainWindow::instance()->hide();
- }
- void EditorViewportWidget::StopFullscreenPreview()
- {
- AZ_Assert(m_inFullscreenPreview, "EditorViewportWidget::StartFullscreenPreview called when not in full screen preview");
- m_inFullscreenPreview = false;
- // Unset frameless window flags
- setWindowFlag(Qt::FramelessWindowHint, false);
- setWindowFlag(Qt::MSWindowsFixedSizeDialogHint, false);
- // Unset fixed size (note that 50x50 is the minimum set in the constructor)
- setMaximumSize(QWIDGETSIZE_MAX, QWIDGETSIZE_MAX);
- setMinimumSize(50, 50);
- // Attach this viewport to the primary view pane (whose index is 0).
- if (CLayoutWnd* layout = GetIEditor()->GetViewManager()->GetLayout())
- {
- if (CLayoutViewPane* viewPane = layout->GetViewPaneByIndex(0))
- {
- // Force-reattach this viewport to its view pane by first detaching
- viewPane->DetachViewport();
- viewPane->AttachViewport(this);
- // Set the main widget of the layout, which causes this widgets size to be bound to the layout
- // and the viewport title bar to be displayed
- layout->SetMainWidget(viewPane);
- }
- else
- {
- AZ_Assert(false, "CRenderViewport: No view pane with ID 0 (primary view pane)");
- }
- }
- else
- {
- AZ_Assert(false, "CRenderViewport: No View Manager layout");
- }
- // Set this as the selected viewport
- GetIEditor()->GetViewManager()->SelectViewport(this);
- // Show this widget (setting flags may hide it)
- showNormal();
- // Show the main window
- MainWindow::instance()->show();
- }
- AZStd::optional<AzFramework::ViewportBorderPadding> EditorViewportWidget::GetViewportBorderPadding() const
- {
- if (auto viewportEditorModeTracker = AZ::Interface<AzToolsFramework::ViewportEditorModeTrackerInterface>::Get())
- {
- auto viewportEditorModes = viewportEditorModeTracker->GetViewportEditorModes({ AzToolsFramework::GetEntityContextId() });
- if (viewportEditorModes->IsModeActive(AzToolsFramework::ViewportEditorMode::Focus) ||
- viewportEditorModes->IsModeActive(AzToolsFramework::ViewportEditorMode::Component))
- {
- AzFramework::ViewportBorderPadding viewportBorderPadding = {};
- viewportBorderPadding.m_top = AzToolsFramework::ViewportUi::ViewportUiTopBorderSize;
- viewportBorderPadding.m_left = AzToolsFramework::ViewportUi::ViewportUiLeftRightBottomBorderSize;
- viewportBorderPadding.m_right = AzToolsFramework::ViewportUi::ViewportUiLeftRightBottomBorderSize;
- viewportBorderPadding.m_bottom = AzToolsFramework::ViewportUi::ViewportUiLeftRightBottomBorderSize;
- return viewportBorderPadding;
- }
- }
- return AZStd::nullopt;
- }
- #include <moc_EditorViewportWidget.cpp>
|