[Bf-blender-cvs] [ffc4c126f54] master: Cleanup: move public doc-strings into headers for 'blenkernel'
Campbell Barton
noreply at git.blender.org
Tue Dec 7 07:39:25 CET 2021
Commit: ffc4c126f5416b04a01653e7a03451797b98aba4
Author: Campbell Barton
Date: Tue Dec 7 17:19:15 2021 +1100
Branches: master
https://developer.blender.org/rBffc4c126f5416b04a01653e7a03451797b98aba4
Cleanup: move public doc-strings into headers for 'blenkernel'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
===================================================================
M source/blender/blenkernel/BKE_DerivedMesh.h
M source/blender/blenkernel/BKE_action.h
M source/blender/blenkernel/BKE_anim_data.h
M source/blender/blenkernel/BKE_anim_path.h
M source/blender/blenkernel/BKE_anim_visualization.h
M source/blender/blenkernel/BKE_animsys.h
M source/blender/blenkernel/BKE_appdir.h
M source/blender/blenkernel/BKE_armature.h
M source/blender/blenkernel/BKE_asset.h
M source/blender/blenkernel/BKE_asset_catalog.hh
M source/blender/blenkernel/BKE_attribute_access.hh
M source/blender/blenkernel/BKE_autoexec.h
M source/blender/blenkernel/BKE_blender.h
M source/blender/blenkernel/BKE_blender_copybuffer.h
M source/blender/blenkernel/BKE_blendfile.h
M source/blender/blenkernel/BKE_blendfile_link_append.h
M source/blender/blenkernel/BKE_boids.h
M source/blender/blenkernel/BKE_brush.h
M source/blender/blenkernel/BKE_bvhutils.h
M source/blender/blenkernel/BKE_cachefile.h
M source/blender/blenkernel/BKE_callbacks.h
M source/blender/blenkernel/BKE_camera.h
M source/blender/blenkernel/BKE_cloth.h
M source/blender/blenkernel/BKE_collection.h
M source/blender/blenkernel/BKE_collision.h
M source/blender/blenkernel/BKE_colortools.h
M source/blender/blenkernel/BKE_constraint.h
M source/blender/blenkernel/BKE_context.h
M source/blender/blenkernel/BKE_crazyspace.h
M source/blender/blenkernel/BKE_cryptomatte.h
M source/blender/blenkernel/BKE_cryptomatte.hh
M source/blender/blenkernel/BKE_curve.h
M source/blender/blenkernel/BKE_curve_to_mesh.hh
M source/blender/blenkernel/BKE_curveprofile.h
M source/blender/blenkernel/BKE_customdata.h
M source/blender/blenkernel/BKE_data_transfer.h
M source/blender/blenkernel/BKE_deform.h
M source/blender/blenkernel/BKE_displist.h
M source/blender/blenkernel/BKE_duplilist.h
M source/blender/blenkernel/BKE_dynamicpaint.h
M source/blender/blenkernel/BKE_editmesh.h
M source/blender/blenkernel/BKE_editmesh_bvh.h
M source/blender/blenkernel/BKE_editmesh_tangent.h
M source/blender/blenkernel/BKE_effect.h
M source/blender/blenkernel/BKE_fcurve.h
M source/blender/blenkernel/BKE_fcurve_driver.h
M source/blender/blenkernel/BKE_fluid.h
M source/blender/blenkernel/BKE_freestyle.h
M source/blender/blenkernel/BKE_geometry_set.hh
M source/blender/blenkernel/BKE_geometry_set_instances.hh
M source/blender/blenkernel/BKE_gpencil.h
M source/blender/blenkernel/BKE_gpencil_curve.h
M source/blender/blenkernel/BKE_gpencil_geom.h
M source/blender/blenkernel/BKE_gpencil_modifier.h
M source/blender/blenkernel/BKE_icons.h
M source/blender/blenkernel/BKE_idprop.h
M source/blender/blenkernel/BKE_idtype.h
M source/blender/blenkernel/BKE_image.h
M source/blender/blenkernel/BKE_ipo.h
M source/blender/blenkernel/BKE_key.h
M source/blender/blenkernel/BKE_keyconfig.h
M source/blender/blenkernel/BKE_layer.h
M source/blender/blenkernel/BKE_lib_id.h
M source/blender/blenkernel/BKE_lib_override.h
M source/blender/blenkernel/BKE_lib_query.h
M source/blender/blenkernel/BKE_lib_remap.h
M source/blender/blenkernel/BKE_linestyle.h
M source/blender/blenkernel/BKE_main.h
M source/blender/blenkernel/BKE_main_idmap.h
M source/blender/blenkernel/BKE_mask.h
M source/blender/blenkernel/BKE_material.h
M source/blender/blenkernel/BKE_mball.h
M source/blender/blenkernel/BKE_mesh.h
M source/blender/blenkernel/BKE_mesh_boolean_convert.hh
M source/blender/blenkernel/BKE_mesh_iterators.h
M source/blender/blenkernel/BKE_mesh_mapping.h
M source/blender/blenkernel/BKE_mesh_mirror.h
M source/blender/blenkernel/BKE_mesh_remap.h
M source/blender/blenkernel/BKE_mesh_runtime.h
M source/blender/blenkernel/BKE_mesh_tangent.h
M source/blender/blenkernel/BKE_modifier.h
M source/blender/blenkernel/BKE_movieclip.h
M source/blender/blenkernel/BKE_multires.h
M source/blender/blenkernel/BKE_nla.h
M source/blender/blenkernel/BKE_node.h
M source/blender/blenkernel/BKE_object.h
M source/blender/blenkernel/BKE_object_deform.h
M source/blender/blenkernel/BKE_ocean.h
M source/blender/blenkernel/BKE_packedFile.h
M source/blender/blenkernel/BKE_paint.h
M source/blender/blenkernel/BKE_particle.h
M source/blender/blenkernel/BKE_pbvh.h
M source/blender/blenkernel/BKE_pointcache.h
M source/blender/blenkernel/BKE_preferences.h
M source/blender/blenkernel/BKE_report.h
M source/blender/blenkernel/BKE_rigidbody.h
M source/blender/blenkernel/BKE_scene.h
M source/blender/blenkernel/BKE_screen.h
M source/blender/blenkernel/BKE_shader_fx.h
M source/blender/blenkernel/BKE_shrinkwrap.h
M source/blender/blenkernel/BKE_softbody.h
M source/blender/blenkernel/BKE_spline.hh
M source/blender/blenkernel/BKE_studiolight.h
M source/blender/blenkernel/BKE_subsurf.h
M source/blender/blenkernel/BKE_text.h
M source/blender/blenkernel/BKE_texture.h
M source/blender/blenkernel/BKE_tracking.h
M source/blender/blenkernel/BKE_undo_system.h
M source/blender/blenkernel/BKE_unit.h
M source/blender/blenkernel/BKE_vfont.h
M source/blender/blenkernel/BKE_vfontdata.h
M source/blender/blenkernel/BKE_volume.h
M source/blender/blenkernel/BKE_workspace.h
M source/blender/blenkernel/BKE_writeavi.h
M source/blender/blenkernel/intern/CCGSubSurf.c
M source/blender/blenkernel/intern/CCGSubSurf.h
M source/blender/blenkernel/intern/CCGSubSurf_legacy.c
M source/blender/blenkernel/intern/DerivedMesh.cc
M source/blender/blenkernel/intern/action.c
M source/blender/blenkernel/intern/anim_data.c
M source/blender/blenkernel/intern/anim_path.c
M source/blender/blenkernel/intern/anim_sys.c
M source/blender/blenkernel/intern/anim_visualization.c
M source/blender/blenkernel/intern/appdir.c
M source/blender/blenkernel/intern/armature.c
M source/blender/blenkernel/intern/armature_deform.c
M source/blender/blenkernel/intern/asset.cc
M source/blender/blenkernel/intern/asset_catalog.cc
M source/blender/blenkernel/intern/asset_catalog_path.cc
M source/blender/blenkernel/intern/asset_library_service.cc
M source/blender/blenkernel/intern/attribute_access.cc
M source/blender/blenkernel/intern/autoexec.c
M source/blender/blenkernel/intern/blender.c
M source/blender/blenkernel/intern/blender_copybuffer.c
M source/blender/blenkernel/intern/blendfile.c
M source/blender/blenkernel/intern/blendfile_link_append.c
M source/blender/blenkernel/intern/boids.c
M source/blender/blenkernel/intern/brush.c
M source/blender/blenkernel/intern/bvhutils.cc
M source/blender/blenkernel/intern/cachefile.c
M source/blender/blenkernel/intern/callbacks.c
M source/blender/blenkernel/intern/camera.c
M source/blender/blenkernel/intern/cloth.c
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/collision.c
M source/blender/blenkernel/intern/colortools.c
M source/blender/blenkernel/intern/constraint.c
M source/blender/blenkernel/intern/context.c
M source/blender/blenkernel/intern/crazyspace.c
M source/blender/blenkernel/intern/cryptomatte.cc
M source/blender/blenkernel/intern/curve.c
M source/blender/blenkernel/intern/curve_deform.c
M source/blender/blenkernel/intern/curve_to_mesh_convert.cc
M source/blender/blenkernel/intern/curveprofile.cc
M source/blender/blenkernel/intern/customdata.c
M source/blender/blenkernel/intern/data_transfer.c
M source/blender/blenkernel/intern/data_transfer_intern.h
M source/blender/blenkernel/intern/deform.c
M source/blender/blenkernel/intern/displist.cc
M source/blender/blenkernel/intern/dynamicpaint.c
M source/blender/blenkernel/intern/editmesh.c
M source/blender/blenkernel/intern/editmesh_bvh.c
M source/blender/blenkernel/intern/editmesh_tangent.c
M source/blender/blenkernel/intern/effect.c
M source/blender/blenkernel/intern/fcurve.c
M source/blender/blenkernel/intern/fcurve_cache.c
M source/blender/blenkernel/intern/fcurve_driver.c
M source/blender/blenkernel/intern/fluid.c
M source/blender/blenkernel/intern/fmodifier.c
M source/blender/blenkernel/intern/freestyle.c
M source/blender/blenkernel/intern/geometry_component_curve.cc
M source/blender/blenkernel/intern/geometry_component_instances.cc
M source/blender/blenkernel/intern/geometry_component_mesh.cc
M source/blender/blenkernel/intern/geometry_component_pointcloud.cc
M source/blender/blenkernel/intern/geometry_component_volume.cc
M source/blender/blenkernel/intern/geometry_set.cc
M source/blender/blenkernel/intern/geometry_set_instances.cc
M source/blender/blenkernel/intern/gpencil.c
M source/blender/blenkernel/intern/gpencil_curve.c
M source/blender/blenkernel/intern/gpencil_geom.cc
M source/blender/blenkernel/intern/gpencil_modifier.c
M source/blender/blenkernel/intern/hair.c
M source/blender/blenkernel/intern/icons.cc
M source/blender/blenkernel/intern/idprop.c
M source/blender/blenkernel/intern/idtype.c
M source/blender/blenkernel/intern/image.c
M source/blender/blenkernel/intern/image_gpu.cc
M source/blender/blenkernel/intern/ipo.c
M source/blender/blenkernel/intern/key.c
M source/blender/blenkernel/intern/keyconfig.c
M source/blender/blenkernel/intern/layer.c
M source/blender/blenkernel/intern/layer_utils.c
M source/blender/blenkernel/intern/lib_id.c
M source/blender/blenkernel/intern/lib_id_delete.c
M source/blender/blenkernel/intern/lib_id_eval.c
M source/blender/blenkernel/intern/lib_override.c
M source/blender/blenkernel/intern/lib_query.c
M source/blender/blenkernel/intern/lib_remap.c
M source/blender/blenkernel/intern/linestyle.c
M source/blender/blenkernel/intern/main.c
M source/blender/blenkernel/intern/main_idmap.c
M source/blender/blenkernel/intern/mask.c
M source/blender/blenkernel/intern/mask_evaluate.c
M source/blender/blenkernel/intern/mask_rasterize.c
M source/blender/blenkernel/intern/material.c
M source/blender/blenkernel/intern/mball.c
M source/blender/blenkernel/intern/mesh.cc
M source/blender/blenkernel/intern/mesh_boolean_convert.cc
M source/blender/blenkernel/intern/mesh_convert.cc
M source/blender/blenkernel/intern/mesh_evaluate.cc
M source/blender/blenkernel/intern/mesh_iterators.c
M source/blender/blenkernel/intern/mesh_mapping.c
M source/blender/blenkernel/intern/mesh_merge.c
M source/blender/blenkernel/intern/mesh_mirror.c
M source/blender/blenkernel/intern/mesh_normals.cc
M source/blender/blenkernel/intern/mesh_remap.c
M source/blender/blenkernel/intern/mesh_runtime.c
M source/blender/blenkernel/intern/mesh_tangent.c
M source/blender/blenkernel/intern/mesh_tessellate.c
M source/blender/blenkernel/intern/mesh_validate.c
M source/blender/blenkernel/intern/mesh_validate.cc
M source/blender/blenkernel/intern/modifier.c
M source/blender/blenkernel/intern/movieclip.c
M source/blender/blenkernel/intern/multires.c
M source/blender/blenkernel/intern/multires_reshape.c
M source/blender/blenkernel/intern/multires_reshape.h
M source/blender/blenkernel/intern/multires_reshape_util.c
M source/blender/blenkernel/intern/multires_reshape_vertcos.c
M source/blender/blenkernel/intern/nla.c
M source/blender/blenkernel/intern/node.cc
M source/blender/blenkernel/intern/object.cc
M source/blender/blenkernel/intern/object_deform.c
M source/blender/blenkernel/intern/object_dupli.cc
M source/blender/blenkernel/intern/object_update.c
M source/blender/blenkernel/intern/ocean.c
M source/blender/blenkernel/intern/ocean_spectrum.c
M source/blender/blenkernel/intern/packedFile.c
M source/blender/blenkernel/intern/paint.c
M source/blender/blenkernel/intern/paint_toolslots.c
M source/blender/blenkernel/intern/particle.c
M source/blender/blenkernel/intern/particle_system.c
M source/blender/blenkernel/intern/pbvh.c
M source/blender/blenkernel/intern/pbvh_bmesh.c
M source/blender/blenkernel/intern/pbvh_intern.h
M source/blender/blenkernel/intern/pointcache.c
M source/blender/blenkernel/intern/pointcloud.cc
M source/blender/blenkernel/intern/preferences.c
M source/blender/blenkernel/intern/report.c
M source/blender/blenkernel/intern/rigidbody.c
M source/blender/blenkernel/intern/scene.c
M source/blender/blenkernel/intern/screen.c
M source/blender/blenkernel/intern/shader_fx.c
M source/blender/blenkernel/intern/shrinkwrap.c
M source/blender/blenkernel/intern/softbody.c
M source/blender/blenkernel/intern/spline_base.cc
M source/blender/blenkernel/intern/spline_bezier.cc
M source/blender/blenkernel/intern/spline_nurbs.cc
M source/blender/blenkernel/intern/spline_poly.cc
M source/blender/blenkernel/intern/studiolight.c
M source/blender/blenkernel/intern/subsurf_ccg.c
M source/blender/blenkernel/intern/text.c
M source/blender/blenkernel/intern/texture.c
M source/blender/blenkernel/intern/tracking.c
M source/blender/blenkernel/intern/tracking_auto.c
M source/blender/blenkernel/intern/tracking_detect.c
M source/blender/blenkernel/intern/tracking_plane_tracker.c
M source/blender/blenkernel/intern/tracking_region_tracker.c
M source/blender/blenkernel/intern/tracking_solver.c
M source/blender/blenkernel/intern/tracking_stabilize.c
M source/blender/blenkernel/intern/tracking_util.c
M source/blender/blenkernel/intern/undo_system.c
M source/blender/blenkernel/intern/unit.c
M source/blender/blenkernel/intern/vfont.c
M source/blender/blenkernel/intern/vfontdata_freetype.c
M source/blender/blenkernel/intern/volume.cc
M source/blender/blenkernel/intern/workspace.c
M source/blender/blenkernel/intern/writeavi.c
M source/blender/blenkernel/nla_private.h
M source/blender/blenkernel/tracking_private.h
M source/blender/nodes/composite/node_composite_tree.cc
M source/blender/nodes/shader/node_shader_tree.cc
M source/blender/python/intern/bpy_interface.c
===================================================================
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h
index c95190d2c83..22b43cd19ea 100644
--- a/source/blender/blenkernel/BKE_DerivedMesh.h
+++ b/source/blender/blenkernel/BKE_DerivedMesh.h
@@ -242,8 +242,17 @@ struct DerivedMesh {
void (*release)(DerivedMesh *dm);
};
+/**
+ * Utility function to initialize a #DerivedMesh's function pointers to
+ * the default implementation (for those functions which have a default).
+ */
void DM_init_funcs(DerivedMesh *dm);
+/**
+ * Utility function to initialize a #DerivedMesh for the desired number
+ * of vertices, edges and faces (doesn't allocate memory for them, just
+ * sets up the custom data layers)>
+ */
void DM_init(DerivedMesh *dm,
DerivedMeshType type,
int numVerts,
@@ -252,6 +261,10 @@ void DM_init(DerivedMesh *dm,
int numLoops,
int numPolys);
+/**
+ * Utility function to initialize a DerivedMesh for the desired number
+ * of vertices, edges and faces, with a layer setup copied from source
+ */
void DM_from_template_ex(DerivedMesh *dm,
DerivedMesh *source,
DerivedMeshType type,
@@ -276,43 +289,61 @@ void DM_from_template(DerivedMesh *dm,
*/
bool DM_release(DerivedMesh *dm);
+/**
+ * set the #CD_FLAG_NOCOPY flag in custom data layers where the mask is
+ * zero for the layer type, so only layer types specified by the mask
+ * will be copied
+ */
void DM_set_only_copy(DerivedMesh *dm, const struct CustomData_MeshMasks *mask);
-/* adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
+/* Adds a vertex/edge/face custom data layer to a DerivedMesh, optionally
* backed by an external data array
* alloctype defines how the layer is allocated or copied, and how it is
- * freed, see BKE_customdata.h for the different options
- */
+ * freed, see BKE_customdata.h for the different options. */
+
void DM_add_vert_layer(struct DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer);
void DM_add_edge_layer(struct DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer);
void DM_add_tessface_layer(struct DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer);
void DM_add_loop_layer(DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer);
void DM_add_poly_layer(struct DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer);
-/* custom data access functions
- * return pointer to data from first layer which matches type
- * if they return NULL for valid indices, data doesn't exist
- * note these return pointers - any change modifies the internals of the mesh
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Custom Data Access Functions
+ *
+ * \return pointer to data from first layer which matches type
+ * if they return NULL for valid indices, data doesn't exist.
+ * \note these return pointers - any change modifies the internals of the mesh.
+ * \{ */
+
void *DM_get_vert_data(struct DerivedMesh *dm, int index, int type);
void *DM_get_edge_data(struct DerivedMesh *dm, int index, int type);
void *DM_get_tessface_data(struct DerivedMesh *dm, int index, int type);
void *DM_get_poly_data(struct DerivedMesh *dm, int index, int type);
-/* custom data layer access functions
- * return pointer to first data layer which matches type (a flat array)
- * if they return NULL, data doesn't exist
- * note these return pointers - any change modifies the internals of the mesh
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Custom Data Layer Access Functions
+ *
+ * \return pointer to first data layer which matches type (a flat array)
+ * if they return NULL, data doesn't exist.
+ * \note these return pointers - any change modifies the internals of the mesh.
+ * \{ */
+
void *DM_get_vert_data_layer(struct DerivedMesh *dm, int type);
void *DM_get_edge_data_layer(struct DerivedMesh *dm, int type);
void *DM_get_tessface_data_layer(struct DerivedMesh *dm, int type);
void *DM_get_poly_data_layer(struct DerivedMesh *dm, int type);
void *DM_get_loop_data_layer(struct DerivedMesh *dm, int type);
-/* custom data copy functions
+/** \} */
+
+/**
+ * Custom data copy functions
* copy count elements from source_index in source to dest_index in dest
- * these copy all layers for which the CD_FLAG_NOCOPY flag is not set
+ * these copy all layers for which the CD_FLAG_NOCOPY flag is not set.
*/
void DM_copy_vert_data(struct DerivedMesh *source,
struct DerivedMesh *dest,
@@ -320,13 +351,26 @@ void DM_copy_vert_data(struct DerivedMesh *source,
int dest_index,
int count);
-/* Sets up mpolys for a DM based on face iterators in source. */
+/**
+ * Sets up mpolys for a DM based on face iterators in source.
+ */
void DM_DupPolys(DerivedMesh *source, DerivedMesh *target);
void DM_ensure_normals(DerivedMesh *dm);
+/**
+ * Ensure the array is large enough.
+ *
+ * \note This function must always be thread-protected by caller.
+ * It should only be used by internal code.
+ */
void DM_ensure_looptri_data(DerivedMesh *dm);
+/**
+ * Interpolates vertex data from the vertices indexed by `src_indices` in the
+ * source mesh using the given weights and stores the result in the vertex
+ * indexed by `dest_index` in the `dest` mesh.
+ */
void DM_interp_vert_data(struct DerivedMesh *source,
struct DerivedMesh *dest,
int *src_indices,
@@ -336,7 +380,9 @@ void DM_interp_vert_data(struct DerivedMesh *source,
void mesh_get_mapped_verts_coords(struct Mesh *me_eval, float (*r_cos)[3], const int totcos);
-/* same as above but won't use render settings */
+/**
+ * Same as above but won't use render settings.
+ */
struct Mesh *editbmesh_get_eval_cage(struct Depsgraph *depsgraph,
struct Scene *scene,
struct Object *,
diff --git a/source/blender/blenkernel/BKE_action.h b/source/blender/blenkernel/BKE_action.h
index b5e94793658..ea8ee3f93b1 100644
--- a/source/blender/blenkernel/BKE_action.h
+++ b/source/blender/blenkernel/BKE_action.h
@@ -79,57 +79,86 @@ typedef enum eAction_TransformFlags {
ACT_TRANS_ALL = (ACT_TRANS_ONLY | ACT_TRANS_PROP),
} eAction_TransformFlags;
-/* Return flags indicating which transforms the given object/posechannel has
+/**
+ * Return flags indicating which transforms the given object/posechannel has
* - if 'curves' is provided, a list of links to these curves are also returned
- * whose nodes WILL NEED FREEING
+ * whose nodes WILL NEED FREEING.
*/
short action_get_item_transforms(struct bAction *act,
struct Object *ob,
struct bPoseChannel *pchan,
ListBase *curves);
-/* Some kind of bounding box operation on the action */
+/**
+ * Calculate the extents of given action.
+ */
void calc_action_range(const struct bAction *act, float *start, float *end, short incl_modifiers);
/* Retrieve the intended playback frame range, using the manually set range if available,
* or falling back to scanning F-Curves for their first & last frames otherwise. */
void BKE_action_get_frame_range(const struct bAction *act, float *r_start, float *r_end);
-/* Does action have any motion data at all? */
+/**
+ * Check if the given action has any keyframes.
+ */
bool action_has_motion(const struct bAction *act);
-/* Is the action configured as cyclic. */
+/**
+ * Is the action configured as cyclic.
+ */
bool BKE_action_is_cyclic(const struct bAction *act);
/* Action Groups API ----------------- */
-/* Get the active action-group for an Action */
+/**
+ * Get the active action-group for an Action.
+ */
struct bActionGroup *get_active_actiongroup(struct bAction *act);
-/* Make the given Action Group the active one */
+/**
+ * Make the given Action-Group the active one.
+ */
void set_active_action_group(struct bAction *act, struct bActionGroup *agrp, short select);
-/* Sync colors used for action/bone group with theme settings */
+/**
+ * Sync colors used for action/bone group with theme settings.
+ */
void action_group_colors_sync(struct bActionGroup *grp, const struct bActionGroup *ref_grp);
-/* Add a new action group with the given name to the action */
+/**
+ * Add a new action group with the given name to the action>
+ */
struct bActionGroup *action_groups_add_new(struct bAction *act, const char name[]);
-/* Add given channel into (active) group */
+/**
+ * Add given channel into (active) group
+ * - assumes that channel is not linked to anything anymore
+ * - always adds at the end of the group
+ */
void action_groups_add_channel(struct bAction *act,
struct bActionGroup *agrp,
struct FCurve *fcurve);
-/* Remove the given channel from all groups */
+/**
+ * Remove the given channel from all groups.
+ */
void action_groups_remove_channel(struct bAction *act, struct FCurve *fcu);
-/* Reconstruct group channel pointers. */
+/**
+ * Reconstruct group channel pointers.
+ * Assumes that the groups referred to by the FCurves are already in act->groups.
+ * Reorders the main channel list to match group order.
+ */
void BKE_action_groups_reconstruct(struct bAction *act);
-/* Find a group with the given name */
+/**
+ * Find a group with the given name.
+ */
struct bActionGroup *BKE_action_group_find_name(struct bAction *act, const char name[]);
-/* Clear all 'temp' flags on all groups */
+/**
+ * Clear all 'temp' flags on all groups.
+ */
void action_groups_clear_tempflags(struct bAction *act);
/**
@@ -146,21 +175,47 @@ bool BKE_action_has_single_frame(const struct bAction *act);
/* Pose API ----------------- */
void BKE_pose_channel_free(struct bPoseChannel *pchan);
+/**
+ * Deallocates a pose channel.
+ * Does not free the pose channel itself.
+ */
void BKE_pose_channel_free_ex(struct bPoseChannel *pchan, bool do_id_user);
+/**
+ * Clears the runtime cache of a pose chan
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list