Fix for bug: cross platform strand render differences with kink/branch.
[blender.git] / source / blender / blenkernel / BKE_idprop.h
1 /**
2  * $Id: BKE_idprop.h
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * Contributor(s): Joseph Eagar
27  *
28  * ***** END GPL/BL DUAL LICENSE BLOCK *****
29  */
30  
31 #ifndef _BKE_IDPROP_H
32 #define _BKE_IDPROP_H
33
34 #include "DNA_ID.h"
35
36 /*
37 these two are included for their (new :P )function
38 pointers.
39 */
40 #include "BLO_readfile.h"
41 #include "BLO_writefile.h"
42
43 struct WriteData;
44 struct FileData;
45
46 struct IDProperty;
47 struct ID;
48
49 typedef union {
50         int i;
51         float f;
52         char *str;
53         struct ID *id;
54         struct {
55                 short type;
56                 short len;
57         } array;
58         struct {
59                 int matvec_size;
60                 float *example;
61         } matrix_or_vector;
62 } IDPropertyTemplate;
63
64 /* ----------- Array Type ----------- */
65 /*this function works for strings too!*/
66 void IDP_ResizeArray(struct IDProperty *prop, int newlen);
67 void IDP_FreeArray(struct IDProperty *prop);
68 void IDP_UnlinkArray(struct IDProperty *prop);
69
70 /* ---------- String Type ------------ */
71 void IDP_AssignString(struct IDProperty *prop, char *st);
72 void IDP_ConcatStringC(struct IDProperty *prop, char *st);
73 void IDP_ConcatString(struct IDProperty *str1, struct IDProperty *append);
74 void IDP_FreeString(struct IDProperty *prop);
75
76 /*-------- ID Type -------*/
77 void IDP_LinkID(struct IDProperty *prop, ID *id);
78 void IDP_UnlinkID(struct IDProperty *prop);
79
80 /*-------- Group Functions -------*/
81
82 /*checks if a property with the same name as prop exists, and if so replaces it.
83   Use this to preserve order!*/
84 void IDP_ReplaceInGroup(struct IDProperty *group, struct IDProperty *prop);
85
86 /*
87 This function has a sanity check to make sure ID properties with the same name don't
88 get added to the group.
89
90 The sanity check just means the property is not added to the group if another property
91 exists with the same name; the client code using ID properties then needs to detect this 
92 (the function that adds new properties to groups, IDP_AddToGroup, returns 0 if a property can't
93 be added to the group, and 1 if it can) and free the property.
94
95 Currently the code to free ID properties is designesd to leave the actual struct
96 you pass it un-freed, this is needed for how the system works.  This means
97 to free an ID property, you first call IDP_FreeProperty then MEM_freeN the
98 struct.  In the future this will just be IDP_FreeProperty and the code will
99 be reorganized to work properly.
100 */
101 int IDP_AddToGroup(struct IDProperty *group, struct IDProperty *prop);
102
103 /*this is the same as IDP_AddToGroup, only you pass an item
104   in the group list to be inserted after.*/
105 int IDP_InsertToGroup(struct IDProperty *group, struct IDProperty *previous, 
106                       struct IDProperty *pnew);
107
108 /*NOTE: this does not free the property!!
109
110  To free the property, you have to do:
111  IDP_FreeProperty(prop); //free all subdata
112  MEM_freeN(prop); //free property struct itself
113
114 */
115 void IDP_RemFromGroup(struct IDProperty *group, struct IDProperty *prop);
116
117 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, char *name);
118
119 /*Get an iterator to iterate over the members of an id property group.
120  Note that this will automatically free the iterator once iteration is complete;
121  if you stop the iteration before hitting the end, make sure to call
122  IDP_FreeIterBeforeEnd().*/
123 void *IDP_GetGroupIterator(struct IDProperty *prop);
124
125 /*Returns the next item in the iteration.  To use, simple for a loop like the following:
126  while (IDP_GroupIterNext(iter) != NULL) {
127         . . .
128  }*/
129 IDProperty *IDP_GroupIterNext(void *vself);
130
131 /*Frees the iterator pointed to at vself, only use this if iteration is stopped early; 
132   when the iterator hits the end of the list it'll automatially free itself.*/
133 void IDP_FreeIterBeforeEnd(void *vself);
134
135 /*-------- Main Functions --------*/
136 /*Get the Group property that contains the id properties for ID id.  Set create_if_needed
137   to create the Group property and attach it to id if it doesn't exist; otherwise
138   the function will return NULL if there's no Group property attached to the ID.*/
139 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed);
140 struct IDProperty *IDP_CopyProperty(struct IDProperty *prop);
141
142 /*
143 Allocate a new ID.
144
145 This function takes three arguments: the ID property type, a union which defines
146 it's initial value, and a name.
147
148 The union is simple to use; see the top of this header file for its definition. 
149 An example of using this function:
150
151  IDPropertyTemplate val;
152  IDProperty *group, *idgroup, *color;
153  group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
154
155  val.array.len = 4
156  val.array.type = IDP_FLOAT;
157  color = IDP_New(IDP_ARRAY, val, "color1");
158
159  idgroup = IDP_GetProperties(some_id, 1);
160  IDP_AddToGroup(idgroup, color);
161  IDP_AddToGroup(idgroup, group);
162
163 Note that you MUST either attach the id property to an id property group with 
164 IDP_AddToGroup or MEM_freeN the property, doing anything else might result in
165 a memory leak.
166 */
167 struct IDProperty *IDP_New(int type, IDPropertyTemplate val, char *name);
168 \
169 /*NOTE: this will free all child properties of list arrays and groups!
170   Also, note that this does NOT unlink anything!  Plus it doesn't free
171   the actual struct IDProperty struct either.*/
172 void IDP_FreeProperty(struct IDProperty *prop);
173
174 /*Unlinks any struct IDProperty<->ID linkage that might be going on.*/
175 void IDP_UnlinkProperty(struct IDProperty *prop);
176
177 #endif /* _BKE_IDPROP_H */