Check the flat qualifier from the correct member

[libs/gl.git] / source / effects / effect.h

diff --git a/source/effects/effect.h b/source/effects/effect.h
index 9bf49c22b812a585200a0c28890932dcadadf093..a77cdb5abae46023305c605b1dd7966203c07126 100644 (file)
--- a/source/effects/effect.h
+++ b/source/effects/effect.h
@@ -2,21 +2,55 @@
 #define MSP_GL_EFFECT_H_
 
 #include <set>
+#include <msp/datafile/objectloader.h>
 #include "renderable.h"
 
 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>
+               {
+               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;
-       std::set<Tag> enabled_methods;
+       Renderable &content;
+       std::vector<Tag> enabled_methods;
 
 protected:
        Effect(Renderable &);
@@ -25,12 +59,13 @@ public:
 
        void enable_for_method(Tag);
        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;
 };