CUOrthographicCamera.h

//
//  CUOrthographicCamera.h
//  Cornell University Game Library (CUGL)
//
//  This module provides an Orthographic camera class. As cugl's primary support
//  is for 2d (mobile) gameplay it is our primary camera class.
//
//  This module is based on the original file OrthographicCamera.java by
//  Mario Zechner, written for LibGDX ( https://libgdx.badlogicgames.com ). It
//  has been modified to support the CUGL framework.
//
//  This class uses our standard shared-pointer architecture.
//
//  1. The constructor does not perform any initialization; it just sets all
//     attributes to their defaults.
//
//  2. All initialization takes place via init methods, which can fail if an
//     object is initialized more than once.
//
//  3. All allocation takes place via static constructors which return a shared
//     pointer.
//
//  CUGL zlib License:
//      This software is provided 'as-is', without any express or implied
//      warranty.  In no event will the authors be held liable for any damages
//      arising from the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose,
//      including commercial applications, and to alter it and redistribute it
//      freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; you must not
//      claim that you wrote the original software. If you use this software
//      in a product, an acknowledgment in the product documentation would be
//      appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, and must not
//      be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//  Author: Walker White
//  Version: 6/24/16

#ifndef __CU_ORTHOGRAPHIC_CAMERA_H__
#define __CU_ORTHOGRAPHIC_CAMERA_H__

#include "CUCamera.h"

namespace cugl {
    
class OrthographicCamera : public Camera {
#pragma mark Values
protected:
    float _zoom;

    bool _initialized;
    
#pragma mark -
#pragma mark Constructors
public:
    OrthographicCamera() : Camera() {
        _zoom = 1; _near = 0; _initialized = false;
    }
    
    ~OrthographicCamera() { dispose(); }
    
    void dispose() override;
    
    bool init(const Size& size, bool yDown=false) {
        return initOffset(0,0,size.width,size.height,yDown);
    }

    bool init(float width, float height, bool yDown=false) {
        return initOffset(0,0,width,height,yDown);
    }

    bool initOffset(const Rect& rect, bool yDown=false) {
        return initOffset(rect.origin.x,rect.origin.y,rect.size.width,rect.size.height,yDown);
    }

    bool initOffset(const Vec2& origin, const Size& size, bool yDown=false) {
        return initOffset(origin.x,origin.y,size.width,size.height,yDown);
    }

    bool initOffset(float x, float y, float width, float height, bool yDown=false);
    
#pragma mark -
#pragma mark Static Constructors

    static std::shared_ptr<OrthographicCamera> alloc(const Size& size, bool yDown=false) {
        std::shared_ptr<OrthographicCamera> result = std::make_shared<OrthographicCamera>();
        return(result->init(size,yDown) ? result : nullptr);
    }
    
    static std::shared_ptr<OrthographicCamera> alloc(float width, float height, bool yDown=false) {
        std::shared_ptr<OrthographicCamera> result = std::make_shared<OrthographicCamera>();
        return (result->init(width,height,yDown) ? result : nullptr);
    }
    
    static std::shared_ptr<OrthographicCamera> allocOffset(const Rect& rect, bool yDown=false) {
        std::shared_ptr<OrthographicCamera> result = std::make_shared<OrthographicCamera>();
        return (result->initOffset(rect,yDown) ? result : nullptr);
    }
    
    static std::shared_ptr<OrthographicCamera> allocOffset(const Vec2& origin, const Size& size,
                                                           bool yDown=false) {
        std::shared_ptr<OrthographicCamera> result = std::make_shared<OrthographicCamera>();
        return (result->initOffset(origin,size,yDown) ? result : nullptr);
    }
    
    static std::shared_ptr<OrthographicCamera> allocOffset(float x, float y, float width, float height,
                                                           bool yDown=false) {
        std::shared_ptr<OrthographicCamera> result = std::make_shared<OrthographicCamera>();
        return (result->initOffset(x,y,width,height,yDown) ? result : nullptr);
    }
    
#pragma mark -
#pragma mark Setters

    void set(const Size& size, bool yDown=false) {
        set(0,0,size.width,size.height,yDown);
    }
    
    void set(float width, float height, bool yDown=false) {
        set(0,0,width,height,yDown);
    }
    
    void set(const Rect& rect, bool yDown=false) {
        set(rect.origin.x,rect.origin.y,rect.size.width,rect.size.height,yDown);
    }
    
    void set(const Vec2& origin, const Size& size, bool yDown=false) {
        set(origin.x,origin.y,size.width,size.height,yDown);
    }
    
    void set(float x, float y, float width, float height, bool yDown=false);

    void update() override;
    
    
#pragma mark -
#pragma mark Attributes

    float getZoom() const { return _zoom; }

    void setZoom(float zoom);
    
};
    
}

#endif /* __CU_ORTHOGRAPHIC_CAMERA_H__ */