Browse Source

SceneGraph: AbstractCamera, Camera2D, Camera3D are now in separate files.

pull/7/head
Vladimír Vondruš 14 years ago
parent
commit
767c9d6166
  1. 133
      src/SceneGraph/AbstractCamera.h
  2. 55
      src/SceneGraph/AbstractCamera.hpp
  3. 8
      src/SceneGraph/CMakeLists.txt
  4. 5
      src/SceneGraph/Camera.cpp
  5. 73
      src/SceneGraph/Camera2D.h
  6. 39
      src/SceneGraph/Camera2D.hpp
  7. 100
      src/SceneGraph/Camera3D.h
  8. 67
      src/SceneGraph/Camera3D.hpp
  9. 6
      src/SceneGraph/Test/CameraTest.cpp

133
src/SceneGraph/Camera.h → src/SceneGraph/AbstractCamera.h

@ -1,5 +1,5 @@
#ifndef Magnum_SceneGraph_Camera_h #ifndef Magnum_SceneGraph_AbstractCamera_h
#define Magnum_SceneGraph_Camera_h #define Magnum_SceneGraph_AbstractCamera_h
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
@ -16,7 +16,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::SceneGraph::AbstractCamera, Magnum::SceneGraph::Camera2D, Magnum::SceneGraph::Camera3D, enum AspectRatioPolicy, alias Magnum::SceneGraph::AbstractCamera2D, Magnum::SceneGraph::AbstractCamera3D * @brief Class Magnum::SceneGraph::AbstractCamera, enum AspectRatioPolicy, alias Magnum::SceneGraph::AbstractCamera2D, Magnum::SceneGraph::AbstractCamera3D
*/ */
#include "Math/Matrix3.h" #include "Math/Matrix3.h"
@ -25,11 +25,6 @@
#include "magnumSceneGraphVisibility.h" #include "magnumSceneGraphVisibility.h"
#ifdef WIN32 /* I so HATE windows.h */
#undef near
#undef far
#endif
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {
template<std::uint8_t, class> class Drawable; template<std::uint8_t, class> class Drawable;
@ -66,14 +61,16 @@ instantiatable, use Camera2D or Camera3D subclasses instead.
@section AbstractCamera-explicit-specializations Explicit template specializations @section AbstractCamera-explicit-specializations Explicit template specializations
The following specialization are explicitly compiled into SceneGraph library. The following specialization are explicitly compiled into SceneGraph library.
For other specializations you have to use Camera.hpp implementation file to For other specializations you have to use AbstractCamera.hpp implementation
avoid linker errors. See @ref compilation-speedup-hpp for more information. file to avoid linker errors. See also relevant sections in
@ref Camera2D-explicit-specializations "Camera2D" and
@ref Camera3D-explicit-specializations "Camera3D" class documentation or
@ref compilation-speedup-hpp for more information.
- @ref AbstractCamera "AbstractCamera<2>" - @ref AbstractCamera "AbstractCamera<2>"
- @ref AbstractCamera "AbstractCamera<3>" - @ref AbstractCamera "AbstractCamera<3>"
@see Camera2D, Camera3D, Drawable, DrawableGroup, AbstractCamera2D, @see Drawable, DrawableGroup, AbstractCamera2D, AbstractCamera3D
AbstractCamera3D
*/ */
template<std::uint8_t dimensions, class T = GLfloat> class SCENEGRAPH_EXPORT AbstractCamera: public AbstractFeature<dimensions, T> { template<std::uint8_t dimensions, class T = GLfloat> class SCENEGRAPH_EXPORT AbstractCamera: public AbstractFeature<dimensions, T> {
public: public:
@ -203,118 +200,6 @@ template<class T = GLfloat> using AbstractCamera3D = AbstractCamera<3, T>;
typedef AbstractCamera<3, T = GLfloat> AbstractCamera3D; typedef AbstractCamera<3, T = GLfloat> AbstractCamera3D;
#endif #endif
/**
@brief Camera for two-dimensional scenes
See Drawable documentation for more information.
@section Object-explicit-specializations Explicit template specializations
The following specialization are explicitly compiled into SceneGraph library.
For other specializations you have to use Camera.hpp implementation file to
avoid linker errors. See @ref compilation-speedup-hpp for more information.
- @ref Camera2D "Camera2D<GLfloat>"
@see Camera3D, Drawable, DrawableGroup
*/
template<class T = GLfloat> class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<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 setOrthographic()
*/
inline Camera2D(AbstractObject<2, T>* object): AbstractCamera<2, T>(object) {}
/**
* @brief Set projection
* @param size Size of the view
* @return Pointer to self (for method chaining)
*
* The area of given size will be scaled down to range @f$ [-1; 1] @f$
* on all directions.
*/
Camera2D<T>* setProjection(const Math::Vector2<T>& size);
/* Overloads to remove WTF-factor from method chaining order */
#ifndef DOXYGEN_GENERATING_OUTPUT
inline Camera2D<T>* setAspectRatioPolicy(AspectRatioPolicy policy) {
AbstractCamera<2, T>::setAspectRatioPolicy(policy);
return this;
}
#endif
};
/**
@brief Camera for three-dimensional scenes
See Drawable documentation for more information.
@section Object-explicit-specializations Explicit template specializations
The following specialization are explicitly compiled into SceneGraph library.
For other specializations you have to use Camera.hpp implementation file to
avoid linker errors. See @ref compilation-speedup-hpp for more information.
- @ref Camera3D "Camera3D<GLfloat>"
@see Camera2D, Drawable, DrawableGroup
*/
template<class T = GLfloat> class SCENEGRAPH_EXPORT Camera3D: public AbstractCamera<3, 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 setOrthographic(), setPerspective()
*/
inline Camera3D(AbstractObject<3, T>* object): AbstractCamera<3, T>(object), _near(0.0f), _far(0.0f) {}
/**
* @brief Set orthographic projection
* @param size Size of the view
* @param near Near clipping plane
* @param far Far clipping plane
* @return Pointer to self (for method chaining)
*
* The volume of given size will be scaled down to range @f$ [-1; 1] @f$
* on all directions.
*/
Camera3D<T>* setOrthographic(const Math::Vector2<T>& size, T near, T far);
/**
* @brief Set perspective projection
* @param fov Field of view angle
* @param near Near clipping plane
* @param far Far clipping plane
* @return Pointer to self (for method chaining)
*
* @todo Aspect ratio
*/
Camera3D<T>* setPerspective(T fov, T near, T far);
/** @brief Near clipping plane */
inline T near() const { return _near; }
/** @brief Far clipping plane */
inline T far() const { return _far; }
/* Overloads to remove WTF-factor from method chaining order */
#ifndef DOXYGEN_GENERATING_OUTPUT
inline Camera3D<T>* setAspectRatioPolicy(AspectRatioPolicy policy) {
AbstractCamera<3, T>::setAspectRatioPolicy(policy);
return this;
}
#endif
private:
T _near, _far;
};
/* Make implementers' life easier */ /* Make implementers' life easier */
#ifndef MAGNUM_GCC46_COMPATIBILITY #ifndef MAGNUM_GCC46_COMPATIBILITY
template<class T = GLfloat> using DrawableGroup2D = DrawableGroup<2, T>; template<class T = GLfloat> using DrawableGroup2D = DrawableGroup<2, T>;

55
src/SceneGraph/Camera.hpp → src/SceneGraph/AbstractCamera.hpp

@ -1,5 +1,5 @@
#ifndef Magnum_SceneGraph_Camera_hpp #ifndef Magnum_SceneGraph_AbstractCamera_hpp
#define Magnum_SceneGraph_Camera_hpp #define Magnum_SceneGraph_AbstractCamera_hpp
/* /*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
@ -16,15 +16,12 @@
*/ */
/** @file /** @file
* @brief @ref compilation-speedup-hpp "Template implementation" for Camera.h * @brief @ref compilation-speedup-hpp "Template implementation" for AbstractCamera.h
*/ */
#include "Camera.h" #include "AbstractCamera.h"
#include <algorithm>
#include "Drawable.h" #include "Drawable.h"
#include "Scene.h"
using namespace std; using namespace std;
@ -96,50 +93,6 @@ template<std::uint8_t dimensions, class T> void AbstractCamera<dimensions, T>::d
group[i]->draw(transformations[i], this); group[i]->draw(transformations[i], this);
} }
template<class T> Camera2D<T>* Camera2D<T>::setProjection(const Math::Vector2<T>& size) {
/* Scale the volume down so it fits in (-1, 1) in all directions */
AbstractCamera<2, T>::rawProjectionMatrix = Math::Matrix3<T>::scaling(2.0f/size);
AbstractCamera<2, T>::fixAspectRatio();
return this;
}
template<class T> Camera3D<T>* Camera3D<T>::setOrthographic(const Math::Vector2<T>& size, T near, T far) {
_near = near;
_far = far;
Math::Vector2<T> xyScale = T(2.0)/size;
T zScale = T(2.0)/(near-far);
AbstractCamera<3, T>::rawProjectionMatrix = Math::Matrix4<T>(
xyScale.x(), T(0.0), T(0.0), T(0.0),
T(0.0), xyScale.y(), T(0.0), T(0.0),
T(0.0), T(0.0), zScale, T(0.0),
T(0.0), T(0.0), near*zScale-1, T(1.0)
);
AbstractCamera<3, T>::fixAspectRatio();
return this;
}
template<class T> Camera3D<T>* Camera3D<T>::setPerspective(T fov, T near, T far) {
_near = near;
_far = far;
T xyScale = T(1.0)/tan(fov/2); /* == near/size */
T zScale = T(1.0)/(near-far);
AbstractCamera<3, T>::rawProjectionMatrix = Matrix4(
xyScale, T(0.0), T(0.0), T(0.0),
T(0.0), xyScale, T(0.0), T(0.0),
T(0.0), T(0.0), (far+near)*zScale, T(-1.0),
T(0.0), T(0.0), (2*far*near)*zScale, T(0.0)
);
AbstractCamera<3, T>::fixAspectRatio();
return this;
}
}} }}
#endif #endif

