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