GRAPHICS: Add support for picking objects

src/graphics/aurora/cube.cpp

@@ -72,7 +72,7 @@ namespace Graphics {
 
 namespace Aurora {
 
-Cube::Cube(const Common::UString &texture) {
+Cube::Cube(const Common::UString &texture) : _entity(0) {
 	Common::UString name = Common::generateIDRandomString();
 
 	try {
@@ -104,16 +104,19 @@ Cube::Cube(const Common::UString &texture) {
 
 		// Create entity, put the requested material on it and attach it to a scene node
 
-		Ogre::Entity *entity = getOgreSceneManager().createEntity(mesh);
+		_entity = getOgreSceneManager().createEntity(mesh);
+		_entity->setQueryFlags(kSelectableNone);
+
+		_entity->getUserObjectBindings().setUserAny("renderable", Ogre::Any((Renderable *) this));
 
 		Ogre::MaterialPtr material = MaterialMan.get(texture);
 
-		entity->setMaterial(material);
+		_entity->setMaterial(material);
 
 		//_rootNode = getOgreSceneManager().createSceneNode(name.c_str());
 		_rootNode = getOgreSceneManager().getRootSceneNode()->createChildSceneNode(name.c_str());
 
-		_rootNode->attachObject(entity);
+		_rootNode->attachObject(_entity);
 		_rootNode->setVisible(false);
 
 		// Create a rotating animations
@@ -177,6 +180,10 @@ void Cube::stopRotate() {
 	getOgreSceneManager().getAnimationState(_rootNode->getName())->setEnabled(false);
 }
 
+void Cube::setSelectable(bool selectable) {
+	_entity->setQueryFlags(selectable ? kSelectableCube : kSelectableNone);
+}
+
 } // End of namespace Aurora
 
 } // End of namespace Graphics

src/graphics/aurora/cube.h

@@ -32,6 +32,10 @@
 
 #include "graphics/aurora/renderable.h"
 
+namespace Ogre {
+	class Entity;
+}
+
 namespace Common {
 	class UString;
 }
@@ -47,6 +51,12 @@ class Cube : public Renderable {
 
 	void startRotate();
 	void stopRotate();
+
+	/** Change whether the cube can be selected (picked) by the user. */
+	void setSelectable(bool selectable);
+
+private:
+	Ogre::Entity *_entity;
 };
 
 } // End of namespace Aurora

src/graphics/aurora/model.cpp

@@ -155,6 +155,11 @@ bool Model::stopAnimation() {
 	return true;
 }
 
+void Model::setSelectable(bool selectable) {
+	for (EntityList::iterator e = _entities.begin(); e != _entities.end(); ++e)
+		(*e)->setQueryFlags(selectable ? kSelectableModel : kSelectableNone);
+}
+
 void Model::showBoundingBox(bool show) {
 	if (_currentState) {
 		for (NodeEntities::iterator n = _currentState->nodeEntities.begin(); n != _currentState->nodeEntities.end(); ++n)

src/graphics/aurora/model.h

@@ -68,6 +68,9 @@ class Model : public Renderable {
 	/** Stop any currently playing animation. */
 	bool stopAnimation();
 
+	/** Change whether the model can be selected (picked) by the user. */
+	void setSelectable(bool selectable);
+
 	/** Show/Hide the bouding box(es) of this model. */
 	void showBoundingBox(bool show);
 

src/graphics/aurora/model_nwn.cpp

@@ -726,6 +726,9 @@ void Model_NWN::readBinaryMesh(ParserContext &ctx) {
 	mesh->load();
 
 	Ogre::Entity *entity = getOgreSceneManager().createEntity(mesh);
+	entity->setQueryFlags(kSelectableNone);
+
+	entity->getUserObjectBindings().setUserAny("renderable", Ogre::Any((Renderable *) this));
 
 	// Assign a material to the entity
 
@@ -1266,6 +1269,9 @@ void Model_NWN::processASCIIMesh(ParserContext &ctx, MeshASCII &mesh) {
 	ogreMesh->load();
 
 	Ogre::Entity *entity = getOgreSceneManager().createEntity(ogreMesh);
+	entity->setQueryFlags(kSelectableNone);
+
+	entity->getUserObjectBindings().setUserAny("renderable", Ogre::Any((Renderable *) this));
 
 	// Assign a material to the entity
 

src/graphics/aurora/renderable.cpp

@@ -72,6 +72,13 @@ bool Renderable::isVisible() const {
 	return _visible;
 }
 
+Common::UString Renderable::getID() const {
+	if (!_rootNode)
+		return "";
+
+	return _rootNode->getName().c_str();
+}
+
 void Renderable::setBasePosition(float x, float y, float z) {
 	_basePosition[0] = x;
 	_basePosition[1] = y;

src/graphics/aurora/renderable.h

@@ -30,15 +30,13 @@
 #ifndef GRAPHICS_AURORA_RENDERABLE_H
 #define GRAPHICS_AURORA_RENDERABLE_H
 
+#include "common/ustring.h"
+
 namespace Ogre {
 	class SceneNode;
 	class Animation;
 }
 
-namespace Common {
-	class UString;
-}
-
 namespace Graphics {
 
 namespace Aurora {
@@ -52,6 +50,8 @@ class Renderable {
 
 	bool isVisible() const;
 
+	Common::UString getID() const;
+
 	virtual void setVisible(bool visible);
 
 	/** Set the base position. All positioning will be done relative to the base position. */
@@ -85,6 +85,9 @@ class Renderable {
 	/** Show/Hide the bouding box(es) of this renderable. */
 	virtual void showBoundingBox(bool show);
 
+	/** Change whether the renderable can be selected (picked) by the user. */
+	virtual void setSelectable(bool selectable) = 0;
+
 protected:
 	Ogre::SceneNode *_rootNode;
 

src/graphics/aurora/sceneman.cpp

@@ -30,6 +30,8 @@
 #include "common/error.h"
 #include "common/threads.h"
 
+#include "graphics/cameraman.h"
+
 #include "graphics/aurora/meshutil.h"
 #include "graphics/aurora/sceneman.h"
 #include "graphics/aurora/renderable.h"
@@ -123,6 +125,41 @@ Model *SceneManager::createModel(const Common::UString &model, const Common::USt
 	return modelInstance;
 }
 
+Renderable *SceneManager::getRenderableAt(int x, int y, SelectableType type, float &distance) {
+	Ogre::SceneManager &scene = getOgreSceneManager();
+
+	const Ogre::Ray mouseRay = CameraMan.castRay(x, y);
+
+	Ogre::RaySceneQuery *query = scene.createRayQuery(mouseRay, (uint32) type);
+	query->setSortByDistance(true);
+
+	Ogre::RaySceneQueryResult &results = query->execute();
+
+	Renderable *renderable = 0;
+	for (Ogre::RaySceneQueryResult::iterator result = results.begin(); result != results.end(); ++result) {
+		// Check that this result has a moveable that contains a visible renderable
+
+		if (!result->movable)
+			continue;
+
+		const Ogre::Any &movableRenderable = result->movable->getUserObjectBindings().getUserAny("renderable");
+		if (movableRenderable.isEmpty())
+			continue;
+
+		Renderable *resultRenderable = Ogre::any_cast<Renderable *>(movableRenderable);
+		if (!resultRenderable->isVisible())
+			continue;
+
+		renderable = resultRenderable;
+		distance   = result->distance;
+		break;
+	}
+
+	scene.destroyQuery(query);
+
+	return renderable;
+}
+
 } // End of namespace Aurora
 
 } // End of namespace Graphics

src/graphics/aurora/sceneman.h

@@ -72,6 +72,9 @@ class SceneManager : public Common::Singleton<SceneManager> {
 	/** Create a complex Aurora model. */
 	Model *createModel(const Common::UString &model, const Common::UString &texture = "");
 
+	/** Return the nearest renderable at these screen coordinates. */
+	Renderable *getRenderableAt(int x, int y, SelectableType type, float &distance);
+
 	// Singleton interface
 	static void destroy();
 

src/graphics/aurora/types.h

@@ -43,6 +43,17 @@ enum ModelType {
 	kModelTypeTheWitcher
 };
 
+/** Type of a selectable renderable. */
+enum SelectableType {
+	kSelectableNone = 0, ///< Nothing.
+
+	kSelectableCube  = 1 << 0, ///< A cube.
+	kSelectableModel = 1 << 1, ///< A model.
+
+	/** All renderable. */
+	kSelectableRenderable = kSelectableCube | kSelectableModel
+};
+
 } // End of namespace Aurora
 
 } // End of namespace Graphics

src/graphics/cameraman.cpp

@@ -38,7 +38,7 @@ DECLARE_SINGLETON(Graphics::CameraManager)
 
 namespace Graphics {
 
-CameraManager::CameraManager() : _camera(0) {
+CameraManager::CameraManager() : _camera(0), _screenWidth(0), _screenHeight(0) {
 }
 
 CameraManager::~CameraManager() {
@@ -72,8 +72,11 @@ Ogre::Viewport *CameraManager::createViewport(Ogre::RenderWindow *window) {
 	return window->addViewport(_camera);
 }
 
-void CameraManager::setAspectRatio(float aspect) {
-	_camera->setAspectRatio(aspect);
+void CameraManager::setScreenSize(int width, int height) {
+	_screenWidth  = width;
+	_screenHeight = height;
+
+	_camera->setAspectRatio(Ogre::Real(width) / Ogre::Real(height));
 }
 
 void CameraManager::reset() {
@@ -98,6 +101,18 @@ void CameraManager::getDirection(float &x, float &y, float &z) const {
 	z = dir.z;
 }
 
+void CameraManager::getOrientation(float &radian, float &x, float &y, float &z) const {
+	Ogre::Radian  angle;
+	Ogre::Vector3 axis;
+
+	_camera->getOrientation().ToAngleAxis(angle, axis);
+
+	radian = angle.valueRadians();
+	x      = axis.x;
+	y      = axis.y;
+	z      = axis.z;
+}
+
 void CameraManager::setPosition(float x, float y, float z) {
 	_camera->setPosition(x, y, z);
 }
@@ -138,4 +153,8 @@ void CameraManager::pitch(float radian) {
 	_camera->pitch(Ogre::Radian(radian));
 }
 
+Ogre::Ray CameraManager::castRay(int x, int y) const {
+	return _camera->getCameraToViewportRay(x / ((float) _screenWidth), y / ((float) _screenHeight));
+}
+
 } // End of namespace Graphics

src/graphics/cameraman.h

@@ -30,6 +30,8 @@
 #ifndef GRAPHICS_CAMERAMAN_H
 #define GRAPHICS_CAMERAMAN_H
 
+#include <OgreRay.h>
+
 #include "common/singleton.h"
 
 namespace Ogre {
@@ -51,21 +53,21 @@ class CameraManager : public Common::Singleton<CameraManager> {
 	/** Create a viewport for the camera in that window. */
 	Ogre::Viewport *createViewport(Ogre::RenderWindow *window);
 	/** Adjust the aspect ratio of the camera. */
-	void setAspectRatio(float aspect);
+	void setScreenSize(int width, int height);
 
 	/** Reset the position and orientation of the camera. */
 	void reset();
 
 	void getPosition(float &x, float &y, float &z) const;
 	void getDirection(float &x, float &y, float &z) const;
+	void getOrientation(float &radian, float &x, float &y, float &z) const;
 
 	void setPosition(float x, float y, float z);
 	void setDirection(float x, float y, float z);
+	void setOrientation(float radian, float x, float y, float z);
 
 	void lookAt(float x, float y, float z);
 
-	void setOrientation(float radian, float x, float y, float z);
-
 	void move(float x, float y, float z);
 	void moveRelative(float x, float y, float z);
 
@@ -75,8 +77,14 @@ class CameraManager : public Common::Singleton<CameraManager> {
 	void yaw(float radian);
 	void pitch(float radian);
 
+	/** Cast a ray from the camera through the viewport at these coordinates into the world. */
+	Ogre::Ray castRay(int x, int y) const;
+
 private:
 	Ogre::Camera *_camera; ///< The OGRE camera.
+
+	int _screenWidth;
+	int _screenHeight;
 };
 
 } // End of namespace Graphics

src/graphics/renderer.cpp

@@ -320,7 +320,7 @@ void Renderer::createScene() {
 
 	_viewPort = CameraMan.createViewport(_renderWindow);
 
-	CameraMan.setAspectRatio(Ogre::Real(_viewPort->getActualWidth()) / Ogre::Real(_viewPort->getActualHeight()));
+	CameraMan.setScreenSize(_viewPort->getActualWidth(), _viewPort->getActualHeight());
 
 	_animator = new OgreAnimator;
 	_root->addFrameListener(_animator);
@@ -349,7 +349,7 @@ bool Renderer::recreate(SDL_Window &screen, bool vsync, int fsaa) {
 	// Reattach camera
 	_viewPort = CameraMan.createViewport(_renderWindow);
 
-	CameraMan.setAspectRatio(Ogre::Real(_viewPort->getActualWidth()) / Ogre::Real(_viewPort->getActualHeight()));
+	CameraMan.setScreenSize(_viewPort->getActualWidth(), _viewPort->getActualHeight());
 
 	return true;
 }
@@ -358,7 +358,7 @@ void Renderer::resized(int width, int height) {
 	_renderWindow->resize(width, height);
 	_renderWindow->windowMovedOrResized();
 
-	CameraMan.setAspectRatio(Ogre::Real(_viewPort->getActualWidth()) / Ogre::Real(_viewPort->getActualHeight()));
+	CameraMan.setScreenSize(_viewPort->getActualWidth(), _viewPort->getActualHeight());
 }
 
 void Renderer::render() {