Blender V2.61 - r43446

RNA_access.h

Go to the documentation of this file.
00001 /*
00002  * ***** BEGIN GPL LICENSE BLOCK *****
00003  *
00004  * This program is free software; you can redistribute it and/or
00005  * modify it under the terms of the GNU General Public License
00006  * as published by the Free Software Foundation; either version 2
00007  * of the License, or (at your option) any later version.
00008  *
00009  * This program is distributed in the hope that it will be useful,
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  * GNU General Public License for more details.
00013  *
00014  * You should have received a copy of the GNU General Public License
00015  * along with this program; if not, write to the Free Software Foundation,
00016  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00017  *
00018  * Contributor(s): Blender Foundation (2008).
00019  *
00020  * ***** END GPL LICENSE BLOCK *****
00021  */
00022 
00023 #ifndef RNA_ACCESS_H
00024 #define RNA_ACCESS_H
00025 
00030 #include <stdarg.h>
00031 
00032 #include "RNA_types.h"
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 struct bContext;
00039 struct ID;
00040 struct ListBase;
00041 struct Main;
00042 struct ReportList;
00043 struct Scene;
00044 
00045 /* Types */
00046 
00047 extern BlenderRNA BLENDER_RNA;
00048 extern StructRNA RNA_Action;
00049 extern StructRNA RNA_ActionConstraint;
00050 extern StructRNA RNA_ActionFCurves;
00051 extern StructRNA RNA_ActionGroup;
00052 extern StructRNA RNA_ActionGroups;
00053 extern StructRNA RNA_ActionPoseMarkers;
00054 extern StructRNA RNA_Actuator;
00055 extern StructRNA RNA_ActuatorSensor;
00056 extern StructRNA RNA_Addon;
00057 extern StructRNA RNA_AdjustmentSequence;
00058 extern StructRNA RNA_AlwaysSensor;
00059 extern StructRNA RNA_AndController;
00060 extern StructRNA RNA_AnimData;
00061 extern StructRNA RNA_AnimViz;
00062 extern StructRNA RNA_AnimVizMotionPaths;
00063 extern StructRNA RNA_AnimVizOnionSkinning;
00064 extern StructRNA RNA_AnyType;
00065 extern StructRNA RNA_Area;
00066 extern StructRNA RNA_AreaLamp;
00067 extern StructRNA RNA_Armature;
00068 extern StructRNA RNA_ArmatureModifier;
00069 extern StructRNA RNA_ArmatureSensor;
00070 extern StructRNA RNA_ArrayModifier;
00071 extern StructRNA RNA_BackgroundImage;
00072 extern StructRNA RNA_BevelModifier;
00073 extern StructRNA RNA_SplinePoint;
00074 extern StructRNA RNA_BezierSplinePoint;
00075 extern StructRNA RNA_BlendData;
00076 extern StructRNA RNA_BlendTexture;
00077 extern StructRNA RNA_BlenderRNA;
00078 extern StructRNA RNA_BoidRule;
00079 extern StructRNA RNA_BoidRuleAverageSpeed;
00080 extern StructRNA RNA_BoidRuleAvoid;
00081 extern StructRNA RNA_BoidRuleAvoidCollision;
00082 extern StructRNA RNA_BoidRuleFight;
00083 extern StructRNA RNA_BoidRuleFollowLeader;
00084 extern StructRNA RNA_BoidRuleGoal;
00085 extern StructRNA RNA_BoidSettings;
00086 extern StructRNA RNA_BoidState;
00087 extern StructRNA RNA_Bone;
00088 extern StructRNA RNA_BoneGroup;
00089 extern StructRNA RNA_BooleanModifier;
00090 extern StructRNA RNA_BoolProperty;
00091 extern StructRNA RNA_Brush;
00092 extern StructRNA RNA_BrushTextureSlot;
00093 extern StructRNA RNA_BuildModifier;
00094 extern StructRNA RNA_Camera;
00095 extern StructRNA RNA_CastModifier;
00096 extern StructRNA RNA_ChildOfConstraint;
00097 extern StructRNA RNA_ChildParticle;
00098 extern StructRNA RNA_ClampToConstraint;
00099 extern StructRNA RNA_ClothCollisionSettings;
00100 extern StructRNA RNA_ClothModifier;
00101 extern StructRNA RNA_ClothSettings;
00102 extern StructRNA RNA_CloudsTexture;
00103 extern StructRNA RNA_CollectionProperty;
00104 extern StructRNA RNA_CollisionModifier;
00105 extern StructRNA RNA_CollisionSensor;
00106 extern StructRNA RNA_CollisionSettings;
00107 extern StructRNA RNA_ColorRamp;
00108 extern StructRNA RNA_ColorRampElement;
00109 extern StructRNA RNA_ColorSequence;
00110 extern StructRNA RNA_CompositorNode;
00111 extern StructRNA RNA_CompositorNodeAlphaOver;
00112 extern StructRNA RNA_CompositorNodeBilateralblur;
00113 extern StructRNA RNA_CompositorNodeBlur;
00114 extern StructRNA RNA_CompositorNodeBrightContrast;
00115 extern StructRNA RNA_CompositorNodeChannelMatte;
00116 extern StructRNA RNA_CompositorNodeChromaMatte;
00117 extern StructRNA RNA_CompositorNodeColorMatte;
00118 extern StructRNA RNA_CompositorNodeColorSpill;
00119 extern StructRNA RNA_CompositorNodeCombHSVA;
00120 extern StructRNA RNA_CompositorNodeCombRGBA;
00121 extern StructRNA RNA_CompositorNodeCombYCCA;
00122 extern StructRNA RNA_CompositorNodeCombYUVA;
00123 extern StructRNA RNA_CompositorNodeComposite;
00124 extern StructRNA RNA_CompositorNodeCrop;
00125 extern StructRNA RNA_CompositorNodeCurveRGB;
00126 extern StructRNA RNA_CompositorNodeCurveVec;
00127 extern StructRNA RNA_CompositorNodeDBlur;
00128 extern StructRNA RNA_CompositorNodeDefocus;
00129 extern StructRNA RNA_CompositorNodeDiffMatte;
00130 extern StructRNA RNA_CompositorNodeDilateErode;
00131 extern StructRNA RNA_CompositorNodeDisplace;
00132 extern StructRNA RNA_CompositorNodeDistanceMatte;
00133 extern StructRNA RNA_CompositorNodeFilter;
00134 extern StructRNA RNA_CompositorNodeFlip;
00135 extern StructRNA RNA_CompositorNodeGamma;
00136 extern StructRNA RNA_CompositorNodeGlare;
00137 extern StructRNA RNA_CompositorNodeHueSat;
00138 extern StructRNA RNA_CompositorNodeIDMask;
00139 extern StructRNA RNA_CompositorNodeDoubleEdgeMask;
00140 extern StructRNA RNA_CompositorNodeImage;
00141 extern StructRNA RNA_CompositorNodeInvert;
00142 extern StructRNA RNA_CompositorNodeLensdist;
00143 extern StructRNA RNA_CompositorNodeLevels;
00144 extern StructRNA RNA_CompositorNodeLumaMatte;
00145 extern StructRNA RNA_CompositorNodeMapUV;
00146 extern StructRNA RNA_CompositorNodeMapValue;
00147 extern StructRNA RNA_CompositorNodeMath;
00148 extern StructRNA RNA_CompositorNodeMixRGB;
00149 extern StructRNA RNA_CompositorNodeNormal;
00150 extern StructRNA RNA_CompositorNodeNormalize;
00151 extern StructRNA RNA_CompositorNodeOutputFile;
00152 extern StructRNA RNA_CompositorNodePremulKey;
00153 extern StructRNA RNA_CompositorNodeRGB;
00154 extern StructRNA RNA_CompositorNodeRGBToBW;
00155 extern StructRNA RNA_CompositorNodeRLayers;
00156 extern StructRNA RNA_CompositorNodeRotate;
00157 extern StructRNA RNA_CompositorNodeScale;
00158 extern StructRNA RNA_CompositorNodeSepHSVA;
00159 extern StructRNA RNA_CompositorNodeSepRGBA;
00160 extern StructRNA RNA_CompositorNodeSepYCCA;
00161 extern StructRNA RNA_CompositorNodeSepYUVA;
00162 extern StructRNA RNA_CompositorNodeSetAlpha;
00163 extern StructRNA RNA_CompositorNodeSplitViewer;
00164 extern StructRNA RNA_CompositorNodeTexture;
00165 extern StructRNA RNA_CompositorNodeTime;
00166 extern StructRNA RNA_CompositorNodeTonemap;
00167 extern StructRNA RNA_CompositorNodeTranslate;
00168 extern StructRNA RNA_CompositorNodeTree;
00169 extern StructRNA RNA_CompositorNodeValToRGB;
00170 extern StructRNA RNA_CompositorNodeValue;
00171 extern StructRNA RNA_CompositorNodeVecBlur;
00172 extern StructRNA RNA_CompositorNodeViewer;
00173 extern StructRNA RNA_CompositorNodeZcombine;
00174 extern StructRNA RNA_ConsoleLine;
00175 extern StructRNA RNA_Constraint;
00176 extern StructRNA RNA_ConstraintTarget;
00177 extern StructRNA RNA_Context;
00178 extern StructRNA RNA_ControlFluidSettings;
00179 extern StructRNA RNA_Controller;
00180 extern StructRNA RNA_CopyLocationConstraint;
00181 extern StructRNA RNA_CopyRotationConstraint;
00182 extern StructRNA RNA_CopyScaleConstraint;
00183 extern StructRNA RNA_CopyTransformsConstraint;
00184 extern StructRNA RNA_Curve;
00185 extern StructRNA RNA_CurveMap;
00186 extern StructRNA RNA_CurveMapPoint;
00187 extern StructRNA RNA_CurveMapping;
00188 extern StructRNA RNA_CurveModifier;
00189 extern StructRNA RNA_CurvePoint;
00190 extern StructRNA RNA_DampedTrackConstraint;
00191 extern StructRNA RNA_DecimateModifier;
00192 extern StructRNA RNA_DelaySensor;
00193 extern StructRNA RNA_DisplaceModifier;
00194 extern StructRNA RNA_DistortedNoiseTexture;
00195 extern StructRNA RNA_DomainFluidSettings;
00196 extern StructRNA RNA_DopeSheet;
00197 extern StructRNA RNA_Driver;
00198 extern StructRNA RNA_DriverTarget;
00199 extern StructRNA RNA_DriverVariable;
00200 extern StructRNA RNA_DupliObject;
00201 extern StructRNA RNA_DynamicPaintBrushSettings;
00202 extern StructRNA RNA_DynamicPaintCanvasSettings;
00203 extern StructRNA RNA_DynamicPaintModifier;
00204 extern StructRNA RNA_DynamicPaintSurface;
00205 extern StructRNA RNA_EdgeSplitModifier;
00206 extern StructRNA RNA_EditBone;
00207 extern StructRNA RNA_EffectSequence;
00208 extern StructRNA RNA_EffectorWeights;
00209 extern StructRNA RNA_EnumProperty;
00210 extern StructRNA RNA_EnumPropertyItem;
00211 extern StructRNA RNA_EnvironmentMap;
00212 extern StructRNA RNA_EnvironmentMapTexture;
00213 extern StructRNA RNA_Event;
00214 extern StructRNA RNA_ExplodeModifier;
00215 extern StructRNA RNA_ExpressionController;
00216 extern StructRNA RNA_FCurve;
00217 extern StructRNA RNA_FCurveSample;
00218 extern StructRNA RNA_FFmpegSettings;
00219 extern StructRNA RNA_FModifier;
00220 extern StructRNA RNA_FModifierCycles;
00221 extern StructRNA RNA_FModifierEnvelope;
00222 extern StructRNA RNA_FModifierEnvelopeControlPoint;
00223 extern StructRNA RNA_FModifierFunctionGenerator;
00224 extern StructRNA RNA_FModifierGenerator;
00225 extern StructRNA RNA_FModifierLimits;
00226 extern StructRNA RNA_FModifierNoise;
00227 extern StructRNA RNA_FModifierPython;
00228 extern StructRNA RNA_FModifierStepped;
00229 extern StructRNA RNA_FieldSettings;
00230 extern StructRNA RNA_FileSelectParams;
00231 extern StructRNA RNA_FloatProperty;
00232 extern StructRNA RNA_FloorConstraint;
00233 extern StructRNA RNA_FluidFluidSettings;
00234 extern StructRNA RNA_FluidSettings;
00235 extern StructRNA RNA_FluidSimulationModifier;
00236 extern StructRNA RNA_FollowPathConstraint;
00237 extern StructRNA RNA_Function;
00238 extern StructRNA RNA_GPencilFrame;
00239 extern StructRNA RNA_GPencilLayer;
00240 extern StructRNA RNA_GPencilStroke;
00241 extern StructRNA RNA_GPencilStrokePoint;
00242 extern StructRNA RNA_GameBooleanProperty;
00243 extern StructRNA RNA_GameFloatProperty;
00244 extern StructRNA RNA_GameIntProperty;
00245 extern StructRNA RNA_GameObjectSettings;
00246 extern StructRNA RNA_GameProperty;
00247 extern StructRNA RNA_GameSoftBodySettings;
00248 extern StructRNA RNA_GameStringProperty;
00249 extern StructRNA RNA_GameTimerProperty;
00250 extern StructRNA RNA_GlowSequence;
00251 extern StructRNA RNA_GreasePencil;
00252 extern StructRNA RNA_Group;
00253 extern StructRNA RNA_Header;
00254 extern StructRNA RNA_HemiLamp;
00255 extern StructRNA RNA_Histogram;
00256 extern StructRNA RNA_HookModifier;
00257 extern StructRNA RNA_ID;
00258 extern StructRNA RNA_IKParam;
00259 extern StructRNA RNA_Image;
00260 extern StructRNA RNA_ImageFormatSettings;
00261 extern StructRNA RNA_ImagePaint;
00262 extern StructRNA RNA_ImageSequence;
00263 extern StructRNA RNA_ImageTexture;
00264 extern StructRNA RNA_ImageUser;
00265 extern StructRNA RNA_InflowFluidSettings;
00266 extern StructRNA RNA_IntProperty;
00267 extern StructRNA RNA_Itasc;
00268 extern StructRNA RNA_JoystickSensor;
00269 extern StructRNA RNA_Key;
00270 extern StructRNA RNA_KeyConfig;
00271 extern StructRNA RNA_KeyMap;
00272 extern StructRNA RNA_KeyMapItem;
00273 extern StructRNA RNA_KeyMapItems;
00274 extern StructRNA RNA_KeyboardSensor;
00275 extern StructRNA RNA_Keyframe;
00276 extern StructRNA RNA_KeyingSet;
00277 extern StructRNA RNA_KeyingSetInfo;
00278 extern StructRNA RNA_KeyingSetPath;
00279 extern StructRNA RNA_KeyingSetsAll;
00280 extern StructRNA RNA_KinematicConstraint;
00281 extern StructRNA RNA_Lamp;
00282 extern StructRNA RNA_LampSkySettings;
00283 extern StructRNA RNA_LampTextureSlot;
00284 extern StructRNA RNA_Lattice;
00285 extern StructRNA RNA_LatticeModifier;
00286 extern StructRNA RNA_LatticePoint;
00287 extern StructRNA RNA_Library;
00288 extern StructRNA RNA_LimitDistanceConstraint;
00289 extern StructRNA RNA_LimitLocationConstraint;
00290 extern StructRNA RNA_LimitRotationConstraint;
00291 extern StructRNA RNA_LimitScaleConstraint;
00292 extern StructRNA RNA_LockedTrackConstraint;
00293 extern StructRNA RNA_Macro;
00294 extern StructRNA RNA_MagicTexture;
00295 extern StructRNA RNA_MarbleTexture;
00296 extern StructRNA RNA_MaskModifier;
00297 extern StructRNA RNA_Material;
00298 extern StructRNA RNA_MaterialHalo;
00299 extern StructRNA RNA_MaterialPhysics;
00300 extern StructRNA RNA_MaterialRaytraceMirror;
00301 extern StructRNA RNA_MaterialRaytraceTransparency;
00302 extern StructRNA RNA_MaterialSlot;
00303 extern StructRNA RNA_MaterialStrand;
00304 extern StructRNA RNA_MaterialSubsurfaceScattering;
00305 extern StructRNA RNA_MaterialTextureSlot;
00306 extern StructRNA RNA_MaterialVolume;
00307 extern StructRNA RNA_Menu;
00308 extern StructRNA RNA_Mesh;
00309 extern StructRNA RNA_MeshColor;
00310 extern StructRNA RNA_MeshColorLayer;
00311 extern StructRNA RNA_MeshDeformModifier;
00312 extern StructRNA RNA_MeshEdge;
00313 extern StructRNA RNA_MeshFace;
00314 extern StructRNA RNA_MeshFloatProperty;
00315 extern StructRNA RNA_MeshFloatPropertyLayer;
00316 extern StructRNA RNA_MeshIntProperty;
00317 extern StructRNA RNA_MeshIntPropertyLayer;
00318 extern StructRNA RNA_MeshSticky;
00319 extern StructRNA RNA_MeshStringProperty;
00320 extern StructRNA RNA_MeshStringPropertyLayer;
00321 extern StructRNA RNA_MeshTextureFace;
00322 extern StructRNA RNA_MeshTextureFaceLayer;
00323 extern StructRNA RNA_MeshVertex;
00324 extern StructRNA RNA_MessageSensor;
00325 extern StructRNA RNA_MetaBall;
00326 extern StructRNA RNA_MetaElement;
00327 extern StructRNA RNA_MetaSequence;
00328 extern StructRNA RNA_MirrorModifier;
00329 extern StructRNA RNA_Modifier;
00330 extern StructRNA RNA_MotionPath;
00331 extern StructRNA RNA_MotionPathVert;
00332 extern StructRNA RNA_MouseSensor;
00333 extern StructRNA RNA_MovieSequence;
00334 extern StructRNA RNA_MovieTrackingObject;
00335 extern StructRNA RNA_MulticamSequence;
00336 extern StructRNA RNA_MultiresModifier;
00337 extern StructRNA RNA_MusgraveTexture;
00338 extern StructRNA RNA_NandController;
00339 extern StructRNA RNA_NearSensor;
00340 extern StructRNA RNA_NlaStrip;
00341 extern StructRNA RNA_NlaTrack;
00342 extern StructRNA RNA_Node;
00343 extern StructRNA RNA_NodeForLoop;
00344 extern StructRNA RNA_NodeGroup;
00345 extern StructRNA RNA_NodeLink;
00346 extern StructRNA RNA_NodeSocket;
00347 extern StructRNA RNA_NodeSocketPanel;
00348 extern StructRNA RNA_NodeTree;
00349 extern StructRNA RNA_NodeWhileLoop;
00350 extern StructRNA RNA_NoiseTexture;
00351 extern StructRNA RNA_NorController;
00352 extern StructRNA RNA_Object;
00353 extern StructRNA RNA_ObjectBase;
00354 extern StructRNA RNA_ObstacleFluidSettings;
00355 extern StructRNA RNA_OceanModifier;
00356 extern StructRNA RNA_OceanTexData;
00357 extern StructRNA RNA_OceanTexture;
00358 extern StructRNA RNA_Operator;
00359 extern StructRNA RNA_OperatorFileListElement;
00360 extern StructRNA RNA_OperatorMousePath;
00361 extern StructRNA RNA_OperatorProperties;
00362 extern StructRNA RNA_OperatorStrokeElement;
00363 extern StructRNA RNA_OperatorMacro;
00364 extern StructRNA RNA_OrController;
00365 extern StructRNA RNA_OutflowFluidSettings;
00366 extern StructRNA RNA_PackedFile;
00367 extern StructRNA RNA_Paint;
00368 extern StructRNA RNA_Panel;
00369 extern StructRNA RNA_Particle;
00370 extern StructRNA RNA_ParticleBrush;
00371 extern StructRNA RNA_ParticleDupliWeight;
00372 extern StructRNA RNA_ParticleEdit;
00373 extern StructRNA RNA_ParticleFluidSettings;
00374 extern StructRNA RNA_ParticleHairKey;
00375 extern StructRNA RNA_ParticleInstanceModifier;
00376 extern StructRNA RNA_ParticleKey;
00377 extern StructRNA RNA_ParticleSettings;
00378 extern StructRNA RNA_ParticleSettingsTextureSlot;
00379 extern StructRNA RNA_ParticleSystem;
00380 extern StructRNA RNA_ParticleSystemModifier;
00381 extern StructRNA RNA_ParticleTarget;
00382 extern StructRNA RNA_PivotConstraint;
00383 extern StructRNA RNA_PluginSequence;
00384 extern StructRNA RNA_PluginTexture;
00385 extern StructRNA RNA_PointCache;
00386 extern StructRNA RNA_PointDensity;
00387 extern StructRNA RNA_PointDensityTexture;
00388 extern StructRNA RNA_PointLamp;
00389 extern StructRNA RNA_PointerProperty;
00390 extern StructRNA RNA_Pose;
00391 extern StructRNA RNA_PoseBone;
00392 extern StructRNA RNA_Property;
00393 extern StructRNA RNA_PropertyGroup;
00394 extern StructRNA RNA_PropertyGroupItem;
00395 extern StructRNA RNA_PropertySensor;
00396 extern StructRNA RNA_PythonConstraint;
00397 extern StructRNA RNA_PythonController;
00398 extern StructRNA RNA_QuickTimeSettings;
00399 extern StructRNA RNA_RadarSensor;
00400 extern StructRNA RNA_RandomSensor;
00401 extern StructRNA RNA_RaySensor;
00402 extern StructRNA RNA_Region;
00403 extern StructRNA RNA_RenderEngine;
00404 extern StructRNA RNA_RenderLayer;
00405 extern StructRNA RNA_RenderPass;
00406 extern StructRNA RNA_RenderResult;
00407 extern StructRNA RNA_RenderSettings;
00408 extern StructRNA RNA_RigidBodyJointConstraint;
00409 extern StructRNA RNA_SPHFluidSettings;
00410 extern StructRNA RNA_Scene;
00411 extern StructRNA RNA_SceneGameData;
00412 extern StructRNA RNA_SceneRenderLayer;
00413 extern StructRNA RNA_SceneSequence;
00414 extern StructRNA RNA_SceneObjects;
00415 extern StructRNA RNA_Scopes;
00416 extern StructRNA RNA_Screen;
00417 extern StructRNA RNA_ScrewModifier;
00418 extern StructRNA RNA_Sculpt;
00419 extern StructRNA RNA_Sensor;
00420 extern StructRNA RNA_Sequence;
00421 extern StructRNA RNA_SequenceColorBalance;
00422 extern StructRNA RNA_SequenceCrop;
00423 extern StructRNA RNA_SequenceEditor;
00424 extern StructRNA RNA_SequenceElement;
00425 extern StructRNA RNA_SequenceProxy;
00426 extern StructRNA RNA_SequenceTransform;
00427 extern StructRNA RNA_ShaderNode;
00428 extern StructRNA RNA_ShaderNodeCameraData;
00429 extern StructRNA RNA_ShaderNodeCombineRGB;
00430 extern StructRNA RNA_ShaderNodeExtendedMaterial;
00431 extern StructRNA RNA_ShaderNodeGeometry;
00432 extern StructRNA RNA_ShaderNodeHueSaturation;
00433 extern StructRNA RNA_ShaderNodeInvert;
00434 extern StructRNA RNA_ShaderNodeMapping;
00435 extern StructRNA RNA_ShaderNodeMaterial;
00436 extern StructRNA RNA_ShaderNodeMath;
00437 extern StructRNA RNA_ShaderNodeMixRGB;
00438 extern StructRNA RNA_ShaderNodeNormal;
00439 extern StructRNA RNA_ShaderNodeOutput;
00440 extern StructRNA RNA_ShaderNodeRGB;
00441 extern StructRNA RNA_ShaderNodeRGBCurve;
00442 extern StructRNA RNA_ShaderNodeRGBToBW;
00443 extern StructRNA RNA_ShaderNodeSeparateRGB;
00444 extern StructRNA RNA_ShaderNodeSqueeze;
00445 extern StructRNA RNA_ShaderNodeTexture;
00446 extern StructRNA RNA_ShaderNodeTree;
00447 extern StructRNA RNA_ShaderNodeValToRGB;
00448 extern StructRNA RNA_ShaderNodeValue;
00449 extern StructRNA RNA_ShaderNodeVectorCurve;
00450 extern StructRNA RNA_ShaderNodeVectorMath;
00451 extern StructRNA RNA_ShapeKey;
00452 extern StructRNA RNA_ShapeKeyBezierPoint;
00453 extern StructRNA RNA_ShapeKeyCurvePoint;
00454 extern StructRNA RNA_ShapeKeyPoint;
00455 extern StructRNA RNA_ShrinkwrapConstraint;
00456 extern StructRNA RNA_ShrinkwrapModifier;
00457 extern StructRNA RNA_SimpleDeformModifier;
00458 extern StructRNA RNA_SmokeCollSettings;
00459 extern StructRNA RNA_SmokeDomainSettings;
00460 extern StructRNA RNA_SmokeFlowSettings;
00461 extern StructRNA RNA_SmokeModifier;
00462 extern StructRNA RNA_SmoothModifier;
00463 extern StructRNA RNA_SoftBodyModifier;
00464 extern StructRNA RNA_SoftBodySettings;
00465 extern StructRNA RNA_SolidifyModifier;
00466 extern StructRNA RNA_Sound;
00467 extern StructRNA RNA_SoundSequence;
00468 extern StructRNA RNA_Space;
00469 extern StructRNA RNA_SpaceConsole;
00470 extern StructRNA RNA_SpaceDopeSheetEditor;
00471 extern StructRNA RNA_SpaceFileBrowser;
00472 extern StructRNA RNA_SpaceGraphEditor;
00473 extern StructRNA RNA_SpaceImageEditor;
00474 extern StructRNA RNA_SpaceInfo;
00475 extern StructRNA RNA_SpaceLogicEditor;
00476 extern StructRNA RNA_SpaceNLA;
00477 extern StructRNA RNA_SpaceNodeEditor;
00478 extern StructRNA RNA_SpaceOutliner;
00479 extern StructRNA RNA_SpaceProperties;
00480 extern StructRNA RNA_SpaceSequenceEditor;
00481 extern StructRNA RNA_SpaceTextEditor;
00482 extern StructRNA RNA_SpaceTimeline;
00483 extern StructRNA RNA_SpaceUVEditor;
00484 extern StructRNA RNA_SpaceUserPreferences;
00485 extern StructRNA RNA_SpaceView3D;
00486 extern StructRNA RNA_SpaceClipEditor;
00487 extern StructRNA RNA_Speaker;
00488 extern StructRNA RNA_SpeedControlSequence;
00489 extern StructRNA RNA_Spline;
00490 extern StructRNA RNA_SplineIKConstraint;
00491 extern StructRNA RNA_SpotLamp;
00492 extern StructRNA RNA_StretchToConstraint;
00493 extern StructRNA RNA_StringProperty;
00494 extern StructRNA RNA_Struct;
00495 extern StructRNA RNA_StucciTexture;
00496 extern StructRNA RNA_SubsurfModifier;
00497 extern StructRNA RNA_SunLamp;
00498 extern StructRNA RNA_SurfaceCurve;
00499 extern StructRNA RNA_SurfaceModifier;
00500 extern StructRNA RNA_TexMapping;
00501 extern StructRNA RNA_Text;
00502 extern StructRNA RNA_TextBox;
00503 extern StructRNA RNA_TextCharacterFormat;
00504 extern StructRNA RNA_TextCurve;
00505 extern StructRNA RNA_TextLine;
00506 extern StructRNA RNA_TextMarker;
00507 extern StructRNA RNA_Texture;
00508 extern StructRNA RNA_TextureNode;
00509 extern StructRNA RNA_TextureNodeBricks;
00510 extern StructRNA RNA_TextureNodeChecker;
00511 extern StructRNA RNA_TextureNodeCompose;
00512 extern StructRNA RNA_TextureNodeCoordinates;
00513 extern StructRNA RNA_TextureNodeCurveRGB;
00514 extern StructRNA RNA_TextureNodeCurveTime;
00515 extern StructRNA RNA_TextureNodeDecompose;
00516 extern StructRNA RNA_TextureNodeDistance;
00517 extern StructRNA RNA_TextureNodeHueSaturation;
00518 extern StructRNA RNA_TextureNodeImage;
00519 extern StructRNA RNA_TextureNodeInvert;
00520 extern StructRNA RNA_TextureNodeMath;
00521 extern StructRNA RNA_TextureNodeMixRGB;
00522 extern StructRNA RNA_TextureNodeOutput;
00523 extern StructRNA RNA_TextureNodeRGBToBW;
00524 extern StructRNA RNA_TextureNodeRotate;
00525 extern StructRNA RNA_TextureNodeScale;
00526 extern StructRNA RNA_TextureNodeTexture;
00527 extern StructRNA RNA_TextureNodeTranslate;
00528 extern StructRNA RNA_TextureNodeTree;
00529 extern StructRNA RNA_TextureNodeValToNor;
00530 extern StructRNA RNA_TextureNodeValToRGB;
00531 extern StructRNA RNA_TextureNodeViewer;
00532 extern StructRNA RNA_TextureSlot;
00533 extern StructRNA RNA_Theme;
00534 extern StructRNA RNA_ThemeAudioWindow;
00535 extern StructRNA RNA_ThemeBoneColorSet;
00536 extern StructRNA RNA_ThemeConsole;
00537 extern StructRNA RNA_ThemeDopeSheet;
00538 extern StructRNA RNA_ThemeFileBrowser;
00539 extern StructRNA RNA_ThemeFontStyle;
00540 extern StructRNA RNA_ThemeGraphEditor;
00541 extern StructRNA RNA_ThemeImageEditor;
00542 extern StructRNA RNA_ThemeInfo;
00543 extern StructRNA RNA_ThemeLogicEditor;
00544 extern StructRNA RNA_ThemeNLAEditor;
00545 extern StructRNA RNA_ThemeNodeEditor;
00546 extern StructRNA RNA_ThemeOutliner;
00547 extern StructRNA RNA_ThemeProperties;
00548 extern StructRNA RNA_ThemeSequenceEditor;
00549 extern StructRNA RNA_ThemeSpaceGeneric;
00550 extern StructRNA RNA_ThemeSpaceListGeneric;
00551 extern StructRNA RNA_ThemeStyle;
00552 extern StructRNA RNA_ThemeTextEditor;
00553 extern StructRNA RNA_ThemeTimeline;
00554 extern StructRNA RNA_ThemeUserInterface;
00555 extern StructRNA RNA_ThemeUserPreferences;
00556 extern StructRNA RNA_ThemeView3D;
00557 extern StructRNA RNA_ThemeWidgetColors;
00558 extern StructRNA RNA_ThemeWidgetStateColors;
00559 extern StructRNA RNA_TimelineMarker;
00560 extern StructRNA RNA_Timer;
00561 extern StructRNA RNA_ToolSettings;
00562 extern StructRNA RNA_TouchSensor;
00563 extern StructRNA RNA_TrackToConstraint;
00564 extern StructRNA RNA_TransformConstraint;
00565 extern StructRNA RNA_TransformSequence;
00566 extern StructRNA RNA_UILayout;
00567 extern StructRNA RNA_UIListItem;
00568 extern StructRNA RNA_UVProjectModifier;
00569 extern StructRNA RNA_UVProjector;
00570 extern StructRNA RNA_UnitSettings;
00571 extern StructRNA RNA_UnknownType;
00572 extern StructRNA RNA_UserPreferences;
00573 extern StructRNA RNA_UserPreferencesEdit;
00574 extern StructRNA RNA_UserPreferencesFilePaths;
00575 extern StructRNA RNA_UserPreferencesInput;
00576 extern StructRNA RNA_UserPreferencesSystem;
00577 extern StructRNA RNA_UserPreferencesView;
00578 extern StructRNA RNA_UserSolidLight;
00579 extern StructRNA RNA_VectorFont;
00580 extern StructRNA RNA_VertexGroup;
00581 extern StructRNA RNA_VertexGroupElement;
00582 extern StructRNA RNA_VertexPaint;
00583 extern StructRNA RNA_VoronoiTexture;
00584 extern StructRNA RNA_VoxelData;
00585 extern StructRNA RNA_VoxelDataTexture;
00586 extern StructRNA RNA_WarpModifier;
00587 extern StructRNA RNA_WaveModifier;
00588 extern StructRNA RNA_VertexWeightEditModifier;
00589 extern StructRNA RNA_VertexWeightMixModifier;
00590 extern StructRNA RNA_VertexWeightProximityModifier;
00591 extern StructRNA RNA_Window;
00592 extern StructRNA RNA_WindowManager;
00593 extern StructRNA RNA_WipeSequence;
00594 extern StructRNA RNA_WoodTexture;
00595 extern StructRNA RNA_World;
00596 extern StructRNA RNA_WorldAmbientOcclusion;
00597 extern StructRNA RNA_WorldLighting;
00598 extern StructRNA RNA_WorldMistSettings;
00599 extern StructRNA RNA_WorldStarsSettings;
00600 extern StructRNA RNA_WorldTextureSlot;
00601 extern StructRNA RNA_XnorController;
00602 extern StructRNA RNA_XorController;
00603 
00604 /* Pointer
00605  *
00606  * These functions will fill in RNA pointers, this can be done in three ways:
00607  * - a pointer Main is created by just passing the data pointer
00608  * - a pointer to a datablock can be created with the type and id data pointer
00609  * - a pointer to data contained in a datablock can be created with the id type
00610  *   and id data pointer, and the data type and pointer to the struct itself.
00611  *
00612  * There is also a way to get a pointer with the information about all structs.
00613  */
00614 
00615 void RNA_main_pointer_create(struct Main *main, PointerRNA *r_ptr);
00616 void RNA_id_pointer_create(struct ID *id, PointerRNA *r_ptr);
00617 void RNA_pointer_create(struct ID *id, StructRNA *type, void *data, PointerRNA *r_ptr);
00618 
00619 void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
00620 void RNA_pointer_recast(PointerRNA *ptr, PointerRNA *r_ptr);
00621 
00622 extern const PointerRNA PointerRNA_NULL;
00623 
00624 /* Structs */
00625 
00626 StructRNA *RNA_struct_find(const char *identifier);
00627 
00628 const char *RNA_struct_identifier(StructRNA *type);
00629 const char *RNA_struct_ui_name(StructRNA *type);
00630 const char *RNA_struct_ui_description(StructRNA *type);
00631 int RNA_struct_ui_icon(StructRNA *type);
00632 
00633 PropertyRNA *RNA_struct_name_property(StructRNA *type);
00634 PropertyRNA *RNA_struct_iterator_property(StructRNA *type);
00635 StructRNA *RNA_struct_base(StructRNA *type);
00636 
00637 int RNA_struct_is_ID(StructRNA *type);
00638 int RNA_struct_is_a(StructRNA *type, StructRNA *srna);
00639 
00640 int RNA_struct_undo_check(StructRNA *type);
00641 
00642 StructRegisterFunc RNA_struct_register(StructRNA *type);
00643 StructUnregisterFunc RNA_struct_unregister(StructRNA *type);
00644 void **RNA_struct_instance(PointerRNA *ptr);
00645 
00646 void *RNA_struct_py_type_get(StructRNA *srna);
00647 void RNA_struct_py_type_set(StructRNA *srna, void *py_type);
00648 
00649 void *RNA_struct_blender_type_get(StructRNA *srna);
00650 void RNA_struct_blender_type_set(StructRNA *srna, void *blender_type);
00651 
00652 struct IDProperty *RNA_struct_idprops(PointerRNA *ptr, int create);
00653 int RNA_struct_idprops_check(StructRNA *srna);
00654 int RNA_struct_idprops_register_check(StructRNA *type);
00655 int RNA_struct_idprops_unset(PointerRNA *ptr, const char *identifier);
00656 
00657 PropertyRNA *RNA_struct_find_property(PointerRNA *ptr, const char *identifier);
00658 int RNA_struct_contains_property(PointerRNA *ptr, PropertyRNA *prop_test);
00659 
00660 /* lower level functions for access to type properties */
00661 const struct ListBase *RNA_struct_type_properties(StructRNA *srna);
00662 PropertyRNA *RNA_struct_type_find_property(StructRNA *srna, const char *identifier);
00663 
00664 FunctionRNA *RNA_struct_find_function(PointerRNA *ptr, const char *identifier);
00665 const struct ListBase *RNA_struct_type_functions(StructRNA *srna);
00666 
00667 char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, int *r_len);
00668 
00669 /* Properties
00670  *
00671  * Access to struct properties. All this works with RNA pointers rather than
00672  * direct pointers to the data. */
00673 
00674 /* Property Information */
00675 
00676 const char *RNA_property_identifier(PropertyRNA *prop);
00677 const char *RNA_property_description(PropertyRNA *prop);
00678 
00679 PropertyType RNA_property_type(PropertyRNA *prop);
00680 PropertySubType RNA_property_subtype(PropertyRNA *prop);
00681 PropertyUnit RNA_property_unit(PropertyRNA *prop);
00682 int RNA_property_flag(PropertyRNA *prop);
00683 void *RNA_property_py_data_get(PropertyRNA *prop);
00684 
00685 int RNA_property_array_length(PointerRNA *ptr, PropertyRNA *prop);
00686 int RNA_property_array_check(PropertyRNA *prop);
00687 int RNA_property_multi_array_length(PointerRNA *ptr, PropertyRNA *prop, int dimension);
00688 int RNA_property_array_dimension(PointerRNA *ptr, PropertyRNA *prop, int length[]);
00689 char RNA_property_array_item_char(PropertyRNA *prop, int index);
00690 int RNA_property_array_item_index(PropertyRNA *prop, char name);
00691 
00692 int RNA_property_string_maxlength(PropertyRNA *prop);
00693 
00694 const char *RNA_property_ui_name(PropertyRNA *prop);
00695 const char *RNA_property_ui_description(PropertyRNA *prop);
00696 int RNA_property_ui_icon(PropertyRNA *prop);
00697 
00698 /* Dynamic Property Information */
00699 
00700 void RNA_property_int_range(PointerRNA *ptr, PropertyRNA *prop, int *hardmin, int *hardmax);
00701 void RNA_property_int_ui_range(PointerRNA *ptr, PropertyRNA *prop, int *softmin, int *softmax, int *step);
00702 
00703 void RNA_property_float_range(PointerRNA *ptr, PropertyRNA *prop, float *hardmin, float *hardmax);
00704 void RNA_property_float_ui_range(PointerRNA *ptr, PropertyRNA *prop, float *softmin, float *softmax, float *step, float *precision);
00705 
00706 int RNA_property_float_clamp(PointerRNA *ptr, PropertyRNA *prop, float *value);
00707 int RNA_property_int_clamp(PointerRNA *ptr, PropertyRNA *prop, int *value);
00708 
00709 int RNA_enum_identifier(EnumPropertyItem *item, const int value, const char **identifier);
00710 int RNA_enum_bitflag_identifiers(EnumPropertyItem *item, const int value, const char **identifier);
00711 int RNA_enum_name(EnumPropertyItem *item, const int value, const char **name);
00712 int RNA_enum_description(EnumPropertyItem *item, const int value, const char **description);
00713 
00714 void RNA_property_enum_items(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
00715 void RNA_property_enum_items_gettexted(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, EnumPropertyItem **item, int *totitem, int *free);
00716 int RNA_property_enum_value(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const char *identifier, int *value);
00717 int RNA_property_enum_identifier(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
00718 int RNA_property_enum_name(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **name);
00719 int RNA_property_enum_bitflag_identifiers(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, const int value, const char **identifier);
00720 
00721 StructRNA *RNA_property_pointer_type(PointerRNA *ptr, PropertyRNA *prop);
00722 int RNA_property_pointer_poll(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *value);
00723 
00724 int RNA_property_editable(PointerRNA *ptr, PropertyRNA *prop);
00725 int RNA_property_editable_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00726 int RNA_property_editable_flag(PointerRNA *ptr, PropertyRNA *prop); /* without lib check, only checks the flag */
00727 int RNA_property_animateable(PointerRNA *ptr, PropertyRNA *prop);
00728 int RNA_property_animated(PointerRNA *ptr, PropertyRNA *prop);
00729 int RNA_property_path_from_ID_check(PointerRNA *ptr, PropertyRNA *prop); /* slow, use with care */
00730 
00731 void RNA_property_update(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
00732 void RNA_property_update_main(struct Main *bmain, struct Scene *scene, PointerRNA *ptr, PropertyRNA *prop);
00733 int RNA_property_update_check(struct PropertyRNA *prop);
00734 
00735 void RNA_property_update_cache_add(PointerRNA *ptr, PropertyRNA *prop);
00736 void RNA_property_update_cache_flush(struct Main *bmain, struct Scene *scene);
00737 void RNA_property_update_cache_free(void);
00738 
00739 /* Property Data */
00740 
00741 int RNA_property_boolean_get(PointerRNA *ptr, PropertyRNA *prop);
00742 void RNA_property_boolean_set(PointerRNA *ptr, PropertyRNA *prop, int value);
00743 void RNA_property_boolean_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
00744 int RNA_property_boolean_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00745 void RNA_property_boolean_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
00746 void RNA_property_boolean_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
00747 int RNA_property_boolean_get_default(PointerRNA *ptr, PropertyRNA *prop);
00748 void RNA_property_boolean_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
00749 int RNA_property_boolean_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00750 
00751 int RNA_property_int_get(PointerRNA *ptr, PropertyRNA *prop);
00752 void RNA_property_int_set(PointerRNA *ptr, PropertyRNA *prop, int value);
00753 void RNA_property_int_get_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
00754 void RNA_property_int_get_array_range(PointerRNA *ptr, PropertyRNA *prop, int values[2]);
00755 int RNA_property_int_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00756 void RNA_property_int_set_array(PointerRNA *ptr, PropertyRNA *prop, const int *values);
00757 void RNA_property_int_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, int value);
00758 int RNA_property_int_get_default(PointerRNA *ptr, PropertyRNA *prop);
00759 void RNA_property_int_get_default_array(PointerRNA *ptr, PropertyRNA *prop, int *values);
00760 int RNA_property_int_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00761 
00762 float RNA_property_float_get(PointerRNA *ptr, PropertyRNA *prop);
00763 void RNA_property_float_set(PointerRNA *ptr, PropertyRNA *prop, float value);
00764 void RNA_property_float_get_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
00765 void RNA_property_float_get_array_range(PointerRNA *ptr, PropertyRNA *prop, float values[2]);
00766 float RNA_property_float_get_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00767 void RNA_property_float_set_array(PointerRNA *ptr, PropertyRNA *prop, const float *values);
00768 void RNA_property_float_set_index(PointerRNA *ptr, PropertyRNA *prop, int index, float value);
00769 float RNA_property_float_get_default(PointerRNA *ptr, PropertyRNA *prop);
00770 void RNA_property_float_get_default_array(PointerRNA *ptr, PropertyRNA *prop, float *values);
00771 float RNA_property_float_get_default_index(PointerRNA *ptr, PropertyRNA *prop, int index);
00772 
00773 void RNA_property_string_get(PointerRNA *ptr, PropertyRNA *prop, char *value);
00774 char *RNA_property_string_get_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen, int *r_len);
00775 void RNA_property_string_set(PointerRNA *ptr, PropertyRNA *prop, const char *value);
00776 int RNA_property_string_length(PointerRNA *ptr, PropertyRNA *prop);
00777 void RNA_property_string_get_default(PointerRNA *ptr, PropertyRNA *prop, char *value);
00778 char *RNA_property_string_get_default_alloc(PointerRNA *ptr, PropertyRNA *prop, char *fixedbuf, int fixedlen);
00779 int RNA_property_string_default_length(PointerRNA *ptr, PropertyRNA *prop);
00780 
00781 int RNA_property_enum_get(PointerRNA *ptr, PropertyRNA *prop);
00782 void RNA_property_enum_set(PointerRNA *ptr, PropertyRNA *prop, int value);
00783 int RNA_property_enum_get_default(PointerRNA *ptr, PropertyRNA *prop);
00784 void *RNA_property_enum_py_data_get(PropertyRNA *prop);
00785 
00786 PointerRNA RNA_property_pointer_get(PointerRNA *ptr, PropertyRNA *prop);
00787 void RNA_property_pointer_set(PointerRNA *ptr, PropertyRNA *prop, PointerRNA ptr_value);
00788 PointerRNA RNA_property_pointer_get_default(PointerRNA *ptr, PropertyRNA *prop);
00789 
00790 void RNA_property_collection_begin(PointerRNA *ptr, PropertyRNA *prop, CollectionPropertyIterator *iter);
00791 void RNA_property_collection_next(CollectionPropertyIterator *iter);
00792 void RNA_property_collection_end(CollectionPropertyIterator *iter);
00793 int RNA_property_collection_length(PointerRNA *ptr, PropertyRNA *prop);
00794 int RNA_property_collection_lookup_index(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *t_ptr);
00795 int RNA_property_collection_lookup_int(PointerRNA *ptr, PropertyRNA *prop, int key, PointerRNA *r_ptr);
00796 int RNA_property_collection_lookup_string(PointerRNA *ptr, PropertyRNA *prop, const char *key, PointerRNA *r_ptr);
00797 int RNA_property_collection_assign_int(PointerRNA *ptr, PropertyRNA *prop, const int key, const PointerRNA *assign_ptr);
00798 int RNA_property_collection_type_get(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
00799 
00800 /* efficient functions to set properties for arrays */
00801 int RNA_property_collection_raw_array(PointerRNA *ptr, PropertyRNA *prop, PropertyRNA *itemprop, RawArray *array);
00802 int RNA_property_collection_raw_get(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
00803 int RNA_property_collection_raw_set(struct ReportList *reports, PointerRNA *ptr, PropertyRNA *prop, const char *propname, void *array, RawPropertyType type, int len);
00804 int RNA_raw_type_sizeof(RawPropertyType type);
00805 RawPropertyType RNA_property_raw_type(PropertyRNA *prop);
00806 
00807 
00808 /* to create ID property groups */
00809 void RNA_property_pointer_add(PointerRNA *ptr, PropertyRNA *prop);
00810 void RNA_property_pointer_remove(PointerRNA *ptr, PropertyRNA *prop);
00811 void RNA_property_collection_add(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *r_ptr);
00812 int RNA_property_collection_remove(PointerRNA *ptr, PropertyRNA *prop, int key);
00813 void RNA_property_collection_clear(PointerRNA *ptr, PropertyRNA *prop);
00814 int RNA_property_collection_move(PointerRNA *ptr, PropertyRNA *prop, int key, int pos);
00815 
00816 /* copy/reset */
00817 int RNA_property_copy(PointerRNA *ptr, PointerRNA *fromptr, PropertyRNA *prop, int index);
00818 int RNA_property_reset(PointerRNA *ptr, PropertyRNA *prop, int index);
00819 
00820 /* Path
00821  *
00822  * Experimental method to refer to structs and properties with a string,
00823  * using a syntax like: scenes[0].objects["Cube"].data.verts[7].co
00824  *
00825  * This provides a way to refer to RNA data while being detached from any
00826  * particular pointers, which is useful in a number of applications, like
00827  * UI code or Actions, though efficiency is a concern. */
00828 
00829 char *RNA_path_append(const char *path, PointerRNA *ptr, PropertyRNA *prop,
00830     int intkey, const char *strkey);
00831 char *RNA_path_back(const char *path);
00832 
00833 int RNA_path_resolve(PointerRNA *ptr, const char *path,
00834         PointerRNA *r_ptr, PropertyRNA **r_prop);
00835 
00836 int RNA_path_resolve_full(PointerRNA *ptr, const char *path,
00837         PointerRNA *r_ptr, PropertyRNA **r_prop, int *index);
00838 
00839 char *RNA_path_from_ID_to_struct(PointerRNA *ptr);
00840 char *RNA_path_from_ID_to_property(PointerRNA *ptr, PropertyRNA *prop);
00841 
00842 /* Quick name based property access
00843  *
00844  * These are just an easier way to access property values without having to
00845  * call RNA_struct_find_property. The names have to exist as RNA properties
00846  * for the type in the pointer, if they do not exist an error will be printed.
00847  *
00848  * There is no support for pointers and collections here yet, these can be 
00849  * added when ID properties support them. */
00850 
00851 int RNA_boolean_get(PointerRNA *ptr, const char *name);
00852 void RNA_boolean_set(PointerRNA *ptr, const char *name, int value);
00853 void RNA_boolean_get_array(PointerRNA *ptr, const char *name, int *values);
00854 void RNA_boolean_set_array(PointerRNA *ptr, const char *name, const int *values);
00855 
00856 int RNA_int_get(PointerRNA *ptr, const char *name);
00857 void RNA_int_set(PointerRNA *ptr, const char *name, int value);
00858 void RNA_int_get_array(PointerRNA *ptr, const char *name, int *values);
00859 void RNA_int_set_array(PointerRNA *ptr, const char *name, const int *values);
00860 
00861 float RNA_float_get(PointerRNA *ptr, const char *name);
00862 void RNA_float_set(PointerRNA *ptr, const char *name, float value);
00863 void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values);
00864 void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values);
00865 
00866 int RNA_enum_get(PointerRNA *ptr, const char *name);
00867 void RNA_enum_set(PointerRNA *ptr, const char *name, int value);
00868 void RNA_enum_set_identifier(PointerRNA *ptr, const char *name, const char *id);
00869 int RNA_enum_is_equal(struct bContext *C, PointerRNA *ptr, const char *name, const char *enumname);
00870 
00871 /* lower level functions that don't use a PointerRNA */
00872 int RNA_enum_value_from_id(EnumPropertyItem *item, const char *identifier, int *value);
00873 int RNA_enum_id_from_value(EnumPropertyItem *item, int value, const char **identifier);
00874 int RNA_enum_icon_from_value(EnumPropertyItem *item, int value, int *icon);
00875 
00876 void RNA_string_get(PointerRNA *ptr, const char *name, char *value);
00877 char *RNA_string_get_alloc(PointerRNA *ptr, const char *name, char *fixedbuf, int fixedlen);
00878 int RNA_string_length(PointerRNA *ptr, const char *name);
00879 void RNA_string_set(PointerRNA *ptr, const char *name, const char *value);
00880 
00884 PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name);
00885 /* Set the property name of PointerRNA ptr to ptr_value */
00886 void RNA_pointer_set(PointerRNA *ptr, const char *name, PointerRNA ptr_value);
00887 void RNA_pointer_add(PointerRNA *ptr, const char *name);
00888 
00889 void RNA_collection_begin(PointerRNA *ptr, const char *name, CollectionPropertyIterator *iter);
00890 int RNA_collection_length(PointerRNA *ptr, const char *name);
00891 void RNA_collection_add(PointerRNA *ptr, const char *name, PointerRNA *r_value);
00892 void RNA_collection_clear(PointerRNA *ptr, const char *name);
00893 
00894 #define RNA_BEGIN(sptr, itemptr, propname)                                    \
00895     {                                                                         \
00896         CollectionPropertyIterator rna_macro_iter;                            \
00897         for(RNA_collection_begin(sptr, propname, &rna_macro_iter);            \
00898             rna_macro_iter.valid;                                             \
00899             RNA_property_collection_next(&rna_macro_iter))                    \
00900         {                                                                     \
00901             PointerRNA itemptr= rna_macro_iter.ptr;
00902 
00903 #define RNA_END                                                               \
00904         }                                                                     \
00905         RNA_property_collection_end(&rna_macro_iter);                         \
00906     }
00907 
00908 #define RNA_PROP_BEGIN(sptr, itemptr, prop)                                   \
00909     {                                                                         \
00910         CollectionPropertyIterator rna_macro_iter;                            \
00911         for(RNA_property_collection_begin(sptr, prop, &rna_macro_iter);       \
00912             rna_macro_iter.valid;                                             \
00913             RNA_property_collection_next(&rna_macro_iter))                    \
00914         {                                                                     \
00915             PointerRNA itemptr= rna_macro_iter.ptr;
00916 
00917 #define RNA_PROP_END                                                          \
00918         }                                                                     \
00919         RNA_property_collection_end(&rna_macro_iter);                         \
00920     }
00921 
00922 #define RNA_STRUCT_BEGIN(sptr, prop)                                          \
00923     {                                                                         \
00924         CollectionPropertyIterator rna_macro_iter;                            \
00925         for(RNA_property_collection_begin(                                    \
00926                     sptr,                                                     \
00927                     RNA_struct_iterator_property(sptr->type),                 \
00928                     &rna_macro_iter);                                         \
00929             rna_macro_iter.valid;                                             \
00930             RNA_property_collection_next(&rna_macro_iter))                    \
00931         {                                                                     \
00932             PropertyRNA *prop= rna_macro_iter.ptr.data;
00933 
00934 #define RNA_STRUCT_END                                                        \
00935         }                                                                     \
00936         RNA_property_collection_end(&rna_macro_iter);                         \
00937     }
00938 
00939 /* check if the idproperty exists, for operators */
00940 int RNA_property_is_set(PointerRNA *ptr, PropertyRNA *prop);
00941 int RNA_struct_property_is_set(PointerRNA *ptr, const char *identifier);
00942 int RNA_property_is_idprop(PropertyRNA *prop);
00943 
00944 /* python compatible string representation of this property, (must be freed!) */
00945 char *RNA_property_as_string(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop);
00946 char *RNA_pointer_as_string(struct bContext *C, PointerRNA *ptr);
00947 
00948 /* Function */
00949 
00950 const char *RNA_function_identifier(FunctionRNA *func);
00951 const char *RNA_function_ui_description(FunctionRNA *func);
00952 int RNA_function_flag(FunctionRNA *func);
00953 int RNA_function_defined(FunctionRNA *func);
00954 
00955 PropertyRNA *RNA_function_get_parameter(PointerRNA *ptr, FunctionRNA *func, int index);
00956 PropertyRNA *RNA_function_find_parameter(PointerRNA *ptr, FunctionRNA *func, const char *identifier);
00957 const struct ListBase *RNA_function_defined_parameters(FunctionRNA *func);
00958 
00959 /* Utility */
00960 
00961 ParameterList *RNA_parameter_list_create(ParameterList *parms, PointerRNA *ptr, FunctionRNA *func);
00962 void RNA_parameter_list_free(ParameterList *parms);
00963 int  RNA_parameter_list_size(ParameterList *parms);
00964 int  RNA_parameter_list_arg_count(ParameterList *parms);
00965 int  RNA_parameter_list_ret_count(ParameterList *parms);
00966 
00967 void RNA_parameter_list_begin(ParameterList *parms, ParameterIterator *iter);
00968 void RNA_parameter_list_next(ParameterIterator *iter);
00969 void RNA_parameter_list_end(ParameterIterator *iter);
00970 
00971 void RNA_parameter_get(ParameterList *parms, PropertyRNA *parm, void **value);
00972 void RNA_parameter_get_lookup(ParameterList *parms, const char *identifier, void **value);
00973 void RNA_parameter_set(ParameterList *parms, PropertyRNA *parm, const void *value);
00974 void RNA_parameter_set_lookup(ParameterList *parms, const char *identifier, const void *value);
00975 int RNA_parameter_length_get(ParameterList *parms, PropertyRNA *parm);
00976 int RNA_parameter_length_get_data(ParameterList *parms, PropertyRNA *parm, void *data);
00977 void RNA_parameter_length_set(ParameterList *parms, PropertyRNA *parm, int length);
00978 void RNA_parameter_length_set_data(ParameterList *parms, PropertyRNA *parm, void *data, int length);
00979 
00980 int RNA_function_call(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, ParameterList *parms);
00981 int RNA_function_call_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, ParameterList *parms);
00982 
00983 int RNA_function_call_direct(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, ...)
00984 #ifdef __GNUC__
00985 __attribute__ ((format (printf, 5, 6)))
00986 #endif
00987 ;
00988 int RNA_function_call_direct_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, ...)
00989 #ifdef __GNUC__
00990 __attribute__ ((format (printf, 5, 6)))
00991 #endif
00992 ;
00993 int RNA_function_call_direct_va(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, FunctionRNA *func, const char *format, va_list args);
00994 int RNA_function_call_direct_va_lookup(struct bContext *C, struct ReportList *reports, PointerRNA *ptr, const char *identifier, const char *format, va_list args);
00995 
00996 /* ID */
00997 
00998 short RNA_type_to_ID_code(StructRNA *type);
00999 StructRNA *ID_code_to_RNA_type(short idcode);
01000 
01001 
01002 /* macro which inserts the function name */
01003 #if defined __GNUC__ || defined __sun
01004 #  define RNA_warning(format, args...) _RNA_warning("%s: " format "\n", __func__, ##args)
01005 #else
01006 #  define RNA_warning(format, ...) _RNA_warning("%s: " format "\n", __FUNCTION__, __VA_ARGS__)
01007 #endif
01008 
01009 void _RNA_warning(const char *format, ...)
01010 #ifdef __GNUC__
01011 __attribute__ ((format (printf, 1, 2)))
01012 #endif
01013 ;
01014 
01015 #ifdef __cplusplus
01016 }
01017 #endif
01018 
01019 #endif /* RNA_ACCESS_H */