X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Feffects%2Feffect.h;h=a77cdb5abae46023305c605b1dd7966203c07126;hp=0d794a3a2d9b6b264b17e880cf0a02c95d8218d7;hb=HEAD;hpb=84e0e55710123e54617d342df852007f8b60af24

diff --git a/source/effects/effect.h b/source/effects/effect.h
index 0d794a3a..a77cdb5a 100644
--- a/source/effects/effect.h
+++ b/source/effects/effect.h
@@ -9,13 +9,23 @@ namespace Msp {
 namespace GL {
 
 /**
-Effects are used to wrap other renderables and give them additional visual
-properties.  An Effect's render method should set up the necessary state, call
-the wrapped Renderable's render method, and clean up after itself.
+Base class for visual effects.
+
+Effects wrap other renderables and provide additional textures or uniform
+values which can be used by shaders to modify the appearance of the content
+renderable.  Some material properties require certain Effects to be present in
+order to function properly.
+
+If an Effect subclass needs to do any sideband rendering to prepare for a
+frame, that should be done in setup_frame().  The render() function should only
+set up the necessary state and call the content renderable's render() function.
 */
 class Effect: public Renderable
 {
 public:
+	/**
+	Holds the parameters for an Effect.  Used with SequenceTemplate.
+	*/
 	struct Template
 	{
 		class Loader: public DataFile::CollectionObjectLoader<Template>
@@ -24,17 +34,22 @@ public:
 			Loader(Template &, Collection &);
 		protected:
 			virtual void init_actions();
+
+		private:
+			void enable_for_method(const std::string &);
 		};
 
 		std::string content_name;
+		std::vector<Tag> enabled_methods;
 
 		virtual ~Template() = default;
 
 		virtual Effect *create(const std::map<std::string, Renderable *> &) const = 0;
+		void create_base(Effect &) const;
 	};
 
 protected:
-	Renderable &renderable;
+	Renderable &content;
 	std::vector<Tag> enabled_methods;
 
 protected:
@@ -46,11 +61,11 @@ public:
 	void disable_for_method(Tag);
 	bool is_enabled_for_method(Tag) const;
 
-	virtual const Matrix *get_matrix() const { return renderable.get_matrix(); }
-	virtual const Geometry::BoundingSphere<float, 3> *get_bounding_sphere() const { return renderable.get_bounding_sphere(); }
+	virtual const Matrix *get_matrix() const { return content.get_matrix(); }
+	virtual const Geometry::BoundingSphere<float, 3> *get_bounding_sphere() const { return content.get_bounding_sphere(); }
 
-	virtual void setup_frame(Renderer &r) { renderable.setup_frame(r); }
-	virtual void finish_frame() { renderable.finish_frame(); }
+	virtual void setup_frame(Renderer &r) { content.setup_frame(r); }
+	virtual void finish_frame() { content.finish_frame(); }
 
 	virtual void set_debug_name(const std::string &) = 0;
 };