GRAPHICS: Add Renderable::fade()

This lets a Renderable be fade in or out.

src/graphics/renderable.cpp

@@ -30,13 +30,19 @@
 #include <OgreSceneNode.h>
 #include <OgreAnimation.h>
 #include <OgreSceneManager.h>
+#include <OgreControllerManager.h>
+
+#include "common/threads.h"
 
 #include "graphics/util.h"
 #include "graphics/renderable.h"
+#include "graphics/materialman.h"
+
+#include "events/requests.h"
 
 namespace Graphics {
 
-Renderable::Renderable(const Common::UString &scene) : _scene(scene), _rootNode(0), _visible(false), _selectable(false) {
+Renderable::Renderable(const Common::UString &scene) : _scene(scene), _rootNode(0), _visible(false), _selectable(false), _fader(0) {
 	_basePosition[0] = 0.0;
 	_basePosition[1] = 0.0;
 	_basePosition[2] = 0.0;
@@ -52,6 +58,58 @@ Renderable::Renderable(const Common::UString &scene) : _scene(scene), _rootNode(
 }
 
 Renderable::~Renderable() {
+	destroy();
+}
+
+void Renderable::destroy() {
+	if (!Common::isMainThread()) {
+		Events::MainThreadFunctor<void> functor(boost::bind(&Renderable::destroy, this));
+
+		return RequestMan.callInMainThread(functor);
+	}
+
+	if (_fader)
+		Ogre::ControllerManager::getSingleton().destroyController(_fader);
+	_fader = 0;
+}
+
+void Renderable::fade(FadeDirection direction, float length, bool loop) {
+	LOCK_FRAME();
+
+	Ogre::ControllerManager &controllerMan = Ogre::ControllerManager::getSingleton();
+
+	if (_fader)
+		controllerMan.destroyController(_fader);
+	_fader = 0;
+
+	std::list<Ogre::MaterialPtr> materials;
+	collectMaterials(materials, true, true);
+
+	for (std::list<Ogre::MaterialPtr>::iterator m = materials.begin(); m != materials.end(); ++m)
+		MaterialMan.setTransparent(*m, true);
+
+	Ogre::SharedPtr< Ogre::ControllerValue   <Ogre::Real> > matVal(new MaterialAlphaControllerValue(materials));
+	Ogre::SharedPtr< Ogre::ControllerFunction<Ogre::Real> > animFunc(new AnimationControllerFunction(length, 0.0, (AnimationFunction) direction, loop));
+
+	_fader = controllerMan.createController(controllerMan.getFrameTimeSource(), matVal, animFunc);
+}
+
+void Renderable::stopFade() {
+	LOCK_FRAME();
+
+	if (_fader) {
+		Ogre::ControllerManager::getSingleton().destroyController(_fader);
+
+		std::list<Ogre::MaterialPtr> materials;
+		collectMaterials(materials);
+
+		for (std::list<Ogre::MaterialPtr>::iterator m = materials.begin(); m != materials.end(); ++m) {
+			MaterialMan.setAlphaModifier(*m, 1.0);
+			MaterialMan.resetTransparent(*m);
+		}
+	}
+
+	_fader = 0;
 }
 
 Ogre::SceneNode *Renderable::getRootNode() {

src/graphics/renderable.h

@@ -36,13 +36,22 @@
 
 #include "common/ustring.h"
 
+#include "graphics/controllers.h"
+
 namespace Ogre {
 	class SceneNode;
 	class Animation;
 }
 
 namespace Graphics {
 
+enum FadeDirection {
+	kFadeDirectionIn    = kAnimationFunctionIncrease        , ///< Fade in.
+	kFadeDirectionOut   = kAnimationFunctionDecrease        , ///< Fade out.
+	kFadeDirectionInOut = kAnimationFunctionIncreaseDecrease, ///< Fade in, then out again.
+	kFadeDirectionOutIn = kAnimationFunctionDecreaseIncrease  ///< Fade out, then in again.
+};
+
 class Renderable {
 public:
 	Renderable(const Common::UString &scene = "world");
@@ -90,6 +99,11 @@ class Renderable {
 	/** Change whether the renderable can be selected (picked) by the user. */
 	virtual void setSelectable(bool selectable);
 
+	/** Fade the renderable. */
+	void fade(FadeDirection direction, float length, bool loop);
+	/** Stop all fading. */
+	void stopFade();
+
 protected:
 	Common::UString _scene;
 
@@ -102,12 +116,17 @@ class Renderable {
 	float _baseOrientation[4];
 	float _baseScale[3];
 
+	Ogre::Controller<Ogre::Real> *_fader;
+
 
 	void destroyAnimation(const Common::UString &name);
 	void destroyAnimation(Ogre::Animation *anim);
 
 	/** Collect all materials used in the renderable, optionally making them dynamic and/or transparent as well. */
 	virtual void collectMaterials(std::list<Ogre::MaterialPtr> &materials, bool makeDynamic = false, bool makeTransparent = false) = 0;
+
+private:
+	void destroy();
 };
 
 } // End of namespace Graphics

src/graphics/renderer.cpp

@@ -95,6 +95,8 @@ class OgreAnimator : public Ogre::FrameListener {
 		for (Ogre::AnimationStateIterator anims = getOgreSceneManager().getAnimationStateIterator(); anims.hasMoreElements(); anims.moveNext())
 			anims.current()->second->addTime(event.timeSinceLastFrame);
 
+		Ogre::ControllerManager::getSingleton().updateAllControllers();
+
 		return true;
 	}