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