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