Py-Driver: add 'self' option
[blender.git] / source / blender / makesrna / RNA_access.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __RNA_ACCESS_H__
24 #define __RNA_ACCESS_H__
25
26 /** \file RNA_access.h
27  *  \ingroup RNA
28  */
29
30 #include <stdarg.h>
31
32 #include "RNA_types.h"
33
34 #include "BLI_compiler_attrs.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct bContext;
41 struct ID;
42 struct ListBase;
43 struct Main;
44 struct ReportList;
45 struct Scene;
46
47 /* Types */
48
49 extern BlenderRNA BLENDER_RNA;
50 extern StructRNA RNA_Action;
51 extern StructRNA RNA_ActionConstraint;
52 extern StructRNA RNA_ActionFCurves;
53 extern StructRNA RNA_ActionGroup;
54 extern StructRNA RNA_ActionGroups;
55 extern StructRNA RNA_ActionPoseMarkers;
56 extern StructRNA RNA_Actuator;
57 extern StructRNA RNA_ActuatorSensor;
58 extern StructRNA RNA_Addon;
59 extern StructRNA RNA_AddonPreferences;
60 extern StructRNA RNA_AdjustmentSequence;
61 extern StructRNA RNA_AlwaysSensor;
62 extern StructRNA RNA_AndController;
63 extern StructRNA RNA_AnimData;
64 extern StructRNA RNA_AnimViz;
65 extern StructRNA RNA_AnimVizMotionPaths;
66 extern StructRNA RNA_AnimVizOnionSkinning;
67 extern StructRNA RNA_AnyType;
68 extern StructRNA RNA_Area;
69 extern StructRNA RNA_AreaLamp;
70 extern StructRNA RNA_Armature;
71 extern StructRNA RNA_ArmatureModifier;
72 extern StructRNA RNA_ArmatureSensor;
73 extern StructRNA RNA_ArrayModifier;
74 extern StructRNA RNA_BackgroundImage;
75 extern StructRNA RNA_BevelModifier;
76 extern StructRNA RNA_SplinePoint;
77 extern StructRNA RNA_BezierSplinePoint;
78 extern StructRNA RNA_BlendData;
79 extern StructRNA RNA_BlendTexture;
80 extern StructRNA RNA_BlenderRNA;
81 extern StructRNA RNA_BoidRule;
82 extern StructRNA RNA_BoidRuleAverageSpeed;
83 extern StructRNA RNA_BoidRuleAvoid;
84 extern StructRNA RNA_BoidRuleAvoidCollision;
85 extern StructRNA RNA_BoidRuleFight;
86 extern StructRNA RNA_BoidRuleFollowLeader;
87 extern StructRNA RNA_BoidRuleGoal;
88 extern StructRNA RNA_BoidSettings;
89 extern StructRNA RNA_BoidState;
90 extern StructRNA RNA_Bone;
91 extern StructRNA RNA_BoneGroup;
92 extern StructRNA RNA_BooleanModifier;
93 extern StructRNA RNA_BoolProperty;
94 extern StructRNA RNA_Brush;
95 extern StructRNA RNA_BrushTextureSlot;
96 extern StructRNA RNA_BuildModifier;
97 extern StructRNA RNA_MeshCacheModifier;
98 extern StructRNA RNA_Camera;
99 extern StructRNA RNA_CastModifier;
100 extern StructRNA RNA_ChildOfConstraint;
101 extern StructRNA RNA_ChildParticle;
102 extern StructRNA RNA_ClampToConstraint;
103 extern StructRNA RNA_ClothCollisionSettings;
104 extern StructRNA RNA_ClothModifier;
105 extern StructRNA RNA_ClothSettings;
106 extern StructRNA RNA_CloudsTexture;
107 extern StructRNA RNA_CollectionProperty;
108 extern StructRNA RNA_CollisionModifier;
109 extern StructRNA RNA_CollisionSensor;
110 extern StructRNA RNA_CollisionSettings;
111 extern StructRNA RNA_ColorManagedInputColorspaceSettings;
112 extern StructRNA RNA_ColorManagedSequencerColorspaceSettings;
113 extern StructRNA RNA_ColorManagedDisplaySettings;
114 extern StructRNA RNA_ColorManagedViewSettings;
115 extern StructRNA RNA_ColorRamp;
116 extern StructRNA RNA_ColorRampElement;
117 extern StructRNA RNA_ColorSequence;
118 extern StructRNA RNA_CompositorNode;
119 extern StructRNA RNA_CompositorNodeAlphaOver;
120 extern StructRNA RNA_CompositorNodeBilateralblur;
121 extern StructRNA RNA_CompositorNodeBlur;
122 extern StructRNA RNA_CompositorNodeBrightContrast;
123 extern StructRNA RNA_CompositorNodeChannelMatte;
124 extern StructRNA RNA_CompositorNodeChromaMatte;
125 extern StructRNA RNA_CompositorNodeColorMatte;
126 extern StructRNA RNA_CompositorNodeColorSpill;
127 extern StructRNA RNA_CompositorNodeCombHSVA;
128 extern StructRNA RNA_CompositorNodeCombRGBA;
129 extern StructRNA RNA_CompositorNodeCombYCCA;
130 extern StructRNA RNA_CompositorNodeCombYUVA;
131 extern StructRNA RNA_CompositorNodeComposite;
132 extern StructRNA RNA_CompositorNodeCrop;
133 extern StructRNA RNA_CompositorNodeCurveRGB;
134 extern StructRNA RNA_CompositorNodeCurveVec;
135 extern StructRNA RNA_CompositorNodeDBlur;
136 extern StructRNA RNA_CompositorNodeDefocus;
137 extern StructRNA RNA_CompositorNodeDiffMatte;
138 extern StructRNA RNA_CompositorNodeDilateErode;
139 extern StructRNA RNA_CompositorNodeDisplace;
140 extern StructRNA RNA_CompositorNodeDistanceMatte;
141 extern StructRNA RNA_CompositorNodeFilter;
142 extern StructRNA RNA_CompositorNodeFlip;
143 extern StructRNA RNA_CompositorNodeGamma;
144 extern StructRNA RNA_CompositorNodeGlare;
145 extern StructRNA RNA_CompositorNodeHueSat;
146 extern StructRNA RNA_CompositorNodeIDMask;
147 extern StructRNA RNA_CompositorNodeDoubleEdgeMask;
148 extern StructRNA RNA_CompositorNodeImage;
149 extern StructRNA RNA_CompositorNodeInpaint;
150 extern StructRNA RNA_CompositorNodeInvert;
151 extern StructRNA RNA_CompositorNodeLensdist;
152 extern StructRNA RNA_CompositorNodeLevels;
153 extern StructRNA RNA_CompositorNodeLumaMatte;
154 extern StructRNA RNA_CompositorNodeMapUV;
155 extern StructRNA RNA_CompositorNodeMapValue;
156 extern StructRNA RNA_CompositorNodeMapRange;
157 extern StructRNA RNA_CompositorNodeMath;
158 extern StructRNA RNA_CompositorNodeMask;
159 extern StructRNA RNA_CompositorNodeMixRGB;
160 extern StructRNA RNA_CompositorNodeNormal;
161 extern StructRNA RNA_CompositorNodeNormalize;
162 extern StructRNA RNA_CompositorNodeOutputFile;
163 extern StructRNA RNA_CompositorNodePremulKey;
164 extern StructRNA RNA_CompositorNodeRGB;
165 extern StructRNA RNA_CompositorNodeRGBToBW;
166 extern StructRNA RNA_CompositorNodeRLayers;
167 extern StructRNA RNA_CompositorNodeRotate;
168 extern StructRNA RNA_CompositorNodeScale;
169 extern StructRNA RNA_CompositorNodeSepHSVA;
170 extern StructRNA RNA_CompositorNodeSepRGBA;
171 extern StructRNA RNA_CompositorNodeSepYCCA;
172 extern StructRNA RNA_CompositorNodeSepYUVA;
173 extern StructRNA RNA_CompositorNodeSetAlpha;
174 extern StructRNA RNA_CompositorNodeSplitViewer;
175 extern StructRNA RNA_CompositorNodeSwitchView;
176 extern StructRNA RNA_CompositorNodeTexture;
177 extern StructRNA RNA_CompositorNodeTime;
178 extern StructRNA RNA_CompositorNodeTonemap;
179 extern StructRNA RNA_CompositorNodeTranslate;
180 extern StructRNA RNA_CompositorNodeTree;
181 extern StructRNA RNA_CompositorNodeValToRGB;
182 extern StructRNA RNA_CompositorNodeValue;
183 extern StructRNA RNA_CompositorNodeVecBlur;
184 extern StructRNA RNA_CompositorNodeViewer;
185 extern StructRNA RNA_CompositorNodeZcombine;
186 extern StructRNA RNA_ConsoleLine;
187 extern StructRNA RNA_Constraint;
188 extern StructRNA RNA_ConstraintTarget;
189 extern StructRNA RNA_Context;
190 extern StructRNA RNA_ControlFluidSettings;
191 extern StructRNA RNA_Controller;
192 extern StructRNA RNA_CopyLocationConstraint;
193 extern StructRNA RNA_CopyRotationConstraint;
194 extern StructRNA RNA_CopyScaleConstraint;
195 extern StructRNA RNA_CopyTransformsConstraint;
196 extern StructRNA RNA_Curve;
197 extern StructRNA RNA_CurveMap;
198 extern StructRNA RNA_CurveMapPoint;
199 extern StructRNA RNA_CurveMapping;
200 extern StructRNA RNA_CurveModifier;
201 extern StructRNA RNA_CurvePoint;
202 extern StructRNA RNA_DampedTrackConstraint;
203 extern StructRNA RNA_DataTransferModifier;
204 extern StructRNA RNA_DecimateModifier;
205 extern StructRNA RNA_DelaySensor;
206 extern StructRNA RNA_CorrectiveSmoothModifier;
207 extern StructRNA RNA_DisplaceModifier;
208 extern StructRNA RNA_DisplaySafeAreas;
209 extern StructRNA RNA_DistortedNoiseTexture;
210 extern StructRNA RNA_DomainFluidSettings;
211 extern StructRNA RNA_DopeSheet;
212 extern StructRNA RNA_Driver;
213 extern StructRNA RNA_DriverTarget;
214 extern StructRNA RNA_DriverVariable;
215 extern StructRNA RNA_DupliObject;
216 extern StructRNA RNA_DynamicPaintBrushSettings;
217 extern StructRNA RNA_DynamicPaintCanvasSettings;
218 extern StructRNA RNA_DynamicPaintModifier;
219 extern StructRNA RNA_DynamicPaintSurface;
220 extern StructRNA RNA_EdgeSplitModifier;
221 extern StructRNA RNA_EditBone;
222 extern StructRNA RNA_EffectSequence;
223 extern StructRNA RNA_EffectorWeights;
224 extern StructRNA RNA_EnumProperty;
225 extern StructRNA RNA_EnumPropertyItem;
226 extern StructRNA RNA_EnvironmentMap;
227 extern StructRNA RNA_EnvironmentMapTexture;
228 extern StructRNA RNA_Event;
229 extern StructRNA RNA_ExplodeModifier;
230 extern StructRNA RNA_ExpressionController;
231 extern StructRNA RNA_FCurve;
232 extern StructRNA RNA_FCurveSample;
233 extern StructRNA RNA_FFmpegSettings;
234 extern StructRNA RNA_FModifier;
235 extern StructRNA RNA_FModifierCycles;
236 extern StructRNA RNA_FModifierEnvelope;
237 extern StructRNA RNA_FModifierEnvelopeControlPoint;
238 extern StructRNA RNA_FModifierFunctionGenerator;
239 extern StructRNA RNA_FModifierGenerator;
240 extern StructRNA RNA_FModifierLimits;
241 extern StructRNA RNA_FModifierNoise;
242 extern StructRNA RNA_FModifierPython;
243 extern StructRNA RNA_FModifierStepped;
244 extern StructRNA RNA_FieldSettings;
245 extern StructRNA RNA_FileBrowserFSMenuEntry;
246 extern StructRNA RNA_FileSelectParams;
247 extern StructRNA RNA_FloatProperty;
248 extern StructRNA RNA_FloorConstraint;
249 extern StructRNA RNA_FluidFluidSettings;
250 extern StructRNA RNA_FluidSettings;
251 extern StructRNA RNA_FluidSimulationModifier;
252 extern StructRNA RNA_FollowPathConstraint;
253 extern StructRNA RNA_FreestyleLineStyle;
254 extern StructRNA RNA_FreestyleLineSet;
255 extern StructRNA RNA_FreestyleModuleSettings;
256 extern StructRNA RNA_FreestyleSettings;
257 extern StructRNA RNA_Function;
258 extern StructRNA RNA_GPencilFrame;
259 extern StructRNA RNA_GPencilLayer;
260 extern StructRNA RNA_GPencilStroke;
261 extern StructRNA RNA_GPencilStrokePoint;
262 extern StructRNA RNA_GPencilSculptSettings;
263 extern StructRNA RNA_GPencilSculptBrush;
264 extern StructRNA RNA_GameBooleanProperty;
265 extern StructRNA RNA_GameFloatProperty;
266 extern StructRNA RNA_GameIntProperty;
267 extern StructRNA RNA_GameObjectSettings;
268 extern StructRNA RNA_GameProperty;
269 extern StructRNA RNA_GameSoftBodySettings;
270 extern StructRNA RNA_GameStringProperty;
271 extern StructRNA RNA_GameTimerProperty;
272 extern StructRNA RNA_GaussianBlurSequence;
273 extern StructRNA RNA_GlowSequence;
274 extern StructRNA RNA_GreasePencil;
275 extern StructRNA RNA_Group;
276 extern StructRNA RNA_Header;
277 extern StructRNA RNA_HemiLamp;
278 extern StructRNA RNA_Histogram;
279 extern StructRNA RNA_HookModifier;
280 extern StructRNA RNA_ID;
281 extern StructRNA RNA_IKParam;
282 extern StructRNA RNA_Image;
283 extern StructRNA RNA_ImageFormatSettings;
284 extern StructRNA RNA_ImagePaint;
285 extern StructRNA RNA_ImagePreview;
286 extern StructRNA RNA_ImageSequence;
287 extern StructRNA RNA_ImageTexture;
288 extern StructRNA RNA_ImageUser;
289 extern StructRNA RNA_ImapaintToolCapabilities;
290 extern StructRNA RNA_InflowFluidSettings;
291 extern StructRNA RNA_IntProperty;
292 extern StructRNA RNA_Itasc;
293 extern StructRNA RNA_JoystickSensor;
294 extern StructRNA RNA_Key;
295 extern StructRNA RNA_KeyConfig;
296 extern StructRNA RNA_KeyMap;
297 extern StructRNA RNA_KeyMapItem;
298 extern StructRNA RNA_KeyMapItems;
299 extern StructRNA RNA_KeyboardSensor;
300 extern StructRNA RNA_Keyframe;
301 extern StructRNA RNA_KeyingSet;
302 extern StructRNA RNA_KeyingSetInfo;
303 extern StructRNA RNA_KeyingSetPath;
304 extern StructRNA RNA_KeyingSetsAll;
305 extern StructRNA RNA_KinematicConstraint;
306 extern StructRNA RNA_Lamp;
307 extern StructRNA RNA_LampSkySettings;
308 extern StructRNA RNA_LampTextureSlot;
309 extern StructRNA RNA_LaplacianDeformModifier;
310 extern StructRNA RNA_LaplacianSmoothModifier;
311 extern StructRNA RNA_Lattice;
312 extern StructRNA RNA_LatticeModifier;
313 extern StructRNA RNA_LatticePoint;
314 extern StructRNA RNA_Library;
315 extern StructRNA RNA_LimitDistanceConstraint;
316 extern StructRNA RNA_LimitLocationConstraint;
317 extern StructRNA RNA_LimitRotationConstraint;
318 extern StructRNA RNA_LimitScaleConstraint;
319 extern StructRNA RNA_LineStyleAlphaModifier;
320 extern StructRNA RNA_LineStyleAlphaModifier_AlongStroke;
321 extern StructRNA RNA_LineStyleAlphaModifier_CreaseAngle;
322 extern StructRNA RNA_LineStyleAlphaModifier_Curvature_3D;
323 extern StructRNA RNA_LineStyleAlphaModifier_DistanceFromCamera;
324 extern StructRNA RNA_LineStyleAlphaModifier_DistanceFromObject;
325 extern StructRNA RNA_LineStyleAlphaModifier_Material;
326 extern StructRNA RNA_LineStyleAlphaModifier_Noise;
327 extern StructRNA RNA_LineStyleAlphaModifier_Tangent;
328 extern StructRNA RNA_LineStyleColorModifier;
329 extern StructRNA RNA_LineStyleColorModifier_AlongStroke;
330 extern StructRNA RNA_LineStyleColorModifier_CreaseAngle;
331 extern StructRNA RNA_LineStyleColorModifier_Curvature_3D;
332 extern StructRNA RNA_LineStyleColorModifier_DistanceFromCamera;
333 extern StructRNA RNA_LineStyleColorModifier_DistanceFromObject;
334 extern StructRNA RNA_LineStyleColorModifier_Material;
335 extern StructRNA RNA_LineStyleColorModifier_Noise;
336 extern StructRNA RNA_LineStyleColorModifier_Tangent;
337 extern StructRNA RNA_LineStyleGeometryModifier;
338 extern StructRNA RNA_LineStyleGeometryModifier_2DOffset;
339 extern StructRNA RNA_LineStyleGeometryModifier_2DTransform;
340 extern StructRNA RNA_LineStyleGeometryModifier_BackboneStretcher;
341 extern StructRNA RNA_LineStyleGeometryModifier_BezierCurve;
342 extern StructRNA RNA_LineStyleGeometryModifier_Blueprint;
343 extern StructRNA RNA_LineStyleGeometryModifier_GuidingLines;
344 extern StructRNA RNA_LineStyleGeometryModifier_PerlinNoise1D;
345 extern StructRNA RNA_LineStyleGeometryModifier_PerlinNoise2D;
346 extern StructRNA RNA_LineStyleGeometryModifier_Polygonalization;
347 extern StructRNA RNA_LineStyleGeometryModifier_Sampling;
348 extern StructRNA RNA_LineStyleGeometryModifier_Simplification;
349 extern StructRNA RNA_LineStyleGeometryModifier_SinusDisplacement;
350 extern StructRNA RNA_LineStyleGeometryModifier_SpatialNoise;
351 extern StructRNA RNA_LineStyleGeometryModifier_TipRemover;
352 extern StructRNA RNA_LineStyleModifier;
353 extern StructRNA RNA_LineStyleTextureSlot;
354 extern StructRNA RNA_LineStyleThicknessModifier;
355 extern StructRNA RNA_LineStyleThicknessModifier_AlongStroke;
356 extern StructRNA RNA_LineStyleThicknessModifier_Calligraphy;
357 extern StructRNA RNA_LineStyleThicknessModifier_CreaseAngle;
358 extern StructRNA RNA_LineStyleThicknessModifier_Curvature_3D;
359 extern StructRNA RNA_LineStyleThicknessModifier_DistanceFromCamera;
360 extern StructRNA RNA_LineStyleThicknessModifier_DistanceFromObject;
361 extern StructRNA RNA_LineStyleThicknessModifier_Material;
362 extern StructRNA RNA_LineStyleThicknessModifier_Noise;
363 extern StructRNA RNA_LineStyleThicknessModifier_Tangent;
364 extern StructRNA RNA_LockedTrackConstraint;
365 extern StructRNA RNA_Macro;
366 extern StructRNA RNA_MagicTexture;
367 extern StructRNA RNA_MarbleTexture;
368 extern StructRNA RNA_MaskModifier;
369 extern StructRNA RNA_MaskSequence;
370 extern StructRNA RNA_Material;
371 extern StructRNA RNA_MaterialHalo;
372 extern StructRNA RNA_MaterialPhysics;
373 extern StructRNA RNA_MaterialRaytraceMirror;
374 extern StructRNA RNA_MaterialRaytraceTransparency;
375 extern StructRNA RNA_MaterialSlot;
376 extern StructRNA RNA_MaterialStrand;
377 extern StructRNA RNA_MaterialSubsurfaceScattering;
378 extern StructRNA RNA_MaterialTextureSlot;
379 extern StructRNA RNA_MaterialVolume;
380 extern StructRNA RNA_Mask;
381 extern StructRNA RNA_MaskLayer;
382 extern StructRNA RNA_Menu;
383 extern StructRNA RNA_Mesh;
384 extern StructRNA RNA_MeshColor;
385 extern StructRNA RNA_MeshColorLayer;
386 extern StructRNA RNA_MeshLoopColorLayer;
387 extern StructRNA RNA_MeshDeformModifier;
388 extern StructRNA RNA_MeshEdge;
389 extern StructRNA RNA_MeshPolygon;
390 extern StructRNA RNA_MeshTessFace;
391 extern StructRNA RNA_MeshLoop;
392 extern StructRNA RNA_MeshFloatProperty;
393 extern StructRNA RNA_MeshFloatPropertyLayer;
394 extern StructRNA RNA_MeshIntProperty;
395 extern StructRNA RNA_MeshIntPropertyLayer;
396 extern StructRNA RNA_MeshSkinVertexLayer;
397 extern StructRNA RNA_MeshSkinVertex;
398 extern StructRNA RNA_MeshSticky;
399 extern StructRNA RNA_MeshStringProperty;
400 extern StructRNA RNA_MeshStringPropertyLayer;
401 extern StructRNA RNA_MeshTextureFace;
402 extern StructRNA RNA_MeshTextureFaceLayer;
403 extern StructRNA RNA_MeshTexturePoly;
404 extern StructRNA RNA_MeshTexturePolyLayer;
405 extern StructRNA RNA_MeshVertex;
406 extern StructRNA RNA_MessageSensor;
407 extern StructRNA RNA_MetaBall;
408 extern StructRNA RNA_MetaElement;
409 extern StructRNA RNA_MetaSequence;
410 extern StructRNA RNA_MirrorModifier;
411 extern StructRNA RNA_Modifier;
412 extern StructRNA RNA_MotionPath;
413 extern StructRNA RNA_MotionPathVert;
414 extern StructRNA RNA_MouseSensor;
415 extern StructRNA RNA_MovieSequence;
416 extern StructRNA RNA_MovieClipSequence;
417 extern StructRNA RNA_MovieTracking;
418 extern StructRNA RNA_MovieTrackingObject;
419 extern StructRNA RNA_MovieTrackingTrack;
420 extern StructRNA RNA_MulticamSequence;
421 extern StructRNA RNA_MultiresModifier;
422 extern StructRNA RNA_MusgraveTexture;
423 extern StructRNA RNA_NandController;
424 extern StructRNA RNA_NearSensor;
425 extern StructRNA RNA_NlaStrip;
426 extern StructRNA RNA_NlaTrack;
427 extern StructRNA RNA_Node;
428 extern StructRNA RNA_NodeOutputFileSlotFile;
429 extern StructRNA RNA_NodeOutputFileSlotLayer;
430 extern StructRNA RNA_NodeInstanceHash;
431 extern StructRNA RNA_NodeLink;
432 extern StructRNA RNA_NodeSocket;
433 extern StructRNA RNA_NodeSocketInterface;
434 extern StructRNA RNA_NodeTree;
435 extern StructRNA RNA_NoiseTexture;
436 extern StructRNA RNA_NorController;
437 extern StructRNA RNA_Object;
438 extern StructRNA RNA_ObjectBase;
439 extern StructRNA RNA_ObstacleFluidSettings;
440 extern StructRNA RNA_OceanModifier;
441 extern StructRNA RNA_OceanTexData;
442 extern StructRNA RNA_OceanTexture;
443 extern StructRNA RNA_Operator;
444 extern StructRNA RNA_OperatorFileListElement;
445 extern StructRNA RNA_OperatorMousePath;
446 extern StructRNA RNA_OperatorProperties;
447 extern StructRNA RNA_OperatorStrokeElement;
448 extern StructRNA RNA_OperatorMacro;
449 extern StructRNA RNA_OrController;
450 extern StructRNA RNA_OutflowFluidSettings;
451 extern StructRNA RNA_PackedFile;
452 extern StructRNA RNA_Paint;
453 extern StructRNA RNA_PaintCurve;
454 extern StructRNA RNA_Palette;
455 extern StructRNA RNA_PaletteColor;
456 extern StructRNA RNA_Panel;
457 extern StructRNA RNA_Particle;
458 extern StructRNA RNA_ParticleBrush;
459 extern StructRNA RNA_ParticleDupliWeight;
460 extern StructRNA RNA_ParticleEdit;
461 extern StructRNA RNA_ParticleFluidSettings;
462 extern StructRNA RNA_ParticleHairKey;
463 extern StructRNA RNA_ParticleInstanceModifier;
464 extern StructRNA RNA_ParticleKey;
465 extern StructRNA RNA_ParticleSettings;
466 extern StructRNA RNA_ParticleSettingsTextureSlot;
467 extern StructRNA RNA_ParticleSystem;
468 extern StructRNA RNA_ParticleSystemModifier;
469 extern StructRNA RNA_ParticleTarget;
470 extern StructRNA RNA_PivotConstraint;
471 extern StructRNA RNA_PointCache;
472 extern StructRNA RNA_PointDensity;
473 extern StructRNA RNA_PointDensityTexture;
474 extern StructRNA RNA_PointLamp;
475 extern StructRNA RNA_PointerProperty;
476 extern StructRNA RNA_Pose;
477 extern StructRNA RNA_PoseBone;
478 extern StructRNA RNA_Property;
479 extern StructRNA RNA_PropertyGroup;
480 extern StructRNA RNA_PropertyGroupItem;
481 extern StructRNA RNA_PropertySensor;
482 extern StructRNA RNA_PythonConstraint;
483 extern StructRNA RNA_PythonController;
484 extern StructRNA RNA_QuickTimeSettings;
485 extern StructRNA RNA_RadarSensor;
486 extern StructRNA RNA_RandomSensor;
487 extern StructRNA RNA_RaySensor;
488 extern StructRNA RNA_Region;
489 extern StructRNA RNA_RenderEngine;
490 extern StructRNA RNA_RenderLayer;
491 extern StructRNA RNA_RenderPass;
492 extern StructRNA RNA_RenderResult;
493 extern StructRNA RNA_RenderSettings;
494 extern StructRNA RNA_RigidBodyWorld;
495 extern StructRNA RNA_RigidBodyObject;
496 extern StructRNA RNA_RigidBodyJointConstraint;
497 extern StructRNA RNA_SPHFluidSettings;
498 extern StructRNA RNA_Scene;
499 extern StructRNA RNA_SceneGameData;
500 extern StructRNA RNA_SceneRenderLayer;
501 extern StructRNA RNA_SceneSequence;
502 extern StructRNA RNA_SceneObjects;
503 extern StructRNA RNA_Scopes;
504 extern StructRNA RNA_Screen;
505 extern StructRNA RNA_ScrewModifier;
506 extern StructRNA RNA_Sculpt;
507 extern StructRNA RNA_SelectedUvElement;
508 extern StructRNA RNA_Sensor;
509 extern StructRNA RNA_Sequence;
510 extern StructRNA RNA_SequenceColorBalance;
511 extern StructRNA RNA_SequenceCrop;
512 extern StructRNA RNA_SequenceEditor;
513 extern StructRNA RNA_SequenceElement;
514 extern StructRNA RNA_SequenceProxy;
515 extern StructRNA RNA_SequenceTransform;
516 extern StructRNA RNA_NormalEditModifier;
517 extern StructRNA RNA_ShaderNode;
518 extern StructRNA RNA_ShaderNodeCameraData;
519 extern StructRNA RNA_ShaderNodeCombineRGB;
520 extern StructRNA RNA_ShaderNodeExtendedMaterial;
521 extern StructRNA RNA_ShaderNodeGeometry;
522 extern StructRNA RNA_ShaderNodeHueSaturation;
523 extern StructRNA RNA_ShaderNodeInvert;
524 extern StructRNA RNA_ShaderNodeLampData;
525 extern StructRNA RNA_ShaderNodeMapping;
526 extern StructRNA RNA_ShaderNodeMaterial;
527 extern StructRNA RNA_ShaderNodeMath;
528 extern StructRNA RNA_ShaderNodeMixRGB;
529 extern StructRNA RNA_ShaderNodeNormal;
530 extern StructRNA RNA_ShaderNodeGamma;
531 extern StructRNA RNA_ShaderNodeOutput;
532 extern StructRNA RNA_ShaderNodeScript;
533 extern StructRNA RNA_ShaderNodeRGB;
534 extern StructRNA RNA_ShaderNodeRGBCurve;
535 extern StructRNA RNA_ShaderNodeRGBToBW;
536 extern StructRNA RNA_ShaderNodeSeparateRGB;
537 extern StructRNA RNA_ShaderNodeSqueeze;
538 extern StructRNA RNA_ShaderNodeTexture;
539 extern StructRNA RNA_ShaderNodeTree;
540 extern StructRNA RNA_ShaderNodeValToRGB;
541 extern StructRNA RNA_ShaderNodeValue;
542 extern StructRNA RNA_ShaderNodeVectorCurve;
543 extern StructRNA RNA_ShaderNodeVectorMath;
544 extern StructRNA RNA_ShapeKey;
545 extern StructRNA RNA_ShapeKeyBezierPoint;
546 extern StructRNA RNA_ShapeKeyCurvePoint;
547 extern StructRNA RNA_ShapeKeyPoint;
548 extern StructRNA RNA_ShrinkwrapConstraint;
549 extern StructRNA RNA_ShrinkwrapModifier;
550 extern StructRNA RNA_SimpleDeformModifier;
551 extern StructRNA RNA_SkinModifier;
552 extern StructRNA RNA_SmokeCollSettings;
553 extern StructRNA RNA_SmokeDomainSettings;
554 extern StructRNA RNA_SmokeFlowSettings;
555 extern StructRNA RNA_SmokeModifier;
556 extern StructRNA RNA_SmoothModifier;
557 extern StructRNA RNA_SoftBodyModifier;
558 extern StructRNA RNA_SoftBodySettings;
559 extern StructRNA RNA_SolidifyModifier;
560 extern StructRNA RNA_Sound;
561 extern StructRNA RNA_SoundSequence;
562 extern StructRNA RNA_Space;
563 extern StructRNA RNA_SpaceConsole;
564 extern StructRNA RNA_SpaceDopeSheetEditor;
565 extern StructRNA RNA_SpaceFileBrowser;
566 extern StructRNA RNA_SpaceGraphEditor;
567 extern StructRNA RNA_SpaceImageEditor;
568 extern StructRNA RNA_SpaceInfo;
569 extern StructRNA RNA_SpaceLogicEditor;
570 extern StructRNA RNA_SpaceNLA;
571 extern StructRNA RNA_SpaceNodeEditor;
572 extern StructRNA RNA_SpaceOutliner;
573 extern StructRNA RNA_SpaceProperties;
574 extern StructRNA RNA_SpaceSequenceEditor;
575 extern StructRNA RNA_SpaceTextEditor;
576 extern StructRNA RNA_SpaceTimeline;
577 extern StructRNA RNA_SpaceUVEditor;
578 extern StructRNA RNA_SpaceUserPreferences;
579 extern StructRNA RNA_SpaceView3D;
580 extern StructRNA RNA_SpaceClipEditor;
581 extern StructRNA RNA_Speaker;
582 extern StructRNA RNA_SpeedControlSequence;
583 extern StructRNA RNA_Spline;
584 extern StructRNA RNA_SplineIKConstraint;
585 extern StructRNA RNA_SpotLamp;
586 extern StructRNA RNA_Stereo3dDisplay;
587 extern StructRNA RNA_StretchToConstraint;
588 extern StructRNA RNA_StringProperty;
589 extern StructRNA RNA_Struct;
590 extern StructRNA RNA_StucciTexture;
591 extern StructRNA RNA_SubsurfModifier;
592 extern StructRNA RNA_SunLamp;
593 extern StructRNA RNA_SurfaceCurve;
594 extern StructRNA RNA_SurfaceModifier;
595 extern StructRNA RNA_TexMapping;
596 extern StructRNA RNA_Text;
597 extern StructRNA RNA_TextBox;
598 extern StructRNA RNA_TextCharacterFormat;
599 extern StructRNA RNA_TextCurve;
600 extern StructRNA RNA_TextLine;
601 extern StructRNA RNA_Texture;
602 extern StructRNA RNA_TextureNode;
603 extern StructRNA RNA_TextureNodeBricks;
604 extern StructRNA RNA_TextureNodeChecker;
605 extern StructRNA RNA_TextureNodeCompose;
606 extern StructRNA RNA_TextureNodeCoordinates;
607 extern StructRNA RNA_TextureNodeCurveRGB;
608 extern StructRNA RNA_TextureNodeCurveTime;
609 extern StructRNA RNA_TextureNodeDecompose;
610 extern StructRNA RNA_TextureNodeDistance;
611 extern StructRNA RNA_TextureNodeHueSaturation;
612 extern StructRNA RNA_TextureNodeImage;
613 extern StructRNA RNA_TextureNodeInvert;
614 extern StructRNA RNA_TextureNodeMath;
615 extern StructRNA RNA_TextureNodeMixRGB;
616 extern StructRNA RNA_TextureNodeOutput;
617 extern StructRNA RNA_TextureNodeRGBToBW;
618 extern StructRNA RNA_TextureNodeRotate;
619 extern StructRNA RNA_TextureNodeScale;
620 extern StructRNA RNA_TextureNodeTexture;
621 extern StructRNA RNA_TextureNodeTranslate;
622 extern StructRNA RNA_TextureNodeTree;
623 extern StructRNA RNA_TextureNodeValToNor;
624 extern StructRNA RNA_TextureNodeValToRGB;
625 extern StructRNA RNA_TextureNodeViewer;
626 extern StructRNA RNA_TextureSlot;
627 extern StructRNA RNA_Theme;
628 extern StructRNA RNA_ThemeAudioWindow;
629 extern StructRNA RNA_ThemeBoneColorSet;
630 extern StructRNA RNA_ThemeConsole;
631 extern StructRNA RNA_ThemeDopeSheet;
632 extern StructRNA RNA_ThemeFileBrowser;
633 extern StructRNA RNA_ThemeFontStyle;
634 extern StructRNA RNA_ThemeGraphEditor;
635 extern StructRNA RNA_ThemeImageEditor;
636 extern StructRNA RNA_ThemeInfo;
637 extern StructRNA RNA_ThemeLogicEditor;
638 extern StructRNA RNA_ThemeNLAEditor;
639 extern StructRNA RNA_ThemeNodeEditor;
640 extern StructRNA RNA_ThemeOutliner;
641 extern StructRNA RNA_ThemeProperties;
642 extern StructRNA RNA_ThemeSequenceEditor;
643 extern StructRNA RNA_TextSequence;
644 extern StructRNA RNA_ThemeSpaceGeneric;
645 extern StructRNA RNA_ThemeSpaceGradient;
646 extern StructRNA RNA_ThemeSpaceListGeneric;
647 extern StructRNA RNA_ThemeStyle;
648 extern StructRNA RNA_ThemeTextEditor;
649 extern StructRNA RNA_ThemeTimeline;
650 extern StructRNA RNA_ThemeUserInterface;
651 extern StructRNA RNA_ThemeUserPreferences;
652 extern StructRNA RNA_ThemeView3D;
653 extern StructRNA RNA_ThemeWidgetColors;
654 extern StructRNA RNA_ThemeWidgetStateColors;
655 extern StructRNA RNA_TimelineMarker;
656 extern StructRNA RNA_Timer;
657 extern StructRNA RNA_ToolSettings;
658 extern StructRNA RNA_TrackToConstraint;
659 extern StructRNA RNA_TransformConstraint;
660 extern StructRNA RNA_TransformSequence;
661 extern StructRNA RNA_UILayout;
662 extern StructRNA RNA_UIList;
663 extern StructRNA RNA_UIPieMenu;
664 extern StructRNA RNA_UIPopupMenu;
665 extern StructRNA RNA_UVWarpModifier;
666 extern StructRNA RNA_UVProjectModifier;
667 extern StructRNA RNA_UVProjector;
668 extern StructRNA RNA_UnitSettings;
669 extern StructRNA RNA_UnknownType;
670 extern StructRNA RNA_UserPreferences;
671 extern StructRNA RNA_UserPreferencesEdit;
672 extern StructRNA RNA_UserPreferencesFilePaths;
673 extern StructRNA RNA_UserPreferencesInput;
674 extern StructRNA RNA_UserPreferencesSystem;
675 extern StructRNA RNA_UserPreferencesView;
676 extern StructRNA RNA_UserPreferencesWalkNavigation;
677 extern StructRNA RNA_UserSolidLight;
678 extern StructRNA RNA_VectorFont;
679 extern StructRNA RNA_VertexGroup;
680 extern StructRNA RNA_VertexGroupElement;
681 extern StructRNA RNA_VertexPaint;
682 extern StructRNA RNA_VoronoiTexture;
683 extern StructRNA RNA_VoxelData;
684 extern StructRNA RNA_VoxelDataTexture;
685 extern StructRNA RNA_WarpModifier;
686 extern StructRNA RNA_WaveModifier;
687 extern StructRNA RNA_VertexWeightEditModifier;
688 extern StructRNA RNA_VertexWeightMixModifier;
689 extern StructRNA RNA_VertexWeightProximityModifier;
690 extern StructRNA RNA_Window;
691 extern StructRNA RNA_WindowManager;
692 extern StructRNA RNA_WipeSequence;
693 extern StructRNA RNA_WireframeModifier;
694 extern StructRNA RNA_WoodTexture;
695 extern StructRNA RNA_World;
696 extern StructRNA RNA_WorldAmbientOcclusion;
697 extern StructRNA RNA_WorldLighting;
698 extern StructRNA RNA_WorldMistSettings;
699 extern StructRNA RNA_WorldTextureSlot;
700 extern StructRNA RNA_XnorController;
701 extern StructRNA RNA_XorController;
702
703 /* Pointer
704  *
705  * These functions will fill in RNA pointers, this can be done in three ways:
706  * - a pointer Main is created by just passing the data pointer
707  * - a pointer to a datablock can be created with the type and id data pointer
708  * - a pointer to data contained in a datablock can be created with the id type
709  *   and id data pointer, and the data type and pointer to the struct itself.
710  *
711  * There is also a way to get a pointer with the information about all structs.
712  */
713
714 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
715 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
716 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
717
718 bool RNA_path_resolved_create(
719         PointerRNA *ptr, struct PropertyRNA *prop,
720         const int prop_index,
721         PathResolvedRNA *r_anim_rna);
722
723 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
724 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr);
725
726 extern const PointerRNA PointerRNA_NULL;
727
728 /* Structs */
729
730 StructRNA *RNA_struct_find(const char *identifier);
731
732 const char *RNA_struct_identifier(const StructRNA *type);
733 const char *RNA_struct_ui_name(const StructRNA *type);
734 const char *RNA_struct_ui_name_raw(const StructRNA *type);
735 const char *RNA_struct_ui_description(const StructRNA *type);
736 const char *RNA_struct_ui_description_raw(const StructRNA *type);
737 const char *RNA_struct_translation_context(const StructRNA *type);
738 int RNA_struct_ui_icon(const StructRNA *type);
739
740 PropertyRNA *RNA_struct_name_property(StructRNA *type);
741 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
742 StructRNA *RNA_struct_base(StructRNA *type);
743
744 bool RNA_struct_is_ID(const StructRNA *type);
745 bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna);
746
747 bool RNA_struct_undo_check(const StructRNA *type);
748
749 StructRegisterFunc RNA_struct_register(StructRNA *type);
750 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
751 void **RNA_struct_instance(PointerRNA *ptr);
752
753 void *RNA_struct_py_type_get(StructRNA *srna);
754 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
755
756 void *RNA_struct_blender_type_get(StructRNA *srna);
757 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
758
759 struct IDProperty *RNA_struct_idprops(PointerRNA *ptr, bool create);
760 bool RNA_struct_idprops_check(StructRNA *srna);
761 bool RNA_struct_idprops_register_check(const StructRNA *type);
762 bool RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier);
763
764 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
765 bool RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test);
766
767 /* lower level functions for access to type properties */
768 const struct ListBase *RNA_struct_type_properties(StructRNA *srna);
769 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier);
770
771 FunctionRNA *RNA_struct_find_function(StructRNA *srna, const char *identifier);
772 const struct ListBase *RNA_struct_type_functions(StructRNA *srna);
773
774 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, int *r_len);
775
776 /* Properties
777  *
778  * Access to struct properties. All this works with RNA pointers rather than
779  * direct pointers to the data. */
780
781 /* Property Information */
782
783 const char *RNA_property_identifier(PropertyRNA *prop);
784 const char *RNA_property_description(PropertyRNA *prop);
785
786 PropertyType RNA_property_type(PropertyRNA *prop);
787 PropertySubType RNA_property_subtype(PropertyRNA *prop);
788 PropertyUnit RNA_property_unit(PropertyRNA *prop);
789 int RNA_property_flag(PropertyRNA *prop);
790 void *RNA_property_py_data_get(PropertyRNA *prop);
791
792 int  RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
793 bool RNA_property_array_check(PropertyRNA *prop);
794 int  RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dimension);
795 int  RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[]);
796 char RNA_property_array_item_char(PropertyRNA *prop, int index);
797 int  RNA_property_array_item_index(PropertyRNA *prop, char name);
798
799 int RNA_property_string_maxlength(PropertyRNA *prop);
800
801 const char *RNA_property_ui_name(PropertyRNA *prop);
802 const char *RNA_property_ui_name_raw(PropertyRNA *prop);
803 const char *RNA_property_ui_description(PropertyRNA *prop);
804 const char *RNA_property_ui_description_raw(PropertyRNA *prop);
805 const char *RNA_property_translation_context(PropertyRNA *prop);
806 int RNA_property_ui_icon(PropertyRNA *prop);
807
808 /* Dynamic Property Information */
809
810 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
811 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
812
813 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
814 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
815
816 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value);
817 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value);
818
819 bool RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier);
820 int  RNA_enum_bitflag_identifiers(EnumPropertyItem *item, const int value, const char **identifier);
821 bool RNA_enum_name(EnumPropertyItem *item, const int value, const char **r_name);
822 bool RNA_enum_description(EnumPropertyItem *item, const int value, const char **description);
823 int  RNA_enum_from_value(EnumPropertyItem *item, const int value);
824 int  RNA_enum_from_identifier(EnumPropertyItem *item, const char *identifier);
825
826 void RNA_property_enum_items_ex(
827         struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const bool use_static,
828         EnumPropertyItem **item, int *r_totitem, bool *r_free);
829 void RNA_property_enum_items(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop,
830                              EnumPropertyItem **item, int *r_totitem, bool *r_free);
831 void RNA_property_enum_items_gettexted(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop,
832                                        EnumPropertyItem **r_item, int *r_totitem, bool *r_free);
833 void RNA_property_enum_items_gettexted_all(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop,
834                                        EnumPropertyItem **r_item, int *r_totitem, bool *r_free);
835 bool RNA_property_enum_value(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *r_value);
836 bool RNA_property_enum_identifier(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
837 bool RNA_property_enum_name(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
838 bool RNA_property_enum_name_gettexted(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
839
840 bool RNA_property_enum_item_from_value(
841         struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value,
842         EnumPropertyItem *r_item);
843 bool RNA_property_enum_item_from_value_gettexted(
844         struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value,
845         EnumPropertyItem *r_item);
846
847 int RNA_property_enum_bitflag_identifiers(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
848
849 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
850 int RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value);
851
852 bool RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
853 bool RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index);
854 bool RNA_property_editable_flag(PointerRNA *ptr, PropertyRNA *prop); /* without lib check, only checks the flag */
855 bool RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
856 bool RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
857 bool RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop); /* slow, use with care */
858
859 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
860 void RNA_property_update_main(struct Main *bmain, struct Scene *scene, PointerRNA *ptr, PropertyRNA *prop);
861 bool RNA_property_update_check(struct PropertyRNA *prop);
862
863 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop);
864 void RNA_property_update_cache_flush(struct Main *bmain, struct Scene *scene);
865 void RNA_property_update_cache_free(void);
866
867 /* Property Data */
868
869 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
870 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
871 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
872 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
873 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
874 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
875 int RNA_property_boolean_get_default(PointerRNA *ptr, PropertyRNA *prop);
876 void RNA_property_boolean_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
877 int RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
878
879 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
880 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
881 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
882 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2]);
883 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
884 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
885 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
886 int RNA_property_int_get_default(PointerRNA *ptr, PropertyRNA *prop);
887 void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
888 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
889
890 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
891 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
892 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
893 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2]);
894 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
895 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
896 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
897 float RNA_property_float_get_default(PointerRNA *ptr, PropertyRNA *prop);
898 void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
899 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
900
901 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
902 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen, int *r_len);
903 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
904 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
905 void RNA_property_string_get_default(PointerRNA *ptr, PropertyRNA *prop, char *value);
906 char *RNA_property_string_get_default_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
907 int RNA_property_string_default_length(PointerRNA *ptr, PropertyRNA *prop);
908
909 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
910 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
911 int RNA_property_enum_get_default(PointerRNA *ptr, PropertyRNA *prop);
912 void *RNA_property_enum_py_data_get(PropertyRNA *prop);
913
914 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
915 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
916 PointerRNA RNA_property_pointer_get_default(PointerRNA *ptr, PropertyRNA *prop);
917
918 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
919 void RNA_property_collection_next(CollectionPropertyIterator *iter);
920 void RNA_property_collection_skip(CollectionPropertyIterator *iter, int num);
921 void RNA_property_collection_end(CollectionPropertyIterator *iter);
922 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
923 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr);
924 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
925 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
926 int RNA_property_collection_assign_int(PointerRNA *ptr, PropertyRNA *prop, const int key, const PointerRNA *assign_ptr);
927 bool RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
928
929 /* efficient functions to set properties for arrays */
930 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array);
931 int RNA_property_collection_raw_get(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
932 int RNA_property_collection_raw_set(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
933 int RNA_raw_type_sizeof(RawPropertyType type);
934 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
935
936
937 /* to create ID property groups */
938 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
939 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
940 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
941 bool RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
942 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
943 bool RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos);
944
945 /* copy/reset */
946 bool RNA_property_copy(PointerRNA *ptr, PointerRNA *fromptr, PropertyRNA *prop, int index);
947 bool RNA_property_reset(PointerRNA *ptr, PropertyRNA *prop, int index);
948
949 /* Path
950  *
951  * Experimental method to refer to structs and properties with a string,
952  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
953  *
954  * This provides a way to refer to RNA data while being detached from any
955  * particular pointers, which is useful in a number of applications, like
956  * UI code or Actions, though efficiency is a concern. */
957
958 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
959                       int intkey, const char *strkey);
960 char *RNA_path_back(const char *path);
961
962 /* path_resolve() variants only ensure that a valid pointer (and optionally property) exist */
963 bool RNA_path_resolve(PointerRNA *ptr, const char *path,
964                      PointerRNA *r_ptr, PropertyRNA **r_prop);
965
966 bool RNA_path_resolve_full(PointerRNA *ptr, const char *path,
967                            PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index);
968
969 /* path_resolve_property() variants ensure that pointer + property both exist */
970 bool RNA_path_resolve_property(PointerRNA *ptr, const char *path,
971                                PointerRNA *r_ptr, PropertyRNA **r_prop);
972
973 bool RNA_path_resolve_property_full(PointerRNA *ptr, const char *path,
974                                     PointerRNA *r_ptr, PropertyRNA **r_prop, int *r_index);
975
976 typedef struct PropertyElemRNA PropertyElemRNA;
977 struct PropertyElemRNA {
978         PropertyElemRNA *next, *prev;
979         PointerRNA ptr;
980         PropertyRNA *prop;
981         int index;
982 };
983 bool RNA_path_resolve_elements(PointerRNA *ptr, const char *path, struct ListBase *r_elements);
984
985 char *RNA_path_from_ID_to_struct(PointerRNA *ptr);
986 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
987 char *RNA_path_from_ID_to_property_index(PointerRNA *ptr, PropertyRNA *prop, int array_dim, int index);
988
989 char *RNA_path_resolve_from_type_to_property(
990         struct PointerRNA *ptr, struct PropertyRNA *prop,
991         const struct StructRNA *type);
992
993 char *RNA_path_full_ID_py(struct ID *id);
994 char *RNA_path_full_struct_py(struct PointerRNA *ptr);
995 char *RNA_path_full_property_py_ex(PointerRNA *ptr, PropertyRNA *prop, int index, bool use_fallback);
996 char *RNA_path_full_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
997 char *RNA_path_struct_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
998 char *RNA_path_property_py(struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
999
1000 /* Quick name based property access
1001  *
1002  * These are just an easier way to access property values without having to
1003  * call RNA_struct_find_property. The names have to exist as RNA properties
1004  * for the type in the pointer, if they do not exist an error will be printed.
1005  *
1006  * There is no support for pointers and collections here yet, these can be 
1007  * added when ID properties support them. */
1008
1009 int  RNA_boolean_get(PointerRNA *ptr, const char *name);
1010 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
1011 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
1012 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
1013
1014 int  RNA_int_get(PointerRNA *ptr, const char *name);
1015 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
1016 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
1017 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
1018
1019 float RNA_float_get(PointerRNA *ptr, const char *name);
1020 void  RNA_float_set(PointerRNA *ptr, const char *name, float value);
1021 void  RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
1022 void  RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
1023
1024 int  RNA_enum_get(PointerRNA *ptr, const char *name);
1025 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
1026 void RNA_enum_set_identifier(struct bContext *C, PointerRNA *ptr, const char *name, const char *id);
1027 bool RNA_enum_is_equal(struct bContext *C, PointerRNA *ptr, const char *name, const char *enumname);
1028
1029 /* lower level functions that don't use a PointerRNA */
1030 bool RNA_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *r_value);
1031 bool RNA_enum_id_from_value(EnumPropertyItem *item, int value, const char **r_identifier);
1032 bool RNA_enum_icon_from_value(EnumPropertyItem *item, int value, int *r_icon);
1033 bool RNA_enum_name_from_value(EnumPropertyItem *item, int value, const char **r_name);
1034
1035 void  RNA_string_get(PointerRNA *ptr, const char *name, char *value);
1036 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
1037 int   RNA_string_length(PointerRNA *ptr, const char *name);
1038 void  RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
1039
1040 /**
1041  * Retrieve the named property from PointerRNA.
1042  */
1043 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
1044 /* Set the property name of PointerRNA ptr to ptr_value */
1045 void RNA_pointer_set(PointerRNA *ptr, const char *name, PointerRNA ptr_value);
1046 void RNA_pointer_add(PointerRNA *ptr, const char *name);
1047
1048 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
1049 int  RNA_collection_length(PointerRNA *ptr, const char *name);
1050 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
1051 void RNA_collection_clear(PointerRNA *ptr, const char *name);
1052
1053 #define RNA_BEGIN(sptr, itemptr, propname)                                    \
1054         {                                                                         \
1055                 CollectionPropertyIterator rna_macro_iter;                            \
1056                 for (RNA_collection_begin(sptr, propname, &rna_macro_iter);           \
1057                      rna_macro_iter.valid;                                            \
1058                      RNA_property_collection_next(&rna_macro_iter))                   \
1059                 {                                                                     \
1060                         PointerRNA itemptr = rna_macro_iter.ptr;
1061
1062 #define RNA_END                                                               \
1063                 }                                                                     \
1064                 RNA_property_collection_end(&rna_macro_iter);                         \
1065         }
1066
1067 #define RNA_PROP_BEGIN(sptr, itemptr, prop)                                   \
1068         {                                                                         \
1069                 CollectionPropertyIterator rna_macro_iter;                            \
1070                 for (RNA_property_collection_begin(sptr, prop, &rna_macro_iter);      \
1071                      rna_macro_iter.valid;                                            \
1072                      RNA_property_collection_next(&rna_macro_iter))                   \
1073                 {                                                                     \
1074                         PointerRNA itemptr = rna_macro_iter.ptr;
1075
1076 #define RNA_PROP_END                                                          \
1077                 }                                                                     \
1078                 RNA_property_collection_end(&rna_macro_iter);                         \
1079         }
1080
1081 #define RNA_STRUCT_BEGIN(sptr, prop)                                          \
1082         {                                                                         \
1083                 CollectionPropertyIterator rna_macro_iter;                            \
1084                 for (RNA_property_collection_begin(                                   \
1085                              sptr,                                                    \
1086                              RNA_struct_iterator_property((sptr)->type),              \
1087                              &rna_macro_iter);                                        \
1088                      rna_macro_iter.valid;                                            \
1089                      RNA_property_collection_next(&rna_macro_iter))                   \
1090                 {                                                                     \
1091                         PropertyRNA *prop = (PropertyRNA *)rna_macro_iter.ptr.data;
1092
1093 #define RNA_STRUCT_END                                                        \
1094                 }                                                                     \
1095                 RNA_property_collection_end(&rna_macro_iter);                         \
1096         }
1097
1098 /* check if the idproperty exists, for operators */
1099 bool RNA_property_is_set_ex(PointerRNA *ptr, PropertyRNA *prop, bool use_ghost);
1100 bool RNA_property_is_set(PointerRNA *ptr, PropertyRNA *prop);
1101 void RNA_property_unset(PointerRNA *ptr, PropertyRNA *prop);
1102 bool RNA_struct_property_is_set_ex(PointerRNA *ptr, const char *identifier, bool use_ghost);
1103 bool RNA_struct_property_is_set(PointerRNA *ptr, const char *identifier);
1104 bool RNA_property_is_idprop(PropertyRNA *prop);
1105 bool RNA_property_is_unlink(PropertyRNA *prop);
1106 void RNA_struct_property_unset(PointerRNA *ptr, const char *identifier);
1107
1108 /* python compatible string representation of this property, (must be freed!) */
1109 char *RNA_property_as_string(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, int index, int max_prop_length);
1110 char *RNA_pointer_as_string_id(struct bContext *C, PointerRNA *ptr);
1111 char *RNA_pointer_as_string(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop_ptr, PointerRNA *ptr_prop);
1112 char *RNA_pointer_as_string_keywords_ex(struct bContext *C, PointerRNA *ptr,
1113                                         const bool skip_optional_value, const bool all_args, const bool nested_args,
1114                                         const int max_prop_length,
1115                                         PropertyRNA *iterprop);
1116 char *RNA_pointer_as_string_keywords(struct bContext *C, PointerRNA *ptr,
1117                                      const bool skip_optional_value, const bool all_args, const bool nested_args,
1118                                      const int max_prop_length);
1119 char *RNA_function_as_string_keywords(struct bContext *C, FunctionRNA *func,
1120                                       const bool as_function, const bool all_args,
1121                                       const int max_prop_length);
1122
1123 /* Function */
1124
1125 const char *RNA_function_identifier(FunctionRNA *func);
1126 const char *RNA_function_ui_description(FunctionRNA *func);
1127 const char *RNA_function_ui_description_raw(FunctionRNA *func);
1128 int RNA_function_flag(FunctionRNA *func);
1129 int RNA_function_defined(FunctionRNA *func);
1130
1131 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
1132 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier);
1133 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
1134
1135 /* Utility */
1136
1137 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
1138 void RNA_parameter_list_free(ParameterList *parms);
1139 int  RNA_parameter_list_size(ParameterList *parms);
1140 int  RNA_parameter_list_arg_count(ParameterList *parms);
1141 int  RNA_parameter_list_ret_count(ParameterList *parms);
1142
1143 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
1144 void RNA_parameter_list_next(ParameterIterator *iter);
1145 void RNA_parameter_list_end(ParameterIterator *iter);
1146
1147 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
1148 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
1149 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, const void *value);
1150 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value);
1151 /* Only for PROP_DYNAMIC properties! */
1152 int RNA_parameter_dynamic_length_get(ParameterList *parms, PropertyRNA *parm);
1153 int RNA_parameter_dynamic_length_get_data(ParameterList *parms, PropertyRNA *parm, void *data);
1154 void RNA_parameter_dynamic_length_set(ParameterList *parms, PropertyRNA *parm, int length);
1155 void RNA_parameter_dynamic_length_set_data(ParameterList *parms, PropertyRNA *parm, void *data, int length);
1156
1157 int RNA_function_call(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1158                       FunctionRNA *func, ParameterList *parms);
1159 int RNA_function_call_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1160                              const char *identifier, ParameterList *parms);
1161
1162 int RNA_function_call_direct(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1163                              FunctionRNA *func, const char *format, ...) ATTR_PRINTF_FORMAT(5, 6);
1164 int RNA_function_call_direct_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1165                                     const char *identifier, const char *format, ...) ATTR_PRINTF_FORMAT(5, 6);
1166 int RNA_function_call_direct_va(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1167                                 FunctionRNA *func, const char *format, va_list args);
1168 int RNA_function_call_direct_va_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr,
1169                                        const char *identifier, const char *format, va_list args);
1170
1171 /* ID */
1172
1173 short RNA_type_to_ID_code(StructRNA *type);
1174 StructRNA *ID_code_to_RNA_type(short idcode);
1175
1176
1177 #define RNA_POINTER_INVALIDATE(ptr) {                                         \
1178         /* this is checked for validity */                                        \
1179         (ptr)->type =                                                             \
1180         /* should not be needed but prevent bad pointer access, just in case */   \
1181         (ptr)->id.data = NULL;                                                    \
1182 } (void)0
1183
1184 /* macro which inserts the function name */
1185 #if defined __GNUC__ || defined __sun
1186 #  define RNA_warning(format, args ...) _RNA_warning("%s: " format "\n", __func__, ##args)
1187 #else
1188 #  define RNA_warning(format, ...) _RNA_warning("%s: " format "\n", __FUNCTION__, __VA_ARGS__)
1189 #endif
1190
1191 void _RNA_warning(const char *format, ...) ATTR_PRINTF_FORMAT(1, 2);
1192
1193 /* Equals test (skips pointers and collections)
1194  * is_strict false assumes uninitialized properties are equal */
1195
1196 typedef enum eRNAEqualsMode {
1197         RNA_EQ_STRICT,          /* set/unset ignored */
1198         RNA_EQ_UNSET_MATCH_ANY, /* unset property matches anything */
1199         RNA_EQ_UNSET_MATCH_NONE /* unset property never matches set property */
1200 } eRNAEqualsMode;
1201
1202 bool RNA_property_equals(struct PointerRNA *a, struct PointerRNA *b, struct PropertyRNA *prop, eRNAEqualsMode mode);
1203 bool RNA_struct_equals(struct PointerRNA *a, struct PointerRNA *b, eRNAEqualsMode mode);
1204
1205 #ifdef __cplusplus
1206 }
1207 #endif
1208
1209 #endif /* __RNA_ACCESS_H__ */