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