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