Files
OpenSpace/modules/touch/include/directinputsolver.h
Alexander Bock 820e90eab4 Happy new year
2025-01-14 16:21:08 +01:00

79 lines
3.4 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2025 *
* *
* 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_TOUCH___DIRECTINPUT_SOLVER___H__
#define __OPENSPACE_MODULE_TOUCH___DIRECTINPUT_SOLVER___H__
#include <openspace/util/touch.h>
#include <modules/touch/ext/levmarq.h>
#include <vector>
namespace openspace {
class Camera;
class SceneGraphNode;
/**
* The DirectInputSolver is used to minimize the L2 error of touch input to 3D camera
* position. It uses the levmarq algorithm in order to do this.
*/
class DirectInputSolver {
public:
/**
* Stores the selected node, the cursor ID as well as the surface coordinates the
* cursor touched
*/
struct SelectedBody {
size_t id = 0;
SceneGraphNode* node = nullptr;
glm::dvec3 coordinates = glm::dvec3(0.0);
};
DirectInputSolver();
/**
* Returns true if the error could be minimized within certain bounds. If the error is
* found to be outside the bounds after a certain amount of iterations, this function
* fails.
*/
bool solve(const std::vector<TouchInputHolder>& list,
const std::vector<SelectedBody>& selectedBodies,
std::vector<double>* calculatedValues, const Camera& camera);
int nDof() const;
const LMstat& levMarqStat();
void setLevMarqVerbosity(bool verbose);
private:
int _nDof = 0;
LMstat _lmstat;
};
} // openspace namespace
#endif // __OPENSPACE_MODULE_TOUCH___DIRECTINPUT_SOLVER___H__