Merging r47677 through r47683 from trunk into soc-2011-tomato
[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_Function;
239 extern StructRNA RNA_GPencilFrame;
240 extern StructRNA RNA_GPencilLayer;
241 extern StructRNA RNA_GPencilStroke;
242 extern StructRNA RNA_GPencilStrokePoint;
243 extern StructRNA RNA_GameBooleanProperty;
244 extern StructRNA RNA_GameFloatProperty;
245 extern StructRNA RNA_GameIntProperty;
246 extern StructRNA RNA_GameObjectSettings;
247 extern StructRNA RNA_GameProperty;
248 extern StructRNA RNA_GameSoftBodySettings;
249 extern StructRNA RNA_GameStringProperty;
250 extern StructRNA RNA_GameTimerProperty;
251 extern StructRNA RNA_GlowSequence;
252 extern StructRNA RNA_GreasePencil;
253 extern StructRNA RNA_Group;
254 extern StructRNA RNA_Header;
255 extern StructRNA RNA_HemiLamp;
256 extern StructRNA RNA_Histogram;
257 extern StructRNA RNA_HookModifier;
258 extern StructRNA RNA_ID;
259 extern StructRNA RNA_IKParam;
260 extern StructRNA RNA_Image;
261 extern StructRNA RNA_ImageFormatSettings;
262 extern StructRNA RNA_ImagePaint;
263 extern StructRNA RNA_ImageSequence;
264 extern StructRNA RNA_ImageTexture;
265 extern StructRNA RNA_ImageUser;
266 extern StructRNA RNA_InflowFluidSettings;
267 extern StructRNA RNA_IntProperty;
268 extern StructRNA RNA_Itasc;
269 extern StructRNA RNA_JoystickSensor;
270 extern StructRNA RNA_Key;
271 extern StructRNA RNA_KeyConfig;
272 extern StructRNA RNA_KeyMap;
273 extern StructRNA RNA_KeyMapItem;
274 extern StructRNA RNA_KeyMapItems;
275 extern StructRNA RNA_KeyboardSensor;
276 extern StructRNA RNA_Keyframe;
277 extern StructRNA RNA_KeyingSet;
278 extern StructRNA RNA_KeyingSetInfo;
279 extern StructRNA RNA_KeyingSetPath;
280 extern StructRNA RNA_KeyingSetsAll;
281 extern StructRNA RNA_KinematicConstraint;
282 extern StructRNA RNA_Lamp;
283 extern StructRNA RNA_LampSkySettings;
284 extern StructRNA RNA_LampTextureSlot;
285 extern StructRNA RNA_Lattice;
286 extern StructRNA RNA_LatticeModifier;
287 extern StructRNA RNA_LatticePoint;
288 extern StructRNA RNA_Library;
289 extern StructRNA RNA_LimitDistanceConstraint;
290 extern StructRNA RNA_LimitLocationConstraint;
291 extern StructRNA RNA_LimitRotationConstraint;
292 extern StructRNA RNA_LimitScaleConstraint;
293 extern StructRNA RNA_LockedTrackConstraint;
294 extern StructRNA RNA_Macro;
295 extern StructRNA RNA_MagicTexture;
296 extern StructRNA RNA_MarbleTexture;
297 extern StructRNA RNA_MaskModifier;
298 extern StructRNA RNA_MaskSequence;
299 extern StructRNA RNA_Material;
300 extern StructRNA RNA_MaterialHalo;
301 extern StructRNA RNA_MaterialPhysics;
302 extern StructRNA RNA_MaterialRaytraceMirror;
303 extern StructRNA RNA_MaterialRaytraceTransparency;
304 extern StructRNA RNA_MaterialSlot;
305 extern StructRNA RNA_MaterialStrand;
306 extern StructRNA RNA_MaterialSubsurfaceScattering;
307 extern StructRNA RNA_MaterialTextureSlot;
308 extern StructRNA RNA_MaterialVolume;
309 extern StructRNA RNA_Mask;
310 extern StructRNA RNA_MaskLayer;
311 extern StructRNA RNA_Menu;
312 extern StructRNA RNA_Mesh;
313 extern StructRNA RNA_MeshColor;
314 extern StructRNA RNA_MeshColorLayer;
315 extern StructRNA RNA_MeshLoopColorLayer;
316 extern StructRNA RNA_MeshDeformModifier;
317 extern StructRNA RNA_MeshEdge;
318 extern StructRNA RNA_MeshPolygon;
319 extern StructRNA RNA_MeshTessFace;
320 extern StructRNA RNA_MeshLoop;
321 extern StructRNA RNA_MeshFloatProperty;
322 extern StructRNA RNA_MeshFloatPropertyLayer;
323 extern StructRNA RNA_MeshIntProperty;
324 extern StructRNA RNA_MeshIntPropertyLayer;
325 extern StructRNA RNA_MeshSkinVertexLayer;
326 extern StructRNA RNA_MeshSkinVertex;
327 extern StructRNA RNA_MeshSticky;
328 extern StructRNA RNA_MeshStringProperty;
329 extern StructRNA RNA_MeshStringPropertyLayer;
330 extern StructRNA RNA_MeshTextureFace;
331 extern StructRNA RNA_MeshTextureFaceLayer;
332 extern StructRNA RNA_MeshTexturePoly;
333 extern StructRNA RNA_MeshTexturePolyLayer;
334 extern StructRNA RNA_MeshVertex;
335 extern StructRNA RNA_MessageSensor;
336 extern StructRNA RNA_MetaBall;
337 extern StructRNA RNA_MetaElement;
338 extern StructRNA RNA_MetaSequence;
339 extern StructRNA RNA_MirrorModifier;
340 extern StructRNA RNA_Modifier;
341 extern StructRNA RNA_MotionPath;
342 extern StructRNA RNA_MotionPathVert;
343 extern StructRNA RNA_MouseSensor;
344 extern StructRNA RNA_MovieSequence;
345 extern StructRNA RNA_MovieClipSequence;
346 extern StructRNA RNA_MovieTracking;
347 extern StructRNA RNA_MovieTrackingTrack;
348 extern StructRNA RNA_MovieTrackingObject;
349 extern StructRNA RNA_MovieTrackingTrack;
350 extern StructRNA RNA_MulticamSequence;
351 extern StructRNA RNA_MultiresModifier;
352 extern StructRNA RNA_MusgraveTexture;
353 extern StructRNA RNA_NandController;
354 extern StructRNA RNA_NearSensor;
355 extern StructRNA RNA_NlaStrip;
356 extern StructRNA RNA_NlaTrack;
357 extern StructRNA RNA_Node;
358 extern StructRNA RNA_NodeForLoop;
359 extern StructRNA RNA_NodeGroup;
360 extern StructRNA RNA_NodeOutputFileSlotFile;
361 extern StructRNA RNA_NodeOutputFileSlotLayer;
362 extern StructRNA RNA_NodeLink;
363 extern StructRNA RNA_NodeSocket;
364 extern StructRNA RNA_NodeTree;
365 extern StructRNA RNA_NodeWhileLoop;
366 extern StructRNA RNA_NoiseTexture;
367 extern StructRNA RNA_NorController;
368 extern StructRNA RNA_Object;
369 extern StructRNA RNA_ObjectBase;
370 extern StructRNA RNA_ObstacleFluidSettings;
371 extern StructRNA RNA_OceanModifier;
372 extern StructRNA RNA_OceanTexData;
373 extern StructRNA RNA_OceanTexture;
374 extern StructRNA RNA_Operator;
375 extern StructRNA RNA_OperatorFileListElement;
376 extern StructRNA RNA_OperatorMousePath;
377 extern StructRNA RNA_OperatorProperties;
378 extern StructRNA RNA_OperatorStrokeElement;
379 extern StructRNA RNA_OperatorMacro;
380 extern StructRNA RNA_OrController;
381 extern StructRNA RNA_OutflowFluidSettings;
382 extern StructRNA RNA_PackedFile;
383 extern StructRNA RNA_Paint;
384 extern StructRNA RNA_Panel;
385 extern StructRNA RNA_Particle;
386 extern StructRNA RNA_ParticleBrush;
387 extern StructRNA RNA_ParticleDupliWeight;
388 extern StructRNA RNA_ParticleEdit;
389 extern StructRNA RNA_ParticleFluidSettings;
390 extern StructRNA RNA_ParticleHairKey;
391 extern StructRNA RNA_ParticleInstanceModifier;
392 extern StructRNA RNA_ParticleKey;
393 extern StructRNA RNA_ParticleSettings;
394 extern StructRNA RNA_ParticleSettingsTextureSlot;
395 extern StructRNA RNA_ParticleSystem;
396 extern StructRNA RNA_ParticleSystemModifier;
397 extern StructRNA RNA_ParticleTarget;
398 extern StructRNA RNA_PivotConstraint;
399 extern StructRNA RNA_PointCache;
400 extern StructRNA RNA_PointDensity;
401 extern StructRNA RNA_PointDensityTexture;
402 extern StructRNA RNA_PointLamp;
403 extern StructRNA RNA_PointerProperty;
404 extern StructRNA RNA_Pose;
405 extern StructRNA RNA_PoseBone;
406 extern StructRNA RNA_Property;
407 extern StructRNA RNA_PropertyGroup;
408 extern StructRNA RNA_PropertyGroupItem;
409 extern StructRNA RNA_PropertySensor;
410 extern StructRNA RNA_PythonConstraint;
411 extern StructRNA RNA_PythonController;
412 extern StructRNA RNA_QuickTimeSettings;
413 extern StructRNA RNA_RadarSensor;
414 extern StructRNA RNA_RandomSensor;
415 extern StructRNA RNA_RaySensor;
416 extern StructRNA RNA_Region;
417 extern StructRNA RNA_RenderEngine;
418 extern StructRNA RNA_RenderLayer;
419 extern StructRNA RNA_RenderPass;
420 extern StructRNA RNA_RenderResult;
421 extern StructRNA RNA_RenderSettings;
422 extern StructRNA RNA_RigidBodyJointConstraint;
423 extern StructRNA RNA_SPHFluidSettings;
424 extern StructRNA RNA_Scene;
425 extern StructRNA RNA_SceneGameData;
426 extern StructRNA RNA_SceneRenderLayer;
427 extern StructRNA RNA_SceneSequence;
428 extern StructRNA RNA_SceneObjects;
429 extern StructRNA RNA_Scopes;
430 extern StructRNA RNA_Screen;
431 extern StructRNA RNA_ScrewModifier;
432 extern StructRNA RNA_Sculpt;
433 extern StructRNA RNA_SelectedUvElement;
434 extern StructRNA RNA_Sensor;
435 extern StructRNA RNA_Sequence;
436 extern StructRNA RNA_SequenceColorBalance;
437 extern StructRNA RNA_SequenceCrop;
438 extern StructRNA RNA_SequenceEditor;
439 extern StructRNA RNA_SequenceElement;
440 extern StructRNA RNA_SequenceProxy;
441 extern StructRNA RNA_SequenceTransform;
442 extern StructRNA RNA_ShaderNode;
443 extern StructRNA RNA_ShaderNodeCameraData;
444 extern StructRNA RNA_ShaderNodeCombineRGB;
445 extern StructRNA RNA_ShaderNodeExtendedMaterial;
446 extern StructRNA RNA_ShaderNodeGeometry;
447 extern StructRNA RNA_ShaderNodeHueSaturation;
448 extern StructRNA RNA_ShaderNodeInvert;
449 extern StructRNA RNA_ShaderNodeMapping;
450 extern StructRNA RNA_ShaderNodeMaterial;
451 extern StructRNA RNA_ShaderNodeMath;
452 extern StructRNA RNA_ShaderNodeMixRGB;
453 extern StructRNA RNA_ShaderNodeNormal;
454 extern StructRNA RNA_ShaderNodeOutput;
455 extern StructRNA RNA_ShaderNodeRGB;
456 extern StructRNA RNA_ShaderNodeRGBCurve;
457 extern StructRNA RNA_ShaderNodeRGBToBW;
458 extern StructRNA RNA_ShaderNodeSeparateRGB;
459 extern StructRNA RNA_ShaderNodeSqueeze;
460 extern StructRNA RNA_ShaderNodeTexture;
461 extern StructRNA RNA_ShaderNodeTree;
462 extern StructRNA RNA_ShaderNodeValToRGB;
463 extern StructRNA RNA_ShaderNodeValue;
464 extern StructRNA RNA_ShaderNodeVectorCurve;
465 extern StructRNA RNA_ShaderNodeVectorMath;
466 extern StructRNA RNA_ShapeKey;
467 extern StructRNA RNA_ShapeKeyBezierPoint;
468 extern StructRNA RNA_ShapeKeyCurvePoint;
469 extern StructRNA RNA_ShapeKeyPoint;
470 extern StructRNA RNA_ShrinkwrapConstraint;
471 extern StructRNA RNA_ShrinkwrapModifier;
472 extern StructRNA RNA_SimpleDeformModifier;
473 extern StructRNA RNA_SkinModifier;
474 extern StructRNA RNA_SmokeCollSettings;
475 extern StructRNA RNA_SmokeDomainSettings;
476 extern StructRNA RNA_SmokeFlowSettings;
477 extern StructRNA RNA_SmokeModifier;
478 extern StructRNA RNA_SmoothModifier;
479 extern StructRNA RNA_SoftBodyModifier;
480 extern StructRNA RNA_SoftBodySettings;
481 extern StructRNA RNA_SolidifyModifier;
482 extern StructRNA RNA_Sound;
483 extern StructRNA RNA_SoundSequence;
484 extern StructRNA RNA_Space;
485 extern StructRNA RNA_SpaceConsole;
486 extern StructRNA RNA_SpaceDopeSheetEditor;
487 extern StructRNA RNA_SpaceFileBrowser;
488 extern StructRNA RNA_SpaceGraphEditor;
489 extern StructRNA RNA_SpaceImageEditor;
490 extern StructRNA RNA_SpaceInfo;
491 extern StructRNA RNA_SpaceLogicEditor;
492 extern StructRNA RNA_SpaceNLA;
493 extern StructRNA RNA_SpaceNodeEditor;
494 extern StructRNA RNA_SpaceOutliner;
495 extern StructRNA RNA_SpaceProperties;
496 extern StructRNA RNA_SpaceSequenceEditor;
497 extern StructRNA RNA_SpaceTextEditor;
498 extern StructRNA RNA_SpaceTimeline;
499 extern StructRNA RNA_SpaceUVEditor;
500 extern StructRNA RNA_SpaceUserPreferences;
501 extern StructRNA RNA_SpaceView3D;
502 extern StructRNA RNA_SpaceClipEditor;
503 extern StructRNA RNA_Speaker;
504 extern StructRNA RNA_SpeedControlSequence;
505 extern StructRNA RNA_Spline;
506 extern StructRNA RNA_SplineIKConstraint;
507 extern StructRNA RNA_SpotLamp;
508 extern StructRNA RNA_StretchToConstraint;
509 extern StructRNA RNA_StringProperty;
510 extern StructRNA RNA_Struct;
511 extern StructRNA RNA_StucciTexture;
512 extern StructRNA RNA_SubsurfModifier;
513 extern StructRNA RNA_SunLamp;
514 extern StructRNA RNA_SurfaceCurve;
515 extern StructRNA RNA_SurfaceModifier;
516 extern StructRNA RNA_TexMapping;
517 extern StructRNA RNA_Text;
518 extern StructRNA RNA_TextBox;
519 extern StructRNA RNA_TextCharacterFormat;
520 extern StructRNA RNA_TextCurve;
521 extern StructRNA RNA_TextLine;
522 extern StructRNA RNA_TextMarker;
523 extern StructRNA RNA_Texture;
524 extern StructRNA RNA_TextureNode;
525 extern StructRNA RNA_TextureNodeBricks;
526 extern StructRNA RNA_TextureNodeChecker;
527 extern StructRNA RNA_TextureNodeCompose;
528 extern StructRNA RNA_TextureNodeCoordinates;
529 extern StructRNA RNA_TextureNodeCurveRGB;
530 extern StructRNA RNA_TextureNodeCurveTime;
531 extern StructRNA RNA_TextureNodeDecompose;
532 extern StructRNA RNA_TextureNodeDistance;
533 extern StructRNA RNA_TextureNodeHueSaturation;
534 extern StructRNA RNA_TextureNodeImage;
535 extern StructRNA RNA_TextureNodeInvert;
536 extern StructRNA RNA_TextureNodeMath;
537 extern StructRNA RNA_TextureNodeMixRGB;
538 extern StructRNA RNA_TextureNodeOutput;
539 extern StructRNA RNA_TextureNodeRGBToBW;
540 extern StructRNA RNA_TextureNodeRotate;
541 extern StructRNA RNA_TextureNodeScale;
542 extern StructRNA RNA_TextureNodeTexture;
543 extern StructRNA RNA_TextureNodeTranslate;
544 extern StructRNA RNA_TextureNodeTree;
545 extern StructRNA RNA_TextureNodeValToNor;
546 extern StructRNA RNA_TextureNodeValToRGB;
547 extern StructRNA RNA_TextureNodeViewer;
548 extern StructRNA RNA_TextureSlot;
549 extern StructRNA RNA_Theme;
550 extern StructRNA RNA_ThemeAudioWindow;
551 extern StructRNA RNA_ThemeBoneColorSet;
552 extern StructRNA RNA_ThemeConsole;
553 extern StructRNA RNA_ThemeDopeSheet;
554 extern StructRNA RNA_ThemeFileBrowser;
555 extern StructRNA RNA_ThemeFontStyle;
556 extern StructRNA RNA_ThemeGraphEditor;
557 extern StructRNA RNA_ThemeImageEditor;
558 extern StructRNA RNA_ThemeInfo;
559 extern StructRNA RNA_ThemeLogicEditor;
560 extern StructRNA RNA_ThemeNLAEditor;
561 extern StructRNA RNA_ThemeNodeEditor;
562 extern StructRNA RNA_ThemeOutliner;
563 extern StructRNA RNA_ThemeProperties;
564 extern StructRNA RNA_ThemeSequenceEditor;
565 extern StructRNA RNA_ThemeSpaceGeneric;
566 extern StructRNA RNA_ThemeSpaceListGeneric;
567 extern StructRNA RNA_ThemeStyle;
568 extern StructRNA RNA_ThemeTextEditor;
569 extern StructRNA RNA_ThemeTimeline;
570 extern StructRNA RNA_ThemeUserInterface;
571 extern StructRNA RNA_ThemeUserPreferences;
572 extern StructRNA RNA_ThemeView3D;
573 extern StructRNA RNA_ThemeWidgetColors;
574 extern StructRNA RNA_ThemeWidgetStateColors;
575 extern StructRNA RNA_TimelineMarker;
576 extern StructRNA RNA_Timer;
577 extern StructRNA RNA_ToolSettings;
578 extern StructRNA RNA_TouchSensor;
579 extern StructRNA RNA_TrackToConstraint;
580 extern StructRNA RNA_TransformConstraint;
581 extern StructRNA RNA_TransformSequence;
582 extern StructRNA RNA_UILayout;
583 extern StructRNA RNA_UIListItem;
584 extern StructRNA RNA_UVProjectModifier;
585 extern StructRNA RNA_UVProjector;
586 extern StructRNA RNA_UnitSettings;
587 extern StructRNA RNA_UnknownType;
588 extern StructRNA RNA_UserPreferences;
589 extern StructRNA RNA_UserPreferencesEdit;
590 extern StructRNA RNA_UserPreferencesFilePaths;
591 extern StructRNA RNA_UserPreferencesInput;
592 extern StructRNA RNA_UserPreferencesSystem;
593 extern StructRNA RNA_UserPreferencesView;
594 extern StructRNA RNA_UserSolidLight;
595 extern StructRNA RNA_VectorFont;
596 extern StructRNA RNA_VertexGroup;
597 extern StructRNA RNA_VertexGroupElement;
598 extern StructRNA RNA_VertexPaint;
599 extern StructRNA RNA_VoronoiTexture;
600 extern StructRNA RNA_VoxelData;
601 extern StructRNA RNA_VoxelDataTexture;
602 extern StructRNA RNA_WarpModifier;
603 extern StructRNA RNA_WaveModifier;
604 extern StructRNA RNA_VertexWeightEditModifier;
605 extern StructRNA RNA_VertexWeightMixModifier;
606 extern StructRNA RNA_VertexWeightProximityModifier;
607 extern StructRNA RNA_Window;
608 extern StructRNA RNA_WindowManager;
609 extern StructRNA RNA_WipeSequence;
610 extern StructRNA RNA_WoodTexture;
611 extern StructRNA RNA_World;
612 extern StructRNA RNA_WorldAmbientOcclusion;
613 extern StructRNA RNA_WorldLighting;
614 extern StructRNA RNA_WorldMistSettings;
615 extern StructRNA RNA_WorldStarsSettings;
616 extern StructRNA RNA_WorldTextureSlot;
617 extern StructRNA RNA_XnorController;
618 extern StructRNA RNA_XorController;
619
620 /* Pointer
621  *
622  * These functions will fill in RNA pointers, this can be done in three ways:
623  * - a pointer Main is created by just passing the data pointer
624  * - a pointer to a datablock can be created with the type and id data pointer
625  * - a pointer to data contained in a datablock can be created with the id type
626  *   and id data pointer, and the data type and pointer to the struct itself.
627  *
628  * There is also a way to get a pointer with the information about all structs.
629  */
630
631 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
632 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
633 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
634
635 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
636 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr);
637
638 extern const PointerRNA PointerRNA_NULL;
639
640 /* Structs */
641
642 StructRNA *RNA_struct_find(const char *identifier);
643
644 const char *RNA_struct_identifier(StructRNA *type);
645 const char *RNA_struct_ui_name(StructRNA *type);
646 const char *RNA_struct_ui_description(StructRNA *type);
647 int RNA_struct_ui_icon(StructRNA *type);
648
649 PropertyRNA *RNA_struct_name_property(StructRNA *type);
650 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
651 StructRNA *RNA_struct_base(StructRNA *type);
652
653 int RNA_struct_is_ID(StructRNA *type);
654 int RNA_struct_is_a(StructRNA *type, StructRNA *srna);
655
656 int RNA_struct_undo_check(StructRNA *type);
657
658 StructRegisterFunc RNA_struct_register(StructRNA *type);
659 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
660 void **RNA_struct_instance(PointerRNA *ptr);
661
662 void *RNA_struct_py_type_get(StructRNA *srna);
663 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
664
665 void *RNA_struct_blender_type_get(StructRNA *srna);
666 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
667
668 struct IDProperty *RNA_struct_idprops(PointerRNA *ptr, int create);
669 int RNA_struct_idprops_check(StructRNA *srna);
670 int RNA_struct_idprops_register_check(StructRNA *type);
671 int RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier);
672
673 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
674 int RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test);
675
676 /* lower level functions for access to type properties */
677 const struct ListBase *RNA_struct_type_properties(StructRNA *srna);
678 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier);
679
680 FunctionRNA *RNA_struct_find_function(StructRNA *srna, const char *identifier);
681 const struct ListBase *RNA_struct_type_functions(StructRNA *srna);
682
683 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, int *r_len);
684
685 /* Properties
686  *
687  * Access to struct properties. All this works with RNA pointers rather than
688  * direct pointers to the data. */
689
690 /* Property Information */
691
692 const char *RNA_property_identifier(PropertyRNA *prop);
693 const char *RNA_property_description(PropertyRNA *prop);
694
695 PropertyType RNA_property_type(PropertyRNA *prop);
696 PropertySubType RNA_property_subtype(PropertyRNA *prop);
697 PropertyUnit RNA_property_unit(PropertyRNA *prop);
698 int RNA_property_flag(PropertyRNA *prop);
699 void *RNA_property_py_data_get(PropertyRNA *prop);
700
701 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
702 int RNA_property_array_check(PropertyRNA *prop);
703 int RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dimension);
704 int RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[]);
705 char RNA_property_array_item_char(PropertyRNA *prop, int index);
706 int RNA_property_array_item_index(PropertyRNA *prop, char name);
707
708 int RNA_property_string_maxlength(PropertyRNA *prop);
709
710 const char *RNA_property_ui_name(PropertyRNA *prop);
711 const char *RNA_property_ui_description(PropertyRNA *prop);
712 int RNA_property_ui_icon(PropertyRNA *prop);
713
714 /* Dynamic Property Information */
715
716 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
717 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
718
719 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
720 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
721
722 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value);
723 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value);
724
725 int RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier);
726 int RNA_enum_bitflag_identifiers(EnumPropertyItem *item, const int value, const char **identifier);
727 int RNA_enum_name(EnumPropertyItem *item, const int value, const char **name);
728 int RNA_enum_description(EnumPropertyItem *item, const int value, const char **description);
729
730 void RNA_property_enum_items(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
731 void RNA_property_enum_items_gettexted(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
732 int RNA_property_enum_value(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
733 int RNA_property_enum_identifier(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
734 int RNA_property_enum_name(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
735 int RNA_property_enum_bitflag_identifiers(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
736
737 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
738 int RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value);
739
740 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
741 int RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index);
742 int RNA_property_editable_flag(PointerRNA *ptr, PropertyRNA *prop); /* without lib check, only checks the flag */
743 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
744 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
745 int RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop); /* slow, use with care */
746
747 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
748 void RNA_property_update_main(struct Main *bmain, struct Scene *scene, PointerRNA *ptr, PropertyRNA *prop);
749 int RNA_property_update_check(struct PropertyRNA *prop);
750
751 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop);
752 void RNA_property_update_cache_flush(struct Main *bmain, struct Scene *scene);
753 void RNA_property_update_cache_free(void);
754
755 /* Property Data */
756
757 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
758 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
759 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
760 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
761 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
762 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
763 int RNA_property_boolean_get_default(PointerRNA *ptr, PropertyRNA *prop);
764 void RNA_property_boolean_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
765 int RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
766
767 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
768 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
769 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
770 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2]);
771 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
772 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
773 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
774 int RNA_property_int_get_default(PointerRNA *ptr, PropertyRNA *prop);
775 void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
776 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
777
778 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
779 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
780 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
781 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2]);
782 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
783 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
784 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
785 float RNA_property_float_get_default(PointerRNA *ptr, PropertyRNA *prop);
786 void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
787 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
788
789 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
790 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen, int *r_len);
791 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
792 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
793 void RNA_property_string_get_default(PointerRNA *ptr, PropertyRNA *prop, char *value);
794 char *RNA_property_string_get_default_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
795 int RNA_property_string_default_length(PointerRNA *ptr, PropertyRNA *prop);
796
797 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
798 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
799 int RNA_property_enum_get_default(PointerRNA *ptr, PropertyRNA *prop);
800 void *RNA_property_enum_py_data_get(PropertyRNA *prop);
801
802 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
803 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
804 PointerRNA RNA_property_pointer_get_default(PointerRNA *ptr, PropertyRNA *prop);
805
806 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
807 void RNA_property_collection_next(CollectionPropertyIterator *iter);
808 void RNA_property_collection_end(CollectionPropertyIterator *iter);
809 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
810 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr);
811 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
812 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
813 int RNA_property_collection_assign_int(PointerRNA *ptr, PropertyRNA *prop, const int key, const PointerRNA *assign_ptr);
814 int RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
815
816 /* efficient functions to set properties for arrays */
817 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array);
818 int RNA_property_collection_raw_get(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
819 int RNA_property_collection_raw_set(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
820 int RNA_raw_type_sizeof(RawPropertyType type);
821 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
822
823
824 /* to create ID property groups */
825 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
826 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
827 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
828 int RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
829 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
830 int RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos);
831
832 /* copy/reset */
833 int RNA_property_copy(PointerRNA *ptr, PointerRNA *fromptr, PropertyRNA *prop, int index);
834 int RNA_property_reset(PointerRNA *ptr, PropertyRNA *prop, int index);
835
836 /* Path
837  *
838  * Experimental method to refer to structs and properties with a string,
839  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
840  *
841  * This provides a way to refer to RNA data while being detached from any
842  * particular pointers, which is useful in a number of applications, like
843  * UI code or Actions, though efficiency is a concern. */
844
845 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
846         int intkey, const char *strkey);
847 char *RNA_path_back(const char *path);
848
849 int RNA_path_resolve(PointerRNA *ptr, const char *path,
850                 PointerRNA *r_ptr, PropertyRNA **r_prop);
851
852 int RNA_path_resolve_full(PointerRNA *ptr, const char *path,
853                 PointerRNA *r_ptr, PropertyRNA **r_prop, int *index);
854
855 char *RNA_path_from_ID_to_struct(PointerRNA *ptr);
856 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
857
858 /* Quick name based property access
859  *
860  * These are just an easier way to access property values without having to
861  * call RNA_struct_find_property. The names have to exist as RNA properties
862  * for the type in the pointer, if they do not exist an error will be printed.
863  *
864  * There is no support for pointers and collections here yet, these can be 
865  * added when ID properties support them. */
866
867 int RNA_boolean_get(PointerRNA *ptr, const char *name);
868 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
869 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
870 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
871
872 int RNA_int_get(PointerRNA *ptr, const char *name);
873 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
874 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
875 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
876
877 float RNA_float_get(PointerRNA *ptr, const char *name);
878 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
879 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
880 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
881
882 int RNA_enum_get(PointerRNA *ptr, const char *name);
883 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
884 void RNA_enum_set_identifier(PointerRNA *ptr, const char *name, const char *id);
885 int RNA_enum_is_equal(struct bContext *C, PointerRNA *ptr, const char *name, const char *enumname);
886
887 /* lower level functions that don't use a PointerRNA */
888 int RNA_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value);
889 int RNA_enum_id_from_value(EnumPropertyItem *item, int value, const char **identifier);
890 int RNA_enum_icon_from_value(EnumPropertyItem *item, int value, int *icon);
891 int RNA_enum_name_from_value(EnumPropertyItem *item, int value, const char **name);
892
893 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
894 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
895 int RNA_string_length(PointerRNA *ptr, const char *name);
896 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
897
898 /**
899  * Retrieve the named property from PointerRNA.
900  */
901 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
902 /* Set the property name of PointerRNA ptr to ptr_value */
903 void RNA_pointer_set(PointerRNA *ptr, const char *name, PointerRNA ptr_value);
904 void RNA_pointer_add(PointerRNA *ptr, const char *name);
905
906 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
907 int RNA_collection_length(PointerRNA *ptr, const char *name);
908 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
909 void RNA_collection_clear(PointerRNA *ptr, const char *name);
910
911 #define RNA_BEGIN(sptr, itemptr, propname)                                    \
912         {                                                                         \
913                 CollectionPropertyIterator rna_macro_iter;                            \
914                 for (RNA_collection_begin(sptr, propname, &rna_macro_iter);           \
915                      rna_macro_iter.valid;                                            \
916                      RNA_property_collection_next(&rna_macro_iter))                   \
917                 {                                                                     \
918                         PointerRNA itemptr = rna_macro_iter.ptr;
919
920 #define RNA_END                                                               \
921                 }                                                                     \
922                 RNA_property_collection_end(&rna_macro_iter);                         \
923         }
924
925 #define RNA_PROP_BEGIN(sptr, itemptr, prop)                                   \
926         {                                                                         \
927                 CollectionPropertyIterator rna_macro_iter;                            \
928                 for (RNA_property_collection_begin(sptr, prop, &rna_macro_iter);      \
929                      rna_macro_iter.valid;                                            \
930                      RNA_property_collection_next(&rna_macro_iter))                   \
931                 {                                                                     \
932                         PointerRNA itemptr = rna_macro_iter.ptr;
933
934 #define RNA_PROP_END                                                          \
935                 }                                                                     \
936                 RNA_property_collection_end(&rna_macro_iter);                         \
937         }
938
939 #define RNA_STRUCT_BEGIN(sptr, prop)                                          \
940         {                                                                         \
941                 CollectionPropertyIterator rna_macro_iter;                            \
942                 for (RNA_property_collection_begin(                                   \
943                              sptr,                                                    \
944                              RNA_struct_iterator_property(sptr->type),                \
945                              &rna_macro_iter);                                        \
946                      rna_macro_iter.valid;                                            \
947                      RNA_property_collection_next(&rna_macro_iter))                   \
948                 {                                                                     \
949                         PropertyRNA *prop = rna_macro_iter.ptr.data;
950
951 #define RNA_STRUCT_END                                                        \
952                 }                                                                     \
953                 RNA_property_collection_end(&rna_macro_iter);                         \
954         }
955
956 /* check if the idproperty exists, for operators */
957 int RNA_property_is_set(PointerRNA *ptr, PropertyRNA *prop);
958 int RNA_struct_property_is_set(PointerRNA *ptr, const char *identifier);
959 int RNA_property_is_idprop(PropertyRNA *prop);
960
961 /* python compatible string representation of this property, (must be freed!) */
962 char *RNA_property_as_string(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
963 char *RNA_pointer_as_string(struct bContext *C, PointerRNA *ptr);
964 char *RNA_pointer_as_string_keywords_ex(struct bContext *C, PointerRNA *ptr, PointerRNA *ptr_default,
965                                         const short skip_optional_value, const short all_args,
966                                         PropertyRNA *iterprop);
967 char *RNA_pointer_as_string_keywords(struct bContext *C, PointerRNA *ptr, PointerRNA *ptr_default,
968                                      const short skip_optional_value, const short all_args);
969 char *RNA_function_as_string_keywords(struct bContext *C, FunctionRNA *func, PointerRNA *ptr_default,
970                                      const short as_function, const short all_args);
971
972 /* Function */
973
974 const char *RNA_function_identifier(FunctionRNA *func);
975 const char *RNA_function_ui_description(FunctionRNA *func);
976 int RNA_function_flag(FunctionRNA *func);
977 int RNA_function_defined(FunctionRNA *func);
978
979 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
980 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier);
981 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
982
983 /* Utility */
984
985 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
986 void RNA_parameter_list_free(ParameterList *parms);
987 int  RNA_parameter_list_size(ParameterList *parms);
988 int  RNA_parameter_list_arg_count(ParameterList *parms);
989 int  RNA_parameter_list_ret_count(ParameterList *parms);
990
991 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
992 void RNA_parameter_list_next(ParameterIterator *iter);
993 void RNA_parameter_list_end(ParameterIterator *iter);
994
995 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
996 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
997 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, const void *value);
998 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value);
999 int RNA_parameter_length_get(ParameterList *parms, PropertyRNA *parm);
1000 int RNA_parameter_length_get_data(ParameterList *parms, PropertyRNA *parm, void *data);
1001 void RNA_parameter_length_set(ParameterList *parms, PropertyRNA *parm, int length);
1002 void RNA_parameter_length_set_data(ParameterList *parms, PropertyRNA *parm, void *data, int length);
1003
1004 int RNA_function_call(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms);
1005 int RNA_function_call_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms);
1006
1007 int RNA_function_call_direct(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...)
1008 #ifdef __GNUC__
1009 __attribute__ ((format (printf, 5, 6)))
1010 #endif
1011 ;
1012 int RNA_function_call_direct_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...)
1013 #ifdef __GNUC__
1014 __attribute__ ((format (printf, 5, 6)))
1015 #endif
1016 ;
1017 int RNA_function_call_direct_va(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args);
1018 int RNA_function_call_direct_va_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args);
1019
1020 /* ID */
1021
1022 short RNA_type_to_ID_code(StructRNA *type);
1023 StructRNA *ID_code_to_RNA_type(short idcode);
1024
1025
1026 /* macro which inserts the function name */
1027 #if defined __GNUC__ || defined __sun
1028 #  define RNA_warning(format, args...) _RNA_warning("%s: " format "\n", __func__, ##args)
1029 #else
1030 #  define RNA_warning(format, ...) _RNA_warning("%s: " format "\n", __FUNCTION__, __VA_ARGS__)
1031 #endif
1032
1033 void _RNA_warning(const char *format, ...)
1034 #ifdef __GNUC__
1035 __attribute__ ((format (printf, 1, 2)))
1036 #endif
1037 ;
1038
1039 #ifdef __cplusplus
1040 }
1041 #endif
1042
1043 #endif /* __RNA_ACCESS_H__ */