diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:19:15 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:38:48 +0300 |
commit | ffc4c126f5416b04a01653e7a03451797b98aba4 (patch) | |
tree | ac63d70d33aae5ab1666c9c2f62058c9c1eebd5c /source/blender/blenkernel/BKE_gpencil_curve.h | |
parent | f159d49f56cedccd509ee93f5a5fb51f4f39eeb8 (diff) |
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
Diffstat (limited to 'source/blender/blenkernel/BKE_gpencil_curve.h')
-rw-r--r-- | source/blender/blenkernel/BKE_gpencil_curve.h | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_gpencil_curve.h b/source/blender/blenkernel/BKE_gpencil_curve.h index 9cbe67af9c1..044e2ff2336 100644 --- a/source/blender/blenkernel/BKE_gpencil_curve.h +++ b/source/blender/blenkernel/BKE_gpencil_curve.h @@ -35,6 +35,17 @@ struct bGPDlayer; struct bGPDstroke; struct bGPdata; +/** + * Convert a curve object to grease pencil stroke. + * + * \param bmain: Main thread pointer + * \param scene: Original scene. + * \param ob_gp: Grease pencil object to add strokes. + * \param ob_cu: Curve to convert. + * \param use_collections: Create layers using collection names. + * \param scale_thickness: Scale thickness factor. + * \param sample: Sample distance, zero to disable. + */ void BKE_gpencil_convert_curve(struct Main *bmain, struct Scene *scene, struct Object *ob_gp, @@ -43,24 +54,42 @@ void BKE_gpencil_convert_curve(struct Main *bmain, const float scale_thickness, const float sample); +/** + * Creates a bGPDcurve by doing a cubic curve fitting on the grease pencil stroke points. + */ struct bGPDcurve *BKE_gpencil_stroke_editcurve_generate(struct bGPDstroke *gps, const float error_threshold, const float corner_angle, const float stroke_radius); +/** + * Updates the edit-curve for a stroke. Frees the old curve if one exists and generates a new one. + */ void BKE_gpencil_stroke_editcurve_update(struct bGPdata *gpd, struct bGPDlayer *gpl, struct bGPDstroke *gps); +/** + * Sync the selection from stroke to edit-curve. + */ void BKE_gpencil_editcurve_stroke_sync_selection(struct bGPdata *gpd, struct bGPDstroke *gps, struct bGPDcurve *gpc); +/** + * Sync the selection from edit-curve to stroke. + */ void BKE_gpencil_stroke_editcurve_sync_selection(struct bGPdata *gpd, struct bGPDstroke *gps, struct bGPDcurve *gpc); void BKE_gpencil_strokes_selected_update_editcurve(struct bGPdata *gpd); void BKE_gpencil_strokes_selected_sync_selection_editcurve(struct bGPdata *gpd); +/** + * Recalculate stroke points with the edit-curve of the stroke. + */ void BKE_gpencil_stroke_update_geometry_from_editcurve(struct bGPDstroke *gps, const uint resolution, const bool is_adaptive); +/** + * Recalculate the handles of the edit curve of a grease pencil stroke. + */ void BKE_gpencil_editcurve_recalculate_handles(struct bGPDstroke *gps); void BKE_gpencil_editcurve_subdivide(struct bGPDstroke *gps, const int cuts); |