Comments!!1
[blender-staging.git] / source / blender / makesdna / DNA_object_types.h
index 6bb18fe1df96195fdf8b572c15ea3badeb990df1..83168248b9a096f01c330783f013a963b3b0e259 100644 (file)
@@ -5,15 +5,12 @@
  *
  * $Id$ 
  *
- * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
+ * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version. The Blender
- * Foundation also sells licenses for use in proprietary software under
- * the Blender License.  See http://www.blender.org/BL/ for information
- * about this.
+ * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -31,7 +28,7 @@
  *
  * Contributor(s): none yet.
  *
- * ***** END GPL/BL DUAL LICENSE BLOCK *****
+ * ***** END GPL LICENSE BLOCK *****
  */
 #ifndef DNA_OBJECT_TYPES_H
 #define DNA_OBJECT_TYPES_H
@@ -54,6 +51,7 @@ struct bConstraintChannel;
 struct PartDeflect;
 struct SoftBody;
 struct FluidsimSettings;
+struct ParticleSystem;
 struct DerivedMesh;
 
 typedef struct bDeformGroup {
@@ -61,23 +59,34 @@ typedef struct bDeformGroup {
        char name[32];
 } bDeformGroup;
 
+/**
+ * The following illustrates the orientation of the 
+ * bounding box in local space
+ * 
+ *  
+ * Z  Y
+ * | /
+ * |/
+ * .-----X
+ * 
+ * 
+ *     2----------6
+ *    /|         /|
+ *   / |        / |
+ *  1----------5  |
+ *  |  |       |  |
+ *  |  3-------|--7
+ *  | /        | /
+ *  |/         |/
+ *  0----------4
+ */
 typedef struct BoundBox {
        float vec[8][3];
+       int flag, pad;
 } BoundBox;
 
-/* OcInfo and LBuf structs are for the Enji gameengine */
-
-typedef struct OcInfo {
-       float dvec[3];
-       float size[3];
-} OcInfo;
-
-typedef struct LBuf {
-       short tot, max;
-       int pad;
-       struct Object **ob;
-} LBuf;
-
+/* boundbox flag */
+#define OB_BB_DISABLED 1
 
 typedef struct Object {
        ID id;
@@ -85,18 +94,20 @@ typedef struct Object {
        short type, partype;
        int par1, par2, par3;   /* can be vertexnrs */
        char parsubstr[32];     /* String describing subobject info */
-       void *pardata;
        struct Object *parent, *track;
+       /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */
+       /* proxy_from is set in target back to the proxy. */
+       struct Object *proxy, *proxy_group, *proxy_from;
        struct Ipo *ipo;
        struct Path *path;
        struct BoundBox *bb;
        struct bAction *action; 
+       struct bAction *poselib;
        struct bPose *pose;     
        void *data;
        
        ListBase constraintChannels;
        ListBase effect;
-       ListBase network;
        ListBase disp;
        ListBase defbase;
        ListBase modifiers; /* list of ModifierData structures */
@@ -107,22 +118,26 @@ typedef struct Object {
        float loc[3], dloc[3], orig[3];
        float size[3], dsize[3];
        float rot[3], drot[3];
-       float quat[4], dquat[4];
+       /* float quat[4], dquat[4]; (not used yet) */
        float obmat[4][4];
-       float parentinv[4][4];
+       float parentinv[4][4]; /* inverse result of parent, so that object doesn't 'stick' to parent */
+       float constinv[4][4]; /* inverse result of constraints. doesn't include effect of parent or object local transform */
        float imat[4][4];       /* for during render, old game engine, temporally: ipokeys of transform  */
        
        unsigned int lay;                               /* copy of Base */
+       
        short flag;                     /* copy of Base */
        short colbits;          /* when zero, from obdata */
-       char transflag, ipoflag;
-       char trackflag, upflag;
-       short ipowin, scaflag;  /* ipowin: blocktype last ipowindow */
+       
+       short transflag, ipoflag;       /* transformation and ipo settings */
+       short trackflag, upflag;
+       short nlaflag, protectflag;     /* nlaflag defines NLA override, protectflag is bits to lock transform */
+       short ipowin, scaflag;          /* ipowin: blocktype last ipowindow */
        short scavisflag, boundtype;
        
-       short dupon, dupoff, dupsta, dupend;
+       int dupon, dupoff, dupsta, dupend;
 
-       float sf, ctime;
+       float sf, ctime; /* sf is time-offset, ctime is the objects current time */
        
        /* during realtime */
 
@@ -139,25 +154,26 @@ typedef struct Object {
         * For a Sphere, the form factor is by default = 0.4
         */
 
-       float formfactor, softtime;             /* softtime temp for softbody, remove it before release! */
+       float formfactor;
        float rdamping, sizefac;
        
        char dt, dtx;
        char totcol;    /* copy of mesh or curve or meta */
-       char actcol;
+       char actcol;    /* currently selected material in the user interface */
+       char empty_drawtype, pad1[3];
+       float empty_drawsize;
+       float dupfacesca;       /* dupliface scale */
        
        ScriptLink scriptlink;
        ListBase prop;
        ListBase sensors;
        ListBase controllers;
        ListBase actuators;
-
-    void *sumohandle;
     
        float bbsize[3];
-       short dfras;
+       short index;                    /* custom index, for renderpasses */
        unsigned short actdef;  /* current deformation group */
-       float col[4];
+       float col[4];                   /* object color, adjusted via IPO's only */
        /**
         * Settings for game objects
         * bit 0: Object has dynamic behaviour
@@ -182,23 +198,32 @@ typedef struct Object {
        ListBase constraints;
        ListBase nlastrips;
        ListBase hooks;
+       ListBase particlesystem;        /* particle systems */
        
        struct PartDeflect *pd;         /* particle deflector/attractor/collision data */
        struct SoftBody *soft;          /* if exists, saved in file */
-       struct Life *life;
-
-       LBuf lbuf;
-       LBuf port;
+       struct Group *dup_group;        /* object duplicator for group */
        
-       float pad3, smoothresh;         /* smoothresh is phong interpolation ray_shadow correction in render */
+       short fluidsimFlag;                     /* NT toggle fluidsim participation on/off */
+       
+       short restrictflag;                     /* for restricting view, select, render etc. accessible in outliner */
 
-       short fluidsimFlag;  /* NT toggle fluidsim participation on/off */
-       short dnapadFluidsimDummy1, dnapadFluidsimDummy2, dnapadFluidsimDummy3; /* 8byte align */
+       short shapenr, shapeflag;       /* current shape key for menu or pinned, flag for pinning */
+       float smoothresh;                       /* smoothresh is phong interpolation ray_shadow correction in render */
+       short recalco, pad4;            /* recalco for temp storage of ob->recalc, bad design warning */
+       
        struct FluidsimSettings *fluidsimSettings; /* if fluidsim enabled, store additional settings */
-  
+
        struct DerivedMesh *derivedDeform, *derivedFinal;
+       int lastDataMask;                       /* the custom data layer mask that was last used to calculate derivedDeform and derivedFinal */
+       int pad;
+
+/*#ifdef WITH_VERSE*/
+       void *vnode;                    /* pointer at object VerseNode */
+/*#endif*/
 } Object;
 
+/* Warning, this is not used anymore because hooks are now modifiers */
 typedef struct ObHook {
        struct ObHook *next, *prev;
        
@@ -255,19 +280,23 @@ extern Object workob;
 #define PARBONE                        7
 #define PARSLOW                        16
 
-/* char! transflag */
-#define OB_OFFS_LOCAL  1
-#define OB_QUAT                        2
-#define OB_NEG_SCALE   4
-#define OB_DUPLI               (8+16)
-#define OB_DUPLIFRAMES 8
-#define OB_DUPLIVERTS  16
-#define OB_DUPLIROT            32
-#define OB_DUPLINOSPEED        64
-
-#define OB_POWERTRACK  128
-
-/* char! ipoflag */
+/* (short) transflag */
+#define OB_OFFS_LOCAL          1
+#define OB_QUAT                                2
+#define OB_NEG_SCALE           4
+#define OB_DUPLI                       (8+16+256+512+2048)
+#define OB_DUPLIFRAMES         8
+#define OB_DUPLIVERTS          16
+#define OB_DUPLIROT                    32
+#define OB_DUPLINOSPEED                64
+#define OB_POWERTRACK          128
+#define OB_DUPLIGROUP          256
+#define OB_DUPLIFACES          512
+#define OB_DUPLIFACES_SCALE    1024
+#define OB_DUPLIPARTS          2048
+#define OB_RENDER_DUPLI                4096
+
+/* (short) ipoflag */
 #define OB_DRAWKEY                     1
 #define OB_DRAWKEYSEL          2
 #define OB_OFFS_OB                     4
@@ -276,9 +305,16 @@ extern Object workob;
 #define OB_OFFS_PATH           32
 #define OB_OFFS_PARENT         64
 #define OB_OFFS_PARTICLE       128
+       /* get ipo from from action or not? */
+#define OB_ACTION_OB           256
+#define OB_ACTION_KEY          512
+       /* for stride edit */
+#define OB_DISABLE_PATH                1024
 
+#define OB_OFFS_PARENTADD      2048
 
-/* trackflag / upflag */
+
+/* (short) trackflag / upflag */
 #define OB_POSX                        0
 #define OB_POSY                        1
 #define OB_POSZ                        2
@@ -288,13 +324,25 @@ extern Object workob;
 
 /* gameflag in game.h */
 
-/* dt: nummers */
+/* dt: no flags */
 #define OB_BOUNDBOX            1
 #define OB_WIRE                        2
 #define OB_SOLID               3
 #define OB_SHADED              4
 #define OB_TEXTURE             5
 
+/* this condition has been made more complex since editmode can draw textures */
+#define CHECK_OB_DRAWTEXTURE(vd, dt) \
+       ((vd->drawtype==OB_TEXTURE && dt>OB_SOLID) || \
+       (vd->drawtype==OB_SOLID && vd->flag2 & V3D_SOLID_TEX))
+
+#define CHECK_OB_DRAWFACEDOT(sce, vd, dt) \
+       (       (sce->selectmode & SCE_SELECT_FACE) && \
+               (vd->drawtype<=OB_SOLID) && \
+               (((vd->drawtype==OB_SOLID) && (dt>=OB_SOLID) && (vd->flag2 & V3D_SOLID_TEX) && (vd->flag & V3D_ZBUF_SELECT)) == 0) \
+       )
+
+
 /* dtx: flags, char! */
 #define OB_AXIS                        2
 #define OB_TEXSPACE            4
@@ -307,6 +355,15 @@ extern Object workob;
        /* enable transparent draw */
 #define OB_DRAWTRANSP  128
 
+/* empty_drawtype: no flags */
+#define OB_ARROWS              1
+#define OB_PLAINAXES   2
+#define OB_CIRCLE              3
+#define OB_SINGLE_ARROW        4
+#define OB_CUBE                        5
+#define OB_EMPTY_SPHERE        6
+#define OB_EMPTY_CONE  7
+
 /* boundtype */
 #define OB_BOUND_BOX           0
 #define OB_BOUND_SPHERE                1
@@ -314,6 +371,10 @@ extern Object workob;
 #define OB_BOUND_CONE          3
 #define OB_BOUND_POLYH         4
 #define OB_BOUND_POLYT         5
+#define OB_BOUND_DYN_MESH   6
+
+
+/* **************** BASE ********************* */
 
 /* also needed for base!!!!! or rather, thy interfere....*/
 /* base->flag and ob->flag */
@@ -322,10 +383,14 @@ extern Object workob;
 #define BA_HAS_RECALC_DATA     8
 
 #define BA_DO_IPO                      32
-#define OB_GONNA_MOVE          32
 
 #define BA_FROMSET                     128
-#define OB_DO_IMAT                     256
+
+/* an initial attempt as making selection more specific! */
+#define BA_DESELECT    0
+#define BA_SELECT              1
+
+
 #define OB_FROMDUPLI           512
 #define OB_DONE                                1024
 #define OB_RADIO                       2048
@@ -335,8 +400,9 @@ extern Object workob;
 /* ob->recalc (flag bits!) */
 #define OB_RECALC_OB           1
 #define OB_RECALC_DATA         2
-#define OB_RECALC                      3
-
+               /* time flag is set when time changes need recalc, so baked systems can ignore it */
+#define OB_RECALC_TIME         4
+#define OB_RECALC                      7
 
 /* ob->gameflag */
 #define OB_DYNAMIC             1
@@ -375,6 +441,31 @@ extern Object workob;
 #define OB_ADDACT              1024
 #define OB_SHOWCONT            2048
 
+/* ob->restrictflag */
+#define OB_RESTRICT_VIEW       1
+#define OB_RESTRICT_SELECT     2
+#define OB_RESTRICT_RENDER     4
+
+/* ob->shapeflag */
+#define OB_SHAPE_LOCK          1
+#define OB_SHAPE_TEMPLOCK      2
+
+/* ob->nlaflag */
+#define OB_NLA_OVERRIDE                1
+#define OB_NLA_COLLAPSED       2
+
+/* ob->protectflag */
+#define OB_LOCK_LOCX   1
+#define OB_LOCK_LOCY   2
+#define OB_LOCK_LOCZ   4
+#define OB_LOCK_LOC            7
+#define OB_LOCK_ROTX   8
+#define OB_LOCK_ROTY   16
+#define OB_LOCK_ROTZ   32
+#define OB_LOCK_SCALEX 64
+#define OB_LOCK_SCALEY 128
+#define OB_LOCK_SCALEZ 256
+
 /* ob->softflag in DNA_object_force.h */
 
 #ifdef __cplusplus
@@ -383,3 +474,4 @@ extern Object workob;
 
 #endif
 
+