Camera.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_CAMERA_H
#define RAMSES_CAMERA_H
 
#include "ramses-client-api/Node.h"
 
namespace ramses
{
    class DataVector2i;
    class DataVector2f;
    class DataVector4f;
 
    class RAMSES_API Camera : public Node
    {
    public:
        status_t setFrustum(float leftPlane, float rightPlane, float bottomPlane, float topPlane, float nearPlane, float farPlane);
 
        status_t setViewport(int32_t x, int32_t y, uint32_t width, uint32_t height);
 
        int32_t getViewportX() const;
 
        int32_t getViewportY() const;
 
        uint32_t getViewportWidth() const;
 
        uint32_t getViewportHeight() const;
 
        float getLeftPlane() const;
 
        float getRightPlane() const;
 
        float getBottomPlane() const;
 
        float getTopPlane() const;
 
        float getNearPlane() const;
 
        float getFarPlane() const;
 
        status_t getProjectionMatrix(float (&projectionMatrix)[16]) const;
 
        status_t bindViewportOffset(const DataVector2i& offsetData);
 
        status_t bindViewportSize(const DataVector2i& sizeData);
 
        status_t bindFrustumPlanes(const DataVector4f& frustumPlanesData, const DataVector2f& nearFarPlanesData);
 
        status_t unbindViewportOffset();
 
        status_t unbindViewportSize();
 
        status_t unbindFrustumPlanes();
 
        bool isViewportOffsetBound() const;
 
        bool isViewportSizeBound() const;
 
        bool isFrustumPlanesBound() const;
 
        class CameraNodeImpl& impl;
 
    protected:
        friend class SceneImpl;
 
        explicit Camera(CameraNodeImpl& pimpl);
 
        virtual ~Camera();
    };
}
 
#endif