From 7d94a260712242f0e47e27c0a4dc847ea2138c33 Mon Sep 17 00:00:00 2001 From: Tats Date: Sat, 11 Jan 2014 16:38:23 -0500 Subject: [PATCH] Fixed the documentation for class Mapping --- Mapping.h | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/Mapping.h b/Mapping.h index 149812c..521b760 100644 --- a/Mapping.h +++ b/Mapping.h @@ -28,11 +28,16 @@ #include "Paint.h" /** - * One object in the scene that is a shape with some paint on it. + * Mapping is the central concept of Libremapping. * - * A Mapping is an area of the rendering window that is drawn with - * either some texture, or any special effect that might animate a - * polygon or a line. + * A Mapping represents a relationship between an input Paint and + * and output Shape where the paint (possibly modified by some other + * attributes or an input Shape in the case of TextureMapping) is + * projected on the output shape. + * + * Mapping instances are stacked as layers by the MappingManager. One + * can thus change their opacity level, toggle their visibility, set + * them in "solo" mode and lock them. */ class Mapping {