OpenSpace/include/openspace/scene/translation.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2024                                                               *
 *                                                                                       *
 * 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___TRANSLATION___H__
#define __OPENSPACE_CORE___TRANSLATION___H__

#include <openspace/properties/propertyowner.h>

#include <ghoul/glm.h>
#include <ghoul/misc/managedmemoryuniqueptr.h>
#include <functional>

namespace ghoul { class Dictionary; }

namespace openspace {

struct UpdateData;

namespace documentation {  struct Documentation; }

class Translation : public properties::PropertyOwner {
public:
    static ghoul::mm_unique_ptr<Translation> createFromDictionary(
        const ghoul::Dictionary& dictionary);

    Translation();
    virtual ~Translation() override = default;
    virtual bool initialize();

    virtual void update(const UpdateData& data);
    glm::dvec3 position() const;

    virtual glm::dvec3 position(const UpdateData& data) const = 0;

    // Registers a callback that gets called when a significant change has been made that
    // invalidates potentially stored points, for example in trails
    void onParameterChange(std::function<void()> callback);

    static documentation::Documentation Documentation();

protected:
    void notifyObservers() const;
    void requireUpdate();

private:
    bool _needsUpdate = true;
    double _cachedTime = -std::numeric_limits<double>::max();
    glm::dvec3 _cachedPosition = glm::dvec3(0.0);
    std::function<void()> _onParameterChangeCallback;
};

} // namespace openspace

#endif // __OPENSPACE_CORE___TRANSLATION___H__