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