2.5 - Restoring Bone Groups
[blender-staging.git] / source / blender / makesrna / RNA_access.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef RNA_ACCESS
26 #define RNA_ACCESS
27
28 #include <stdarg.h>
29
30 #include "DNA_listBase.h"
31 #include "RNA_types.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct bContext;
38 struct ID;
39 struct Main;
40 struct ReportList;
41
42 /* Types */
43
44 extern BlenderRNA BLENDER_RNA;
45
46 extern StructRNA RNA_Action;
47 extern StructRNA RNA_ActionConstraint;
48 extern StructRNA RNA_ActionGroup;
49 extern StructRNA RNA_Actuator;
50 extern StructRNA RNA_ActuatorSensor;
51 extern StructRNA RNA_AlwaysSensor;
52 extern StructRNA RNA_AndController;
53 extern StructRNA RNA_AnimData;
54 extern StructRNA RNA_AnyType;
55 extern StructRNA RNA_Area;
56 extern StructRNA RNA_AreaLamp;
57 extern StructRNA RNA_Armature;
58 extern StructRNA RNA_ArmatureModifier;
59 extern StructRNA RNA_ArrayModifier;
60 extern StructRNA RNA_BackgroundImage;
61 extern StructRNA RNA_BevelModifier;
62 extern StructRNA RNA_BezierCurvePoint;
63 extern StructRNA RNA_BlendTexture;
64 extern StructRNA RNA_BlenderRNA;
65 extern StructRNA RNA_Bone;
66 extern StructRNA RNA_BoneGroup;
67 extern StructRNA RNA_BooleanModifier;
68 extern StructRNA RNA_BooleanProperty;
69 extern StructRNA RNA_Brush;
70 extern StructRNA RNA_BuildModifier;
71 extern StructRNA RNA_Camera;
72 extern StructRNA RNA_CastModifier;
73 extern StructRNA RNA_ChildOfConstraint;
74 extern StructRNA RNA_ChildParticle;
75 extern StructRNA RNA_ClampToConstraint;
76 extern StructRNA RNA_ClothCollisionSettings;
77 extern StructRNA RNA_ClothModifier;
78 extern StructRNA RNA_ClothSettings;
79 extern StructRNA RNA_CloudsTexture;
80 extern StructRNA RNA_CollectionProperty;
81 extern StructRNA RNA_CollisionModifier;
82 extern StructRNA RNA_CollisionSensor;
83 extern StructRNA RNA_CollisionSettings;
84 extern StructRNA RNA_ColorRamp;
85 extern StructRNA RNA_ColorRampElement;
86 extern StructRNA RNA_ColorSequence;
87 extern StructRNA RNA_CompositorNode;
88 extern StructRNA RNA_CompositorNodeAlphaOver;
89 extern StructRNA RNA_CompositorNodeBilateralblur;
90 extern StructRNA RNA_CompositorNodeBlur;
91 extern StructRNA RNA_CompositorNodeBrightContrast;
92 extern StructRNA RNA_CompositorNodeChannelMatte;
93 extern StructRNA RNA_CompositorNodeChroma;
94 extern StructRNA RNA_CompositorNodeColorSpill;
95 extern StructRNA RNA_CompositorNodeCombHSVA;
96 extern StructRNA RNA_CompositorNodeCombRGBA;
97 extern StructRNA RNA_CompositorNodeCombYCCA;
98 extern StructRNA RNA_CompositorNodeCombYUVA;
99 extern StructRNA RNA_CompositorNodeComposite;
100 extern StructRNA RNA_CompositorNodeCrop;
101 extern StructRNA RNA_CompositorNodeCurveRGB;
102 extern StructRNA RNA_CompositorNodeCurveVec;
103 extern StructRNA RNA_CompositorNodeDBlur;
104 extern StructRNA RNA_CompositorNodeDefocus;
105 extern StructRNA RNA_CompositorNodeDiffMatte;
106 extern StructRNA RNA_CompositorNodeDilateErode;
107 extern StructRNA RNA_CompositorNodeDisplace;
108 extern StructRNA RNA_CompositorNodeFilter;
109 extern StructRNA RNA_CompositorNodeFlip;
110 extern StructRNA RNA_CompositorNodeGamma;
111 extern StructRNA RNA_CompositorNodeGlare;
112 extern StructRNA RNA_CompositorNodeHueSat;
113 extern StructRNA RNA_CompositorNodeIDMask;
114 extern StructRNA RNA_CompositorNodeImage;
115 extern StructRNA RNA_CompositorNodeInvert;
116 extern StructRNA RNA_CompositorNodeLensdist;
117 extern StructRNA RNA_CompositorNodeLumaMatte;
118 extern StructRNA RNA_CompositorNodeMapUV;
119 extern StructRNA RNA_CompositorNodeMapValue;
120 extern StructRNA RNA_CompositorNodeMath;
121 extern StructRNA RNA_CompositorNodeMixRGB;
122 extern StructRNA RNA_CompositorNodeNormal;
123 extern StructRNA RNA_CompositorNodeNormalize;
124 extern StructRNA RNA_CompositorNodeOutputFile;
125 extern StructRNA RNA_CompositorNodePremulKey;
126 extern StructRNA RNA_CompositorNodeRGB;
127 extern StructRNA RNA_CompositorNodeRGBToBW;
128 extern StructRNA RNA_CompositorNodeRLayers;
129 extern StructRNA RNA_CompositorNodeRotate;
130 extern StructRNA RNA_CompositorNodeScale;
131 extern StructRNA RNA_CompositorNodeSepHSVA;
132 extern StructRNA RNA_CompositorNodeSepRGBA;
133 extern StructRNA RNA_CompositorNodeSepYCCA;
134 extern StructRNA RNA_CompositorNodeSepYUVA;
135 extern StructRNA RNA_CompositorNodeSetAlpha;
136 extern StructRNA RNA_CompositorNodeSplitViewer;
137 extern StructRNA RNA_CompositorNodeTexture;
138 extern StructRNA RNA_CompositorNodeTime;
139 extern StructRNA RNA_CompositorNodeTonemap;
140 extern StructRNA RNA_CompositorNodeTranslate;
141 extern StructRNA RNA_CompositorNodeValToRGB;
142 extern StructRNA RNA_CompositorNodeValue;
143 extern StructRNA RNA_CompositorNodeVecBlur;
144 extern StructRNA RNA_CompositorNodeViewer;
145 extern StructRNA RNA_CompositorNodeZcombine;
146 extern StructRNA RNA_Constraint;
147 extern StructRNA RNA_ConstraintTarget;
148 extern StructRNA RNA_Context;
149 extern StructRNA RNA_ControlFluidSettings;
150 extern StructRNA RNA_Controller;
151 extern StructRNA RNA_CopyLocationConstraint;
152 extern StructRNA RNA_CopyRotationConstraint;
153 extern StructRNA RNA_CopyScaleConstraint;
154 extern StructRNA RNA_Curve;
155 extern StructRNA RNA_CurveMap;
156 extern StructRNA RNA_CurveMapPoint;
157 extern StructRNA RNA_CurveMapping;
158 extern StructRNA RNA_CurveModifier;
159 extern StructRNA RNA_CurvePoint;
160 extern StructRNA RNA_DecimateModifier;
161 extern StructRNA RNA_DelaySensor;
162 extern StructRNA RNA_DisplaceModifier;
163 extern StructRNA RNA_DistortedNoiseTexture;
164 extern StructRNA RNA_DomainFluidSettings;
165 extern StructRNA RNA_Driver;
166 extern StructRNA RNA_DriverTarget;
167 extern StructRNA RNA_EdgeSplitModifier;
168 extern StructRNA RNA_EditBone;
169 extern StructRNA RNA_EffectSequence;
170 extern StructRNA RNA_EnumProperty;
171 extern StructRNA RNA_EnumPropertyItem;
172 extern StructRNA RNA_EnvironmentMap;
173 extern StructRNA RNA_EnvironmentMapTexture;
174 extern StructRNA RNA_ExplodeModifier;
175 extern StructRNA RNA_ExpressionController;
176 extern StructRNA RNA_Event;
177 extern StructRNA RNA_FCurve;
178 extern StructRNA RNA_FCurveSample;
179 extern StructRNA RNA_FileSelectParams;
180 extern StructRNA RNA_FModifier;
181 extern StructRNA RNA_FModifierCycles;
182 extern StructRNA RNA_FModifierEnvelope;
183 extern StructRNA RNA_FModifierEnvelopeControlPoint;
184 extern StructRNA RNA_FModifierFunctionGenerator;
185 extern StructRNA RNA_FModifierGenerator;
186 extern StructRNA RNA_FModifierGenerator_PolyExpanded;
187 extern StructRNA RNA_FModifierLimits;
188 extern StructRNA RNA_FModifierNoise;
189 extern StructRNA RNA_FModifierPython;
190 extern StructRNA RNA_FieldSettings;
191 extern StructRNA RNA_FloatProperty;
192 extern StructRNA RNA_FloorConstraint;
193 extern StructRNA RNA_FluidFluidSettings;
194 extern StructRNA RNA_FluidSettings;
195 extern StructRNA RNA_FluidSimulationModifier;
196 extern StructRNA RNA_FollowPathConstraint;
197 extern StructRNA RNA_Function;
198 extern StructRNA RNA_GameBooleanProperty;
199 extern StructRNA RNA_GameFloatProperty;
200 extern StructRNA RNA_GameIntProperty;
201 extern StructRNA RNA_GameObjectSettings;
202 extern StructRNA RNA_GameProperty;
203 extern StructRNA RNA_GameSoftBodySettings;
204 extern StructRNA RNA_GameStringProperty;
205 extern StructRNA RNA_GameTimerProperty;
206 extern StructRNA RNA_GlowSequence;
207 extern StructRNA RNA_Group;
208 extern StructRNA RNA_Header;
209 extern StructRNA RNA_HemiLamp;
210 extern StructRNA RNA_HookModifier;
211 extern StructRNA RNA_ID;
212 extern StructRNA RNA_IDProperty;
213 extern StructRNA RNA_IDPropertyGroup;
214 extern StructRNA RNA_Image;
215 extern StructRNA RNA_ImageSequence;
216 extern StructRNA RNA_ImageTexture;
217 extern StructRNA RNA_ImageUser;
218 extern StructRNA RNA_InflowFluidSettings;
219 extern StructRNA RNA_IntProperty;
220 extern StructRNA RNA_JoystickSensor;
221 extern StructRNA RNA_Key;
222 extern StructRNA RNA_KeyboardSensor;
223 extern StructRNA RNA_KeyingSet;
224 extern StructRNA RNA_KeyingSetPath;
225 extern StructRNA RNA_ParticleTarget;
226 extern StructRNA RNA_KinematicConstraint;
227 extern StructRNA RNA_Lamp;
228 extern StructRNA RNA_LampSkySettings;
229 extern StructRNA RNA_LampTextureSlot;
230 extern StructRNA RNA_Lattice;
231 extern StructRNA RNA_LatticeModifier;
232 extern StructRNA RNA_LatticePoint;
233 extern StructRNA RNA_Library;
234 extern StructRNA RNA_LimitDistanceConstraint;
235 extern StructRNA RNA_LimitLocationConstraint;
236 extern StructRNA RNA_LimitRotationConstraint;
237 extern StructRNA RNA_LimitScaleConstraint;
238 extern StructRNA RNA_LocalLamp;
239 extern StructRNA RNA_LockedTrackConstraint;
240 extern StructRNA RNA_MagicTexture;
241 extern StructRNA RNA_Main;
242 extern StructRNA RNA_MarbleTexture;
243 extern StructRNA RNA_MaskModifier;
244 extern StructRNA RNA_Material;
245 extern StructRNA RNA_MaterialHalo;
246 extern StructRNA RNA_MaterialRaytraceMirror;
247 extern StructRNA RNA_MaterialRaytraceTransparency;
248 extern StructRNA RNA_MaterialSlot;
249 extern StructRNA RNA_MaterialStrand;
250 extern StructRNA RNA_MaterialSubsurfaceScattering;
251 extern StructRNA RNA_MaterialTextureSlot;
252 extern StructRNA RNA_Menu;
253 extern StructRNA RNA_Mesh;
254 extern StructRNA RNA_MeshColor;
255 extern StructRNA RNA_MeshColorLayer;
256 extern StructRNA RNA_MeshDeformModifier;
257 extern StructRNA RNA_MeshEdge;
258 extern StructRNA RNA_MeshFace;
259 extern StructRNA RNA_MeshFloatProperty;
260 extern StructRNA RNA_MeshFloatPropertyLayer;
261 extern StructRNA RNA_MeshIntProperty;
262 extern StructRNA RNA_MeshIntPropertyLayer;
263 extern StructRNA RNA_MeshSticky;
264 extern StructRNA RNA_MeshStringProperty;
265 extern StructRNA RNA_MeshStringPropertyLayer;
266 extern StructRNA RNA_MeshTextureFace;
267 extern StructRNA RNA_MeshTextureFaceLayer;
268 extern StructRNA RNA_MeshVertex;
269 extern StructRNA RNA_MessageSensor;
270 extern StructRNA RNA_MetaBall;
271 extern StructRNA RNA_MetaElement;
272 extern StructRNA RNA_MetaSequence;
273 extern StructRNA RNA_MirrorModifier;
274 extern StructRNA RNA_Modifier;
275 extern StructRNA RNA_MouseSensor;
276 extern StructRNA RNA_MovieSequence;
277 extern StructRNA RNA_MultiresModifier;
278 extern StructRNA RNA_MusgraveTexture;
279 extern StructRNA RNA_NandController;
280 extern StructRNA RNA_NearSensor;
281 extern StructRNA RNA_NlaTrack;
282 extern StructRNA RNA_NlaStrip;
283 extern StructRNA RNA_Node;
284 extern StructRNA RNA_NodeTree;
285 extern StructRNA RNA_NoiseTexture;
286 extern StructRNA RNA_NorController;
287 extern StructRNA RNA_Nurb;
288 extern StructRNA RNA_Object;
289 extern StructRNA RNA_ObstacleFluidSettings;
290 extern StructRNA RNA_Operator;
291 extern StructRNA RNA_OperatorFileListElement;
292 extern StructRNA RNA_OperatorMousePath;
293 extern StructRNA RNA_OperatorProperties;
294 extern StructRNA RNA_OperatorStrokeElement;
295 extern StructRNA RNA_OrController;
296 extern StructRNA RNA_OutflowFluidSettings;
297 extern StructRNA RNA_PackedFile;
298 extern StructRNA RNA_Panel;
299 extern StructRNA RNA_Particle;
300 extern StructRNA RNA_ParticleFluidSettings;
301 extern StructRNA RNA_ParticleHairKey;
302 extern StructRNA RNA_ParticleInstanceModifier;
303 extern StructRNA RNA_ParticleKey;
304 extern StructRNA RNA_ParticleSettings;
305 extern StructRNA RNA_ParticleSystem;
306 extern StructRNA RNA_ParticleSystemModifier;
307 extern StructRNA RNA_PluginSequence;
308 extern StructRNA RNA_PluginTexture;
309 extern StructRNA RNA_PointCache;
310 extern StructRNA RNA_PointerProperty;
311 extern StructRNA RNA_Pose;
312 extern StructRNA RNA_PoseChannel;
313 extern StructRNA RNA_Property;
314 extern StructRNA RNA_PropertySensor;
315 extern StructRNA RNA_PythonConstraint;
316 extern StructRNA RNA_PythonController;
317 extern StructRNA RNA_RadarSensor;
318 extern StructRNA RNA_Radiosity;
319 extern StructRNA RNA_RandomSensor;
320 extern StructRNA RNA_RaySensor;
321 extern StructRNA RNA_Region;
322 extern StructRNA RNA_RigidBodyJointConstraint;
323 extern StructRNA RNA_Scene;
324 extern StructRNA RNA_SceneGameData;
325 extern StructRNA RNA_SceneRenderData;
326 extern StructRNA RNA_SceneSequence;
327 extern StructRNA RNA_Screen;
328 extern StructRNA RNA_ScriptLink;
329 extern StructRNA RNA_Sculpt;
330 extern StructRNA RNA_Sensor;
331 extern StructRNA RNA_Sequence;
332 extern StructRNA RNA_SequenceColorBalance;
333 extern StructRNA RNA_SequenceCrop;
334 extern StructRNA RNA_SequenceEditor;
335 extern StructRNA RNA_SequenceElement;
336 extern StructRNA RNA_SequenceProxy;
337 extern StructRNA RNA_SequenceTransform;
338 extern StructRNA RNA_ShaderNode;
339 extern StructRNA RNA_ShaderNodeCameraData;
340 extern StructRNA RNA_ShaderNodeCombineRGB;
341 extern StructRNA RNA_ShaderNodeExtendedMaterial;
342 extern StructRNA RNA_ShaderNodeGeometry;
343 extern StructRNA RNA_ShaderNodeHueSaturation;
344 extern StructRNA RNA_ShaderNodeInvert;
345 extern StructRNA RNA_ShaderNodeMapping;
346 extern StructRNA RNA_ShaderNodeMaterial;
347 extern StructRNA RNA_ShaderNodeMath;
348 extern StructRNA RNA_ShaderNodeMixRGB;
349 extern StructRNA RNA_ShaderNodeNormal;
350 extern StructRNA RNA_ShaderNodeOutput;
351 extern StructRNA RNA_ShaderNodeRGB;
352 extern StructRNA RNA_ShaderNodeRGBCurve;
353 extern StructRNA RNA_ShaderNodeRGBToBW;
354 extern StructRNA RNA_ShaderNodeSeparateRGB;
355 extern StructRNA RNA_ShaderNodeSqueeze;
356 extern StructRNA RNA_ShaderNodeTexture;
357 extern StructRNA RNA_ShaderNodeValToRGB;
358 extern StructRNA RNA_ShaderNodeValue;
359 extern StructRNA RNA_ShaderNodeVectorCurve;
360 extern StructRNA RNA_ShaderNodeVectorMath;
361 extern StructRNA RNA_ShapeKey;
362 extern StructRNA RNA_ShapeKeyBezierPoint;
363 extern StructRNA RNA_ShapeKeyCurvePoint;
364 extern StructRNA RNA_ShapeKeyPoint;
365 extern StructRNA RNA_ShrinkwrapConstraint;
366 extern StructRNA RNA_ShrinkwrapModifier;
367 extern StructRNA RNA_SimpleDeformModifier;
368 extern StructRNA RNA_SmoothModifier;
369 extern StructRNA RNA_SoftBodySettings;
370 extern StructRNA RNA_SoftBodyModifier;
371 extern StructRNA RNA_Sound;
372 extern StructRNA RNA_SoundSequence;
373 extern StructRNA RNA_Space;
374 extern StructRNA RNA_Space3DView;
375 extern StructRNA RNA_SpaceButtonsWindow;
376 extern StructRNA RNA_SpaceConsole;
377 extern StructRNA RNA_SpaceDopeSheetEditor;
378 extern StructRNA RNA_SpaceGraphEditor;
379 extern StructRNA RNA_SpaceImageEditor;
380 extern StructRNA RNA_SpaceNLA;
381 extern StructRNA RNA_SpaceOutliner;
382 extern StructRNA RNA_SpaceSequenceEditor;
383 extern StructRNA RNA_SpaceTextEditor;
384 extern StructRNA RNA_SpaceFileBrowser;
385 extern StructRNA RNA_SpaceUVEditor;
386 extern StructRNA RNA_SpeedControlSequence;
387 extern StructRNA RNA_SpotLamp;
388 extern StructRNA RNA_StretchToConstraint;
389 extern StructRNA RNA_StringProperty;
390 extern StructRNA RNA_Struct;
391 extern StructRNA RNA_StucciTexture;
392 extern StructRNA RNA_SubsurfModifier;
393 extern StructRNA RNA_SunLamp;
394 extern StructRNA RNA_SurfaceCurve;
395 extern StructRNA RNA_SurfaceModifier;
396 extern StructRNA RNA_TexMapping;
397 extern StructRNA RNA_Text;
398 extern StructRNA RNA_TextBox;
399 extern StructRNA RNA_TextCharacterFormat;
400 extern StructRNA RNA_TextCurve;
401 extern StructRNA RNA_TextLine;
402 extern StructRNA RNA_TextMarker;
403 extern StructRNA RNA_Texture;
404 extern StructRNA RNA_TextureNode;
405 extern StructRNA RNA_TextureNodeBricks;
406 extern StructRNA RNA_TextureNodeChecker;
407 extern StructRNA RNA_TextureNodeCompose;
408 extern StructRNA RNA_TextureNodeCoordinates;
409 extern StructRNA RNA_TextureNodeCurveRGB;
410 extern StructRNA RNA_TextureNodeCurveTime;
411 extern StructRNA RNA_TextureNodeDecompose;
412 extern StructRNA RNA_TextureNodeDistance;
413 extern StructRNA RNA_TextureNodeHueSaturation;
414 extern StructRNA RNA_TextureNodeImage;
415 extern StructRNA RNA_TextureNodeInvert;
416 extern StructRNA RNA_TextureNodeMath;
417 extern StructRNA RNA_TextureNodeMixRGB;
418 extern StructRNA RNA_TextureNodeOutput;
419 extern StructRNA RNA_TextureNodeRGBToBW;
420 extern StructRNA RNA_TextureNodeRotate;
421 extern StructRNA RNA_TextureNodeScale;
422 extern StructRNA RNA_TextureNodeTexture;
423 extern StructRNA RNA_TextureNodeTranslate;
424 extern StructRNA RNA_TextureNodeValToNor;
425 extern StructRNA RNA_TextureNodeValToRGB;
426 extern StructRNA RNA_TextureNodeViewer;
427 extern StructRNA RNA_TextureSlot;
428 extern StructRNA RNA_Theme;
429 extern StructRNA RNA_ThemeAudioWindow;
430 extern StructRNA RNA_ThemeBoneColorSet;
431 extern StructRNA RNA_ThemeButtonsWindow;
432 extern StructRNA RNA_ThemeDopeSheet;
433 extern StructRNA RNA_ThemeFileBrowser;
434 extern StructRNA RNA_ThemeFontStyle;
435 extern StructRNA RNA_ThemeGraphEditor;
436 extern StructRNA RNA_ThemeImageEditor;
437 extern StructRNA RNA_ThemeNLAEditor;
438 extern StructRNA RNA_ThemeNodeEditor;
439 extern StructRNA RNA_ThemeOutliner;
440 extern StructRNA RNA_ThemeSequenceEditor;
441 extern StructRNA RNA_ThemeStyle;
442 extern StructRNA RNA_ThemeTextEditor;
443 extern StructRNA RNA_ThemeTimeline;
444 extern StructRNA RNA_ThemeUserInterface;
445 extern StructRNA RNA_ThemeUserPreferences;
446 extern StructRNA RNA_ThemeView3D;
447 extern StructRNA RNA_ThemeWidgetColors;
448 extern StructRNA RNA_TimelineMarker;
449 extern StructRNA RNA_ToolSettings;
450 extern StructRNA RNA_TouchSensor;
451 extern StructRNA RNA_TrackToConstraint;
452 extern StructRNA RNA_TransformConstraint;
453 extern StructRNA RNA_TransformSequence;
454 extern StructRNA RNA_UILayout;
455 extern StructRNA RNA_UVProjectModifier;
456 extern StructRNA RNA_UnknownType;
457 extern StructRNA RNA_UserPreferences;
458 extern StructRNA RNA_UserPreferencesAutosave;
459 extern StructRNA RNA_UserPreferencesEdit;
460 extern StructRNA RNA_UserPreferencesFilePaths;
461 extern StructRNA RNA_UserPreferencesLanguage;
462 extern StructRNA RNA_UserPreferencesSystem;
463 extern StructRNA RNA_UserPreferencesView;
464 extern StructRNA RNA_UserSolidLight;
465 extern StructRNA RNA_VPaint;
466 extern StructRNA RNA_VectorFont;
467 extern StructRNA RNA_VertexGroup;
468 extern StructRNA RNA_VertexGroupElement;
469 extern StructRNA RNA_VoronoiTexture;
470 extern StructRNA RNA_WaveModifier;
471 extern StructRNA RNA_WindowManager;
472 extern StructRNA RNA_WipeSequence;
473 extern StructRNA RNA_WoodTexture;
474 extern StructRNA RNA_World;
475 extern StructRNA RNA_WorldAmbientOcclusion;
476 extern StructRNA RNA_WorldMistSettings;
477 extern StructRNA RNA_WorldStarsSettings;
478 extern StructRNA RNA_WorldTextureSlot;
479 extern StructRNA RNA_XnorController;
480 extern StructRNA RNA_XorController;
481
482 /* Pointer
483  *
484  * These functions will fill in RNA pointers, this can be done in three ways:
485  * - a pointer Main is created by just passing the data pointer
486  * - a pointer to a datablock can be created with the type and id data pointer
487  * - a pointer to data contained in a datablock can be created with the id type
488  *   and id data pointer, and the data type and pointer to the struct itself.
489  *
490  * There is also a way to get a pointer with the information about all structs.
491  */
492
493 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
494 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
495 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
496
497 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
498
499 extern PointerRNA PointerRNA_NULL;
500
501 /* Structs */
502
503 const char *RNA_struct_identifier(StructRNA *type);
504 const char *RNA_struct_ui_name(StructRNA *type);
505 const char *RNA_struct_ui_description(StructRNA *type);
506 int RNA_struct_ui_icon(StructRNA *type);
507
508 PropertyRNA *RNA_struct_name_property(StructRNA *type);
509 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
510 StructRNA *RNA_struct_base(StructRNA *type);
511
512 int RNA_struct_is_ID(StructRNA *type);
513 int RNA_struct_is_a(StructRNA *type, StructRNA *srna);
514
515 StructRegisterFunc RNA_struct_register(StructRNA *type);
516 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
517
518 void *RNA_struct_py_type_get(StructRNA *srna);
519 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
520
521 void *RNA_struct_blender_type_get(StructRNA *srna);
522 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
523
524 struct IDProperty *RNA_struct_idproperties(PointerRNA *ptr, int create);
525
526 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
527 const struct ListBase *RNA_struct_defined_properties(StructRNA *srna);
528
529 FunctionRNA *RNA_struct_find_function(PointerRNA *ptr, const char *identifier);
530 const struct ListBase *RNA_struct_defined_functions(StructRNA *srna);
531
532 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen);
533
534 /* Properties
535  *
536  * Access to struct properties. All this works with RNA pointers rather than
537  * direct pointers to the data. */
538
539 /* Property Information */
540
541 const char *RNA_property_identifier(PropertyRNA *prop);
542 PropertyType RNA_property_type(PropertyRNA *prop);
543 PropertySubType RNA_property_subtype(PropertyRNA *prop);
544 int RNA_property_flag(PropertyRNA *prop);
545
546 int RNA_property_array_length(PropertyRNA *prop);
547
548 int RNA_property_string_maxlength(PropertyRNA *prop);
549
550 const char *RNA_property_ui_name(PropertyRNA *prop);
551 const char *RNA_property_ui_description(PropertyRNA *prop);
552 int RNA_property_ui_icon(PropertyRNA *prop);
553
554 /* Dynamic Property Information */
555
556 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
557 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
558
559 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
560 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
561
562 int RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier);
563 int RNA_enum_name(EnumPropertyItem *item, const int value, const char **name);
564
565 void RNA_property_enum_items(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
566 int RNA_property_enum_value(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
567 int RNA_property_enum_identifier(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
568
569 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
570
571 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
572 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
573 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
574
575 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
576
577 /* Property Data */
578
579 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
580 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
581 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
582 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
583 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
584 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
585
586 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
587 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
588 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
589 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
590 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
591 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
592
593 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
594 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
595 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
596 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
597 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
598 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
599
600 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
601 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
602 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
603 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
604
605 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
606 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
607
608 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
609 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
610
611 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
612 void RNA_property_collection_next(CollectionPropertyIterator *iter);
613 void RNA_property_collection_end(CollectionPropertyIterator *iter);
614 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
615 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
616 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
617
618 /* efficient functions to set properties for arrays */
619 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array);
620 int RNA_property_collection_raw_get(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, char *propname, void *array, RawPropertyType type, int len);
621 int RNA_property_collection_raw_set(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, char *propname, void *array, RawPropertyType type, int len);
622 int RNA_raw_type_sizeof(RawPropertyType type);
623 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
624
625
626 /* to create ID property groups */
627 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
628 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
629 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
630 void RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
631 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
632
633 /* Path
634  *
635  * Experimental method to refer to structs and properties with a string,
636  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
637  *
638  * This provides a way to refer to RNA data while being detached from any
639  * particular pointers, which is useful in a number of applications, like
640  * UI code or Actions, though efficiency is a concern. */
641
642 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
643         int intkey, const char *strkey);
644 char *RNA_path_back(const char *path);
645
646 int RNA_path_resolve(PointerRNA *ptr, const char *path,
647         PointerRNA *r_ptr, PropertyRNA **r_prop);
648
649 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
650
651 #if 0
652 /* Dependency
653  *
654  * Experimental code that will generate callbacks for each dependency
655  * between ID types. This may end up being useful for UI
656  * and evaluation code that needs to know such dependencies for correct
657  * redraws and re-evaluations. */
658
659 typedef void (*PropDependencyCallback)(void *udata, PointerRNA *from, PointerRNA *to);
660 void RNA_test_dependencies_cb(void *udata, PointerRNA *from, PointerRNA *to);
661
662 void RNA_generate_dependencies(PointerRNA *mainptr, void *udata, PropDependencyCallback cb);
663 #endif
664
665 /* Quick name based property access
666  *
667  * These are just an easier way to access property values without having to
668  * call RNA_struct_find_property. The names have to exist as RNA properties
669  * for the type in the pointer, if they do not exist an error will be printed.
670  *
671  * There is no support for pointers and collections here yet, these can be 
672  * added when ID properties support them. */
673
674 int RNA_boolean_get(PointerRNA *ptr, const char *name);
675 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
676 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
677 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
678
679 int RNA_int_get(PointerRNA *ptr, const char *name);
680 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
681 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
682 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
683
684 float RNA_float_get(PointerRNA *ptr, const char *name);
685 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
686 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
687 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
688
689 int RNA_enum_get(PointerRNA *ptr, const char *name);
690 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
691 int RNA_enum_is_equal(struct bContext *C, PointerRNA *ptr, const char *name, const char *enumname);
692
693 /* lower level functions that donr use a PointerRNA */
694 int     RNA_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value);
695 int     RNA_enum_id_from_value(EnumPropertyItem *item, int value, const char **identifier);
696
697 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
698 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
699 int RNA_string_length(PointerRNA *ptr, const char *name);
700 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
701
702 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
703 void RNA_pointer_add(PointerRNA *ptr, const char *name);
704
705 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
706 int RNA_collection_length(PointerRNA *ptr, const char *name);
707 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
708 void RNA_collection_clear(PointerRNA *ptr, const char *name);
709
710 #define RNA_BEGIN(sptr, itemptr, propname) \
711         { \
712                 CollectionPropertyIterator rna_macro_iter; \
713                 for(RNA_collection_begin(sptr, propname, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
714                         PointerRNA itemptr= rna_macro_iter.ptr;
715
716 #define RNA_END \
717                 } \
718                 RNA_property_collection_end(&rna_macro_iter); \
719         }
720
721 #define RNA_PROP_BEGIN(sptr, itemptr, prop) \
722         { \
723                 CollectionPropertyIterator rna_macro_iter; \
724                 for(RNA_property_collection_begin(sptr, prop, &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
725                         PointerRNA itemptr= rna_macro_iter.ptr;
726
727 #define RNA_PROP_END \
728                 } \
729                 RNA_property_collection_end(&rna_macro_iter); \
730         }
731
732 #define RNA_STRUCT_BEGIN(sptr, prop) \
733         { \
734                 CollectionPropertyIterator rna_macro_iter; \
735                 for(RNA_property_collection_begin(sptr, RNA_struct_iterator_property(sptr->type), &rna_macro_iter); rna_macro_iter.valid; RNA_property_collection_next(&rna_macro_iter)) { \
736                         PropertyRNA *prop= rna_macro_iter.ptr.data;
737
738 #define RNA_STRUCT_END \
739                 } \
740                 RNA_property_collection_end(&rna_macro_iter); \
741         }
742
743 /* check if the idproperty exists, for operators */
744 int RNA_property_is_set(PointerRNA *ptr, const char *name);
745
746 /* python compatible string representation of this property, (must be freed!) */
747 char *RNA_property_as_string(PointerRNA *ptr, PropertyRNA *prop);
748 char *RNA_pointer_as_string(PointerRNA *ptr);
749
750 /* Function */
751
752 const char *RNA_function_identifier(FunctionRNA *func);
753 PropertyRNA *RNA_function_return(FunctionRNA *func);
754 const char *RNA_function_ui_description(FunctionRNA *func);
755 int RNA_function_flag(FunctionRNA *func);
756
757 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
758 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier);
759 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
760
761 /* Utility */
762
763 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
764 void RNA_parameter_list_free(ParameterList *parms);
765 int  RNA_parameter_list_size(ParameterList *parms);
766
767 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
768 void RNA_parameter_list_next(ParameterIterator *iter);
769 void RNA_parameter_list_end(ParameterIterator *iter);
770
771 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
772 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
773 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, void *value);
774 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, void *value);
775
776 int RNA_function_call(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms);
777 int RNA_function_call_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms);
778
779 int RNA_function_call_direct(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...);
780 int RNA_function_call_direct_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...);
781 int RNA_function_call_direct_va(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args);
782 int RNA_function_call_direct_va_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args);
783
784 /* ID */
785
786 short RNA_type_to_ID_code(StructRNA *type);
787 StructRNA *ID_code_to_RNA_type(short idcode);
788
789 #ifdef __cplusplus
790 }
791 #endif
792
793 #endif /* RNA_ACCESS */
794