fisheye.h

Go to the documentation of this file.

/*****************************************************************************************
 * SGCT                                                                                  *
 * Simple Graphics Cluster Toolkit                                                       *
 *                                                                                       *
 * Copyright (c) 2012-2026                                                               *
 * For conditions of distribution and use, see copyright notice in LICENSE.md            *
 ****************************************************************************************/
 
#ifndef __SGCT__FISHEYE__H__
#define __SGCT__FISHEYE__H__
 
#include <sgct/sgctexports.h>
#include <sgct/projection/nonlinearprojection.h>
 
#include <sgct/shaderprogram.h>
#include <sgct/math.h>
 
namespace sgct {
 
namespace config { struct FisheyeProjection; }
class BaseViewport;
class User;
class Window;

class SGCT_EXPORT FisheyeProjection final : public NonLinearProjection {
public:
    enum class FisheyeMethod { FourFaceCube = 0, FiveFaceCube, SixFaceCube };
 
    FisheyeProjection(const config::FisheyeProjection& config, const Window& parent,
        User& user);
    ~FisheyeProjection() final;

    void update(const vec2& size) const override;

    void render(const BaseViewport& viewport, FrustumMode frustumMode) const override;

    void renderCubemap(FrustumMode frustumMode) const override;

    void setDomeDiameter(float diameter);

    void setTilt(float angle);

    void setFOV(float angle);

    void setCropFactors(float left, float right, float bottom, float top);

    void setOffset(vec3 offset) const;

    void setBaseOffset(vec3 offset);

    void setIgnoreAspectRatio(bool state);
 
    void setKeepAspectRatio(bool state);
 
private:
    void initVBO() override;
    void initViewports() override;
    void initShaders() override;
 
    float _fov;
    float _tilt;
    float _diameter;
    float _cropLeft;
    float _cropRight;
    float _cropBottom;
    float _cropTop;
 
    bool _ignoreAspectRatio = false;
    bool _keepAspectRatio;
 
    mutable bool _isOffAxis = false;
    mutable vec3 _offset = vec3{ 0.f, 0.f, 0.f };
    vec3 _baseOffset = vec3{ 0.f, 0.f, 0.f };
    mutable vec3 _totalOffset = vec3{ 0.f, 0.f, 0.f };
 
    FisheyeMethod _method = FisheyeMethod::FourFaceCube;
 
    // shader locations
    struct {
        int cubemap = -1;
        int depthCubemap = -1;
        int normalCubemap = -1;
        int positionCubemap = -1;
        int halfFov = -1;
        int offset = -1;
        int swapColor = -1;
        int swapDepth = -1;
        int swapNear = -1;
        int swapFar = -1;
    } _shaderLoc;
    unsigned int _vao = 0;
    unsigned int _vbo = 0;
    ShaderProgram _shader;
    ShaderProgram _depthCorrectionShader;
};
 
} // namespace sgct
 
#endif // __SGCT__FISHEYE__H__