Camera.h

Go to the documentation of this file.

/*
 *
 * The Blue Brain BioExplorer is a tool for scientists to extract and analyse
 * scientific data from visualization
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * Copyright 2020-2024 Blue BrainProject / EPFL
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <platform/core/common/Api.h>
#include <platform/core/common/PropertyObject.h>
#include <platform/core/common/Types.h>
 
SERIALIZATION_ACCESS(Camera)
 
namespace core
{
class Camera : public PropertyObject
{
public:
    PLATFORM_API Camera() = default;
 
    PLATFORM_API virtual ~Camera() = default;
 
    PLATFORM_API virtual void commit(){};
 
    PLATFORM_API Camera& operator=(const Camera& rhs);
 
    PLATFORM_API void set(const Vector3d& position, const Quaterniond& orientation,
                          const Vector3d& target = Vector3d(0.0, 0.0, 0.0));
 
    PLATFORM_API void setInitialState(const Vector3d& position, const Quaterniond& orientation,
                                      const Vector3d& target = Vector3d(0.0, 0.0, 0.0));
 
    PLATFORM_API void reset();
 
    PLATFORM_API void setPosition(const Vector3d& position) { _updateValue(_position, position); }
 
    PLATFORM_API void setTarget(const Vector3d& target) { _updateValue(_target, target); }
 
    PLATFORM_API const Vector3d& getPosition() const { return _position; }
 
    PLATFORM_API const Vector3d& getTarget() const { return _target; }
 
    PLATFORM_API void setOrientation(Quaterniond orientation)
    {
        orientation = glm::normalize(orientation);
        _updateValue(_orientation, orientation);
    }
 
    PLATFORM_API const Quaterniond& getOrientation() const { return _orientation; }
 
    PLATFORM_API void setBufferTarget(const std::string& target) { _updateValue(_bufferTarget, target, false); }
 
    PLATFORM_API const std::string& getBufferTarget() const { return _bufferTarget; }
 
    PLATFORM_API void setEngine(Engine* engine) { _engine = engine; }
 
protected:
    Engine* _engine{nullptr};
 
private:
    Vector3d _target;
    Vector3d _position;
    Quaterniond _orientation;
 
    Vector3d _initialTarget;
    Vector3d _initialPosition;
    Quaterniond _initialOrientation;
 
    std::string _bufferTarget;
 
    SERIALIZATION_FRIEND(Camera);
};
 
std::ostream& operator<<(std::ostream& os, Camera& camera);
} // namespace core