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