8
src/SceneGraph/CMakeLists.txt

@ -1,6 +1,8 @@
set(MagnumSceneGraph_SRCS set(MagnumSceneGraph_SRCS
Camera.cpp) Camera.cpp)
set(MagnumSceneGraph_HEADERS set(MagnumSceneGraph_HEADERS
AbstractCamera.h
AbstractCamera.hpp
AbstractFeature.h AbstractFeature.h
AbstractGroupedFeature.h AbstractGroupedFeature.h
AbstractObject.h AbstractObject.h
@ -9,8 +11,10 @@ set(MagnumSceneGraph_HEADERS
AbstractTranslationRotation3D.h AbstractTranslationRotation3D.h
AbstractTranslationRotationScaling2D.h AbstractTranslationRotationScaling2D.h
AbstractTranslationRotationScaling3D.h AbstractTranslationRotationScaling3D.h
Camera.h Camera2D.h
Camera.hpp Camera2D.hpp
Camera3D.h
Camera3D.hpp
Drawable.h Drawable.h
MatrixTransformation2D.h MatrixTransformation2D.h
MatrixTransformation3D.h MatrixTransformation3D.h

5
src/SceneGraph/Camera.cpp

@ -13,9 +13,8 @@
GNU Lesser General Public License version 3 for more details. GNU Lesser General Public License version 3 for more details.
*/ */
#include "Camera.h" #include "Camera2D.hpp"
#include "Camera3D.hpp"
#include "Camera.hpp"
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {

73
src/SceneGraph/Camera2D.h

@ -0,0 +1,73 @@
#ifndef Magnum_SceneGraph_Camera2D_h
#define Magnum_SceneGraph_Camera2D_h
/*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
This file is part of Magnum.
Magnum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3
only, as published by the Free Software Foundation.
Magnum 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 Lesser General Public License version 3 for more details.
*/
/** @file
* @brief Class Magnum::SceneGraph::Camera2D
*/
#include "AbstractCamera.h"
namespace Magnum { namespace SceneGraph {
/**
@brief Camera for two-dimensional scenes
See Drawable documentation for more information.
@section Camera2D-explicit-specializations Explicit template specializations
The following specialization are explicitly compiled into SceneGraph library.
For other specializations you have to use Camera2D.hpp implementation file to
avoid linker errors. See @ref compilation-speedup-hpp for more information.
- @ref Camera2D "Camera2D<GLfloat>"
@see Camera3D, Drawable, DrawableGroup
*/
template<class T = GLfloat> class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<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 setOrthographic()
*/
inline Camera2D(AbstractObject<2, T>* object): AbstractCamera<2, T>(object) {}
/**
* @brief Set projection
* @param size Size of the view
* @return Pointer to self (for method chaining)
*
* The area of given size will be scaled down to range @f$ [-1; 1] @f$
* on all directions.
*/
Camera2D<T>* setProjection(const Math::Vector2<T>& size);
/* Overloads to remove WTF-factor from method chaining order */
#ifndef DOXYGEN_GENERATING_OUTPUT
inline Camera2D<T>* setAspectRatioPolicy(AspectRatioPolicy policy) {
AbstractCamera<2, T>::setAspectRatioPolicy(policy);
return this;
}
#endif
};
}}
#endif

39
src/SceneGraph/Camera2D.hpp

@ -0,0 +1,39 @@
#ifndef Magnum_SceneGraph_Camera2D_hpp
#define Magnum_SceneGraph_Camera2D_hpp
/*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
This file is part of Magnum.
Magnum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3
only, as published by the Free Software Foundation.
Magnum 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 Lesser General Public License version 3 for more details.
*/
/** @file
* @brief @ref compilation-speedup-hpp "Template implementation" for Camera2D.h
*/
#include "AbstractCamera.hpp"
#include "Camera2D.h"
using namespace std;
namespace Magnum { namespace SceneGraph {
template<class T> Camera2D<T>* Camera2D<T>::setProjection(const Math::Vector2<T>& size) {
/* Scale the volume down so it fits in (-1, 1) in all directions */
AbstractCamera<2, T>::rawProjectionMatrix = Math::Matrix3<T>::scaling(2.0f/size);
AbstractCamera<2, T>::fixAspectRatio();
return this;
}
}}
#endif

100
src/SceneGraph/Camera3D.h

@ -0,0 +1,100 @@
#ifndef Magnum_SceneGraph_Camera3D_h
#define Magnum_SceneGraph_Camera3D_h
/*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
This file is part of Magnum.
Magnum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3
only, as published by the Free Software Foundation.
Magnum 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 Lesser General Public License version 3 for more details.
*/
/** @file
* @brief Class Magnum::SceneGraph::Camera3D
*/
#include "AbstractCamera.h"
#ifdef WIN32 /* I so HATE windows.h */
#undef near
#undef far
#endif
namespace Magnum { namespace SceneGraph {
/**
@brief Camera for three-dimensional scenes
See Drawable documentation for more information.
@section Camera3D-explicit-specializations Explicit template specializations
The following specialization are explicitly compiled into SceneGraph library.
For other specializations you have to use Camera3D.hpp implementation file to
avoid linker errors. See @ref compilation-speedup-hpp for more information.
- @ref Camera3D "Camera3D<GLfloat>"
@see Camera2D, Drawable, DrawableGroup
*/
template<class T = GLfloat> class SCENEGRAPH_EXPORT Camera3D: public AbstractCamera<3, 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 setOrthographic(), setPerspective()
*/
inline Camera3D(AbstractObject<3, T>* object): AbstractCamera<3, T>(object), _near(0.0f), _far(0.0f) {}
/**
* @brief Set orthographic projection
* @param size Size of the view
* @param near Near clipping plane
* @param far Far clipping plane
* @return Pointer to self (for method chaining)
*
* The volume of given size will be scaled down to range @f$ [-1; 1] @f$
* on all directions.
*/
Camera3D<T>* setOrthographic(const Math::Vector2<T>& size, T near, T far);
/**
* @brief Set perspective projection
* @param fov Field of view angle
* @param near Near clipping plane
* @param far Far clipping plane
* @return Pointer to self (for method chaining)
*
* @todo Aspect ratio
*/
Camera3D<T>* setPerspective(T fov, T near, T far);
/** @brief Near clipping plane */
inline T near() const { return _near; }
/** @brief Far clipping plane */
inline T far() const { return _far; }
/* Overloads to remove WTF-factor from method chaining order */
#ifndef DOXYGEN_GENERATING_OUTPUT
inline Camera3D<T>* setAspectRatioPolicy(AspectRatioPolicy policy) {
AbstractCamera<3, T>::setAspectRatioPolicy(policy);
return this;
}
#endif
private:
T _near, _far;
};
}}
#endif

67
src/SceneGraph/Camera3D.hpp

@ -0,0 +1,67 @@
#ifndef Magnum_SceneGraph_Camera3D_hpp
#define Magnum_SceneGraph_Camera3D_hpp
/*
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz>
This file is part of Magnum.
Magnum is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3
only, as published by the Free Software Foundation.
Magnum 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 Lesser General Public License version 3 for more details.
*/
/** @file
* @brief @ref compilation-speedup-hpp "Template implementation" for Camera3D.h
*/
#include "AbstractCamera.hpp"
#include "Camera3D.h"
using namespace std;
namespace Magnum { namespace SceneGraph {
template<class T> Camera3D<T>* Camera3D<T>::setOrthographic(const Math::Vector2<T>& size, T near, T far) {
_near = near;
_far = far;
Math::Vector2<T> xyScale = T(2.0)/size;
T zScale = T(2.0)/(near-far);
AbstractCamera<3, T>::rawProjectionMatrix = Math::Matrix4<T>(
xyScale.x(), T(0.0), T(0.0), T(0.0),
T(0.0), xyScale.y(), T(0.0), T(0.0),
T(0.0), T(0.0), zScale, T(0.0),
T(0.0), T(0.0), near*zScale-1, T(1.0)
);
AbstractCamera<3, T>::fixAspectRatio();
return this;
}
template<class T> Camera3D<T>* Camera3D<T>::setPerspective(T fov, T near, T far) {
_near = near;
_far = far;
T xyScale = T(1.0)/tan(fov/2); /* == near/size */
T zScale = T(1.0)/(near-far);
AbstractCamera<3, T>::rawProjectionMatrix = Matrix4(
xyScale, T(0.0), T(0.0), T(0.0),
T(0.0), xyScale, T(0.0), T(0.0),
T(0.0), T(0.0), (far+near)*zScale, T(-1.0),
T(0.0), T(0.0), (2*far*near)*zScale, T(0.0)
);
AbstractCamera<3, T>::fixAspectRatio();
return this;
}
}}
#endif

6
src/SceneGraph/Test/CameraTest.cpp

@ -16,11 +16,13 @@
#include "CameraTest.h" #include "CameraTest.h"
#include "Math/Constants.h" #include "Math/Constants.h"
#include "SceneGraph/Camera.h" #include "SceneGraph/AbstractCamera.hpp" /* only for aspectRatioFix(), so it doesn't have to be exported */
#include "SceneGraph/Camera.hpp" /* only for aspectRatioFix(), so it doesn't have to be exported */ #include "SceneGraph/Camera2D.h"
#include "SceneGraph/Camera3D.h"
#include "SceneGraph/Drawable.h" #include "SceneGraph/Drawable.h"
#include "SceneGraph/MatrixTransformation2D.h" #include "SceneGraph/MatrixTransformation2D.h"
#include "SceneGraph/MatrixTransformation3D.h" #include "SceneGraph/MatrixTransformation3D.h"
#include "SceneGraph/Scene.h"
CORRADE_TEST_MAIN(Magnum::SceneGraph::Test::CameraTest) CORRADE_TEST_MAIN(Magnum::SceneGraph::Test::CameraTest)

Loading…
Cancel
Save