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