mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
96 lines
3.5 KiB
96 lines
3.5 KiB
#ifndef Magnum_SceneGraph_BasicCamera2D_h |
|
#define Magnum_SceneGraph_BasicCamera2D_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
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. |
|
*/ |
|
|
|
/** @file |
|
* @brief Class Magnum::SceneGraph::BasicCamera2D, typedef Magnum::SceneGraph::Camera2D |
|
*/ |
|
|
|
#include "AbstractCamera.h" |
|
|
|
namespace Magnum { namespace SceneGraph { |
|
|
|
/** |
|
@brief Camera for two-dimensional scenes |
|
|
|
See Drawable documentation for introduction. The camera by default displays |
|
OpenGL unit cube `[(-1, -1, -1); (1, 1, 1)]` and doesn't do any aspect ratio |
|
correction. Common setup example: |
|
@code |
|
SceneGraph::BasicCamera2D* camera = new SceneGraph::BasicCamera2D(&cameraObject); |
|
camera->setProjection({4.0f/3.0f, 1.0f}) |
|
->setAspectRatioPolicy(SceneGraph::AspectRatioPolicy::Extend); |
|
@endcode |
|
|
|
@section Camera2D-explicit-specializations Explicit template specializations |
|
|
|
The following specialization are explicitly compiled into SceneGraph library. |
|
For other specializations (e.g. using Double type) you have to use |
|
BasicCamera2D.hpp implementation file to avoid linker errors. See |
|
@ref compilation-speedup-hpp for more information. |
|
|
|
- @ref BasicCamera2D "BasicCamera2D<Float>" |
|
|
|
@see @ref Camera2D, @ref scenegraph, @ref BasicCamera3D, @ref BasicDrawable, @ref BasicDrawableGroup |
|
*/ |
|
template<class T> class MAGNUM_SCENEGRAPH_EXPORT BasicCamera2D: public AbstractBasicCamera<2, T> { |
|
public: |
|
/** |
|
* @brief Constructor |
|
* @param object %Object holding this feature |
|
* |
|
* Sets orthographic projection to the default OpenGL cube (range @f$ [-1; 1] @f$ in all directions). |
|
* @see setProjection() |
|
*/ |
|
explicit BasicCamera2D(AbstractObject<2, T>* object); |
|
|
|
/** |
|
* @brief Set projection |
|
* @param size Size of the view |
|
* @return Pointer to self (for method chaining) |
|
* |
|
* @see Matrix3::projection() |
|
*/ |
|
BasicCamera2D<T>* setProjection(const Math::Vector2<T>& size); |
|
|
|
/* Overloads to remove WTF-factor from method chaining order */ |
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
BasicCamera2D<T>* setAspectRatioPolicy(AspectRatioPolicy policy) { |
|
AbstractBasicCamera<2, T>::setAspectRatioPolicy(policy); |
|
return this; |
|
} |
|
#endif |
|
}; |
|
|
|
/** |
|
@brief Camera for two-dimensional float scenes |
|
|
|
@see @ref Camera3D |
|
*/ |
|
typedef BasicCamera2D<Float> Camera2D; |
|
|
|
}} |
|
|
|
#endif
|
|
|