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