[Bf-blender-cvs] [8f16181] master: Add comments on behavior of spacedata and regionbase lists

[Julian Eisel]

Commit: 8f16181e9c491ccb1e94f092f5203fc759ee7c68
Author: Julian Eisel
Date:   Thu Jul 28 02:36:12 2016 +0200
Branches: master
https://developer.blender.org/rB8f16181e9c491ccb1e94f092f5203fc759ee7c68

Add comments on behavior of spacedata and regionbase lists

===================================================================

M	source/blender/makesdna/DNA_screen_types.h

===================================================================

diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h
index fbeabb3..e208ef3 100644
--- a/source/blender/makesdna/DNA_screen_types.h
+++ b/source/blender/makesdna/DNA_screen_types.h
@@ -218,11 +218,18 @@ typedef struct ScrArea {
 	char temp, pad;
 	
 	struct SpaceType *type;		/* callbacks for this space type */
-	
-	ListBase spacedata;		/* SpaceLink */
-	ListBase regionbase;	/* ARegion */
-	ListBase handlers;		/* wmEventHandler */
-	
+
+	/* A list of space links (editors) that were open in this area before. When
+	 * changing the editor type, we try to reuse old editor data from this list.
+	 * The first item is the active/visible one.
+	 */
+	ListBase spacedata;  /* SpaceLink */
+	/* NOTE: This region list is the one from the active/visible editor (first item in
+	 * spacedata list). Use SpaceLink.regionbase if it's inactive (but only then)!
+	 */
+	ListBase regionbase; /* ARegion */
+	ListBase handlers;   /* wmEventHandler */
+
 	ListBase actionzones;	/* AZone */
 } ScrArea;