Files
OpenSpace/modules/autonavigation/autonavigationhandler.h
Emma Broman 4c9874c8d3 Some cleanup
2020-02-27 14:00:37 -05:00

104 lines
4.5 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_MODULE___AUTONAVIGATIONHANDLER___H__
#define __OPENSPACE_MODULE___AUTONAVIGATIONHANDLER___H__
#include <modules/autonavigation/pathsegment.h>
#include <openspace/interaction/interpolator.h>
#include <openspace/interaction/navigationhandler.h>
#include <openspace/properties/optionproperty.h>
#include <openspace/properties/propertyowner.h>
#include <openspace/scene/scenegraphnode.h>
#include <ghoul/glm.h>
namespace openspace {
class Camera;
} // namespace openspace
namespace openspace::autonavigation {
struct CameraState;
struct Instruction;
class PathSpecification;
class AutoNavigationHandler : public properties::PropertyOwner {
public:
AutoNavigationHandler();
~AutoNavigationHandler();
// Accessors
Camera* camera() const;
double pathDuration() const;
bool hasFinished() const;
CameraState currentCameraState();
void updateCamera(double deltaTime);
void createPath(PathSpecification& spec);
void clearPath();
void startPath();
void pausePath();
void continuePath();
void stopPath();
// TODO: remove functions for debugging
std::vector<glm::dvec3> getCurvePositions(int nPerSegment); //debug
std::vector<glm::dvec3> getControlPoints(); //debug
private:
bool handleInstruction(const Instruction& instruction, int index);
bool handleTargetNodeInstruction(const Instruction& instruction);
bool handleNavigationStateInstruction(const Instruction& instruction);
bool handlePauseInstruction(const Instruction& instruction);
void addSegment(CameraState& start, CameraState& end, std::optional<double> duration);
void addPause(CameraState& state, std::optional<double> duration);
double findValidBoundingSphere(const SceneGraphNode* node);
glm::dvec3 computeTargetPositionAtNode(const SceneGraphNode* node,
glm::dvec3 prevPos, std::optional<double> height);
CameraState cameraStateFromNavigationState(
const interaction::NavigationHandler::NavigationState& ns);
// this list essentially represents the camera path
std::vector<PathSegment> _pathSegments;
bool _isPlaying = false;
double _currentTime = 0.0;
double _distanceAlongCurrentSegment = 0.0;
unsigned int _currentSegmentIndex = 0;
bool _stopAtTargets;
properties::DoubleProperty _minAllowedBoundingSphere;
properties::OptionProperty _defaultCurveOption;
};
} // namespace openspace::autonavigation
#endif // __OPENSPACE_CORE___NAVIGATIONHANDLER___H__