add new sigc++2 directory

[ardour.git] / libs / ardour / ardour / region.h

diff --git a/libs/ardour/ardour/region.h b/libs/ardour/ardour/region.h
index fb1220e99649cca58ec38d7833059cda3f53f9ee..00315846b2e51e390f4faf14769775499af4b013 100644 (file)
--- a/libs/ardour/ardour/region.h
+++ b/libs/ardour/ardour/region.h
@@ -98,6 +98,16 @@ class Region : public Automatable, public boost::enable_shared_from_this<Region>
 
        const DataType& data_type() const { return _type; }
 
+       /**
+        * Thats how the region parameters play together:
+        * <PRE>
+        * |------------------------------------------------------------------- track
+        *                    |..........[------------------].....| region
+        * |-----------------------------| _position
+        *                               |------------------| _length
+        *                    |----------| _start
+        * </PRE>
+        */
        nframes_t position () const { return _position; }
        nframes_t start ()    const { return _start; }
        nframes_t length()    const { return _length; }