mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-04 10:40:09 -06:00
bb3db7ada7
* Cleanup * CMake cleanups * Update current year * Update copyright header * Use script to return list of all modules * Update credits, license and ghoul
131 lines
5.4 KiB
C++
131 lines
5.4 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* OpenSpace *
|
|
* *
|
|
* Copyright (c) 2014-2019 *
|
|
* *
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
|
* software and associated documentation files (the "Software"), to deal in the Software *
|
|
* without restriction, including without limitation the rights to use, copy, modify, *
|
|
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
|
* permit persons to whom the Software is furnished to do so, subject to the following *
|
|
* conditions: *
|
|
* *
|
|
* The above copyright notice and this permission notice shall be included in all copies *
|
|
* or substantial portions of the Software. *
|
|
* *
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
|
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
|
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
|
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
****************************************************************************************/
|
|
|
|
#ifndef __OPENSPACE_CORE___NAVIGATIONHANDLER___H__
|
|
#define __OPENSPACE_CORE___NAVIGATIONHANDLER___H__
|
|
|
|
#include <openspace/properties/propertyowner.h>
|
|
|
|
#include <openspace/interaction/joystickcamerastates.h>
|
|
#include <openspace/properties/stringproperty.h>
|
|
#include <openspace/properties/scalar/boolproperty.h>
|
|
#include <openspace/util/mouse.h>
|
|
#include <openspace/util/keys.h>
|
|
|
|
namespace openspace {
|
|
class Camera;
|
|
class SceneGraphNode;
|
|
} // namespace openspace
|
|
|
|
namespace openspace::scripting { struct LuaLibrary; }
|
|
|
|
namespace openspace::interaction {
|
|
|
|
struct JoystickInputStates;
|
|
class KeyframeNavigator;
|
|
class OrbitalNavigator;
|
|
|
|
class NavigationHandler : public properties::PropertyOwner {
|
|
public:
|
|
NavigationHandler();
|
|
~NavigationHandler();
|
|
|
|
void initialize();
|
|
void deinitialize();
|
|
|
|
// Mutators
|
|
void setCamera(Camera* camera);
|
|
void setInterpolationTime(float durationInSeconds);
|
|
|
|
void setCameraStateFromDictionary(const ghoul::Dictionary& cameraDict);
|
|
void updateCamera(double deltaTime);
|
|
void setEnableKeyFrameInteraction();
|
|
void setDisableKeyFrameInteraction();
|
|
void triggerPlaybackStart();
|
|
void stopPlayback();
|
|
|
|
// Accessors
|
|
ghoul::Dictionary cameraStateDictionary();
|
|
Camera* camera() const;
|
|
const InputState& inputState() const;
|
|
const OrbitalNavigator& orbitalNavigator() const;
|
|
OrbitalNavigator& orbitalNavigator();
|
|
KeyframeNavigator& keyframeNavigator() const;
|
|
bool isKeyFrameInteractionEnabled() const;
|
|
float interpolationTime() const;
|
|
|
|
// Callback functions
|
|
void keyboardCallback(Key key, KeyModifier modifier, KeyAction action);
|
|
|
|
void mouseButtonCallback(MouseButton button, MouseAction action);
|
|
void mousePositionCallback(double x, double y);
|
|
void mouseScrollWheelCallback(double pos);
|
|
|
|
void setJoystickAxisMapping(int axis, JoystickCameraStates::AxisType mapping,
|
|
JoystickCameraStates::AxisInvert shouldInvert =
|
|
JoystickCameraStates::AxisInvert::No,
|
|
JoystickCameraStates::AxisNormalize shouldNormalize =
|
|
JoystickCameraStates::AxisNormalize::No
|
|
);
|
|
|
|
JoystickCameraStates::AxisInformation joystickAxisMapping(int axis) const;
|
|
|
|
void setJoystickAxisDeadzone(int axis, float deadzone);
|
|
float joystickAxisDeadzone(int axis) const;
|
|
|
|
void bindJoystickButtonCommand(int button, std::string command, JoystickAction action,
|
|
JoystickCameraStates::ButtonCommandRemote remote, std::string documentation);
|
|
|
|
void clearJoystickButtonCommand(int button);
|
|
std::vector<std::string> joystickButtonCommand(int button) const;
|
|
|
|
|
|
|
|
void saveCameraStateToFile(const std::string& filepath);
|
|
void restoreCameraStateFromFile(const std::string& filepath);
|
|
|
|
/**
|
|
* \return The Lua library that contains all Lua functions available to affect the
|
|
* interaction
|
|
*/
|
|
static scripting::LuaLibrary luaLibrary();
|
|
|
|
private:
|
|
bool _cameraUpdatedFromScript = false;
|
|
bool _playbackModeEnabled = false;
|
|
|
|
std::unique_ptr<InputState> _inputState;
|
|
Camera* _camera = nullptr;
|
|
std::function<void()> _playbackEndCallback;
|
|
|
|
std::unique_ptr<OrbitalNavigator> _orbitalNavigator;
|
|
std::unique_ptr<KeyframeNavigator> _keyframeNavigator;
|
|
|
|
properties::BoolProperty _useKeyFrameInteraction;
|
|
};
|
|
|
|
} // namespace openspace::interaction
|
|
|
|
#endif // __OPENSPACE_CORE___NAVIGATIONHANDLER___H__
|