Merged changes in the trunk up to revision 49986.
[blender.git] / source / blender / windowmanager / WM_types.h
index bcba7a76ec8b97d901f3289242aa87f7ba42216f..1f0a0d87cf44a04aeb64068fd08ad180436e8ae7 100644 (file)
  *  \ingroup wm
  */
 
  *  \ingroup wm
  */
 
-/*
+#ifndef __WM_TYPES_H__
+#define __WM_TYPES_H__
+
+/**
  * Overview of WM structs
  * ======================
  *
  * Overview of WM structs
  * ======================
  *
+ * <pre>
  * > wmWindowManager    (window manager stores a list of windows)
  * > > wmWindow         (window has an active screen)
  * > > > bScreen        (link to ScrAreas via 'areabase')
  * > wmWindowManager    (window manager stores a list of windows)
  * > > wmWindow         (window has an active screen)
  * > > > bScreen        (link to ScrAreas via 'areabase')
  * > > > > > SpaceLink  (base struct for space data for all different space types)
  * > > > > ScrArea      (stores multiple regions via 'regionbase')
  * > > > > > ARegion
  * > > > > > SpaceLink  (base struct for space data for all different space types)
  * > > > > ScrArea      (stores multiple regions via 'regionbase')
  * > > > > > ARegion
- *
+ * </pre>
  *
  * Window Layout
  * =============
  *
  *
  * Window Layout
  * =============
  *
+ * <pre>
  * wmWindow -> bScreen
  * +----------------------------------------------------------+
  * |+-----------------------------------------+-------------+ |
  * wmWindow -> bScreen
  * +----------------------------------------------------------+
  * |+-----------------------------------------+-------------+ |
  * ||+-------++----------+-------------------+|             | |
  * |+-----------------------------------------+-------------+ |
  * +----------------------------------------------------------+
  * ||+-------++----------+-------------------+|             | |
  * |+-----------------------------------------+-------------+ |
  * +----------------------------------------------------------+
- *
+ * </pre>
  *
  * Space Data
  * ==========
  *
  *
  * Space Data
  * ==========
  *
+ * <pre>
  * ScrArea's store a list of space data (SpaceLinks), each of unique type.
  * The first one is the displayed in the UI, others are added as needed.
  *
  * ScrArea's store a list of space data (SpaceLinks), each of unique type.
  * The first one is the displayed in the UI, others are added as needed.
  *
  *    +-----------------------------+   |
  *       |                              |
  *       +------------------------------+
  *    +-----------------------------+   |
  *       |                              |
  *       +------------------------------+
+ * </pre>
  *
  * A common way to get the space from the ScrArea:
  *
  * A common way to get the space from the ScrArea:
- *
+ * <pre>
  *     if (sa->spacetype == SPACE_VIEW3D) {
  *         View3D *v3d = sa->spacedata.first;
  *         ...
  *     }
  *     if (sa->spacetype == SPACE_VIEW3D) {
  *         View3D *v3d = sa->spacedata.first;
  *         ...
  *     }
- *
+ * </pre>
  */
 
  */
 
-#ifndef __WM_TYPES_H__
-#define __WM_TYPES_H__
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -455,28 +459,28 @@ typedef struct wmTabletData {
 
 typedef enum {  /* motion progress, for modal handlers */
        P_NOT_STARTED,
 
 typedef enum {  /* motion progress, for modal handlers */
        P_NOT_STARTED,
-       P_STARTING,    // <--
-       P_IN_PROGRESS, // <-- only these are sent for NDOF motion
-       P_FINISHING,   // <--
+       P_STARTING,    /* <-- */
+       P_IN_PROGRESS, /* <-- only these are sent for NDOF motion*/
+       P_FINISHING,   /* <-- */
        P_FINISHED
        P_FINISHED
-       } wmProgress;
+} wmProgress;
 
 typedef struct wmNDOFMotionData {
        /* awfully similar to GHOST_TEventNDOFMotionData... */
 
 typedef struct wmNDOFMotionData {
        /* awfully similar to GHOST_TEventNDOFMotionData... */
-       // Each component normally ranges from -1 to +1, but can exceed that.
-       // These use blender standard view coordinates, with positive rotations being CCW about the axis.
+       /* Each component normally ranges from -1 to +1, but can exceed that.
+        * These use blender standard view coordinates, with positive rotations being CCW about the axis. */
        union {
        union {
-               float tvec[3]; // translation
+               float tvec[3]; /* translation */
                struct { float tx, ty, tz; };
                struct { float tx, ty, tz; };
-               };
+       };
        union {
        union {
-               float rvec[3]; // rotation:
+               float rvec[3]; /* rotation: */
                struct { float rx, ry, rz; };
                struct { float rx, ry, rz; };
-               };
-               // axis = (rx,ry,rz).normalized
-               // amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg]
-       float dt; // time since previous NDOF Motion event
-       wmProgress progress; // is this the first event, the last, or one of many in between?
+       };
+       /* axis = (rx,ry,rz).normalized */
+       /* amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg] */
+       float dt; /* time since previous NDOF Motion event */
+       wmProgress progress; /* is this the first event, the last, or one of many in between? */
 } wmNDOFMotionData;
 
 typedef struct wmTimer {
 } wmNDOFMotionData;
 
 typedef struct wmTimer {