Files
o3de/Code/Sandbox/Editor/EditorViewportSettings.h
T
Tom Hulton-Harrop 8ffd16b0be Ensure SnapToGrid only appears when GridSnapping is enabled LYN-2302 (#1362)
* updates to better support showing/hiding viewport ui when grid snapping is enabled/disabled

* connect up editor settings callbacks

* minor polish changes

* api rename

* updates following review feedback
2021-06-17 18:31:56 +01:00

90 lines
3.2 KiB
C++

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
#pragma once
#include <SandboxAPI.h>
#include <AzCore/Settings/SettingsRegistry.h>
#include <AzCore/std/smart_ptr/unique_ptr.h>
namespace SandboxEditor
{
using GridSnappingChangedEvent = AZ::Event<bool>;
//! Set callbacks to listen for editor settings change events.
class EditorViewportSettingsCallbacks
{
public:
virtual ~EditorViewportSettingsCallbacks() = default;
virtual void SetGridSnappingChangedEvent(GridSnappingChangedEvent::Handler& handler) = 0;
};
//! Create an instance of EditorViewportSettingsCallbacks
//! Note: EditorViewportSettingsCallbacks is implemented in EditorViewportSettings.cpp - a change
//! event will fire when a value in the settings registry (editorpreferences.setreg) is modified.
SANDBOX_API AZStd::unique_ptr<EditorViewportSettingsCallbacks> CreateEditorViewportSettingsCallbacks();
SANDBOX_API bool GridSnappingEnabled();
SANDBOX_API void SetGridSnapping(bool enabled);
SANDBOX_API float GridSnappingSize();
SANDBOX_API void SetGridSnappingSize(float size);
SANDBOX_API bool AngleSnappingEnabled();
SANDBOX_API void SetAngleSnapping(bool enabled);
SANDBOX_API float AngleSnappingSize();
SANDBOX_API void SetAngleSnappingSize(float size);
SANDBOX_API bool ShowingGrid();
SANDBOX_API void SetShowingGrid(bool showing);
SANDBOX_API float CameraTranslateSpeed();
SANDBOX_API void SetCameraTranslateSpeed(float speed);
SANDBOX_API float CameraBoostMultiplier();
SANDBOX_API void SetCameraBoostMultiplier(float multiplier);
SANDBOX_API float CameraRotateSpeed();
SANDBOX_API void SetCameraRotateSpeed(float speed);
SANDBOX_API float CameraScrollSpeed();
SANDBOX_API void SetCameraScrollSpeed(float speed);
SANDBOX_API float CameraDollyMotionSpeed();
SANDBOX_API void SetCameraDollyMotionSpeed(float speed);
SANDBOX_API bool CameraOrbitYawRotationInverted();
SANDBOX_API void SetCameraOrbitYawRotationInverted(bool inverted);
SANDBOX_API bool CameraPanInvertedX();
SANDBOX_API void SetCameraPanInvertedX(bool inverted);
SANDBOX_API bool CameraPanInvertedY();
SANDBOX_API void SetCameraPanInvertedY(bool inverted);
SANDBOX_API float CameraPanSpeed();
SANDBOX_API void SetCameraPanSpeed(float speed);
SANDBOX_API float CameraRotateSmoothness();
SANDBOX_API void SetCameraRotateSmoothness(float smoothness);
SANDBOX_API float CameraTranslateSmoothness();
SANDBOX_API void SetCameraTranslateSmoothness(float smoothness);
//! Return if the new editor camera system is enabled or not.
//! @note This is implemented in EditorViewportWidget.cpp
SANDBOX_API bool UsingNewCameraSystem();
} // namespace SandboxEditor