diff options
author | Antonio Vazquez <blendergit@gmail.com> | 2020-07-03 13:55:20 +0300 |
---|---|---|
committer | Antonio Vazquez <blendergit@gmail.com> | 2020-07-03 13:55:47 +0300 |
commit | a06d95987e3e2bff131633636f7c7e25e0528a3b (patch) | |
tree | 596812b7fbf753ae2eb6e18d393a510c557b3757 /source/blender | |
parent | 972d1700cdd8ed4e47156e69b524e9986da35ae3 (diff) |
GPencil: Cleanup more comments (cont)
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/blenkernel/intern/gpencil.c | 109 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/gpencil_geom.c | 82 |
2 files changed, 135 insertions, 56 deletions
diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c index dece833c00f..3a0449dd4be 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -282,6 +282,10 @@ void BKE_gpencil_free(bGPdata *gpd, bool free_all) } } +/** + * Delete grease pencil evaluated data + * \param gpd_eval: Grease pencil data-block + */ void BKE_gpencil_eval_delete(bGPdata *gpd_eval) { BKE_gpencil_free(gpd_eval, true); @@ -302,7 +306,12 @@ void BKE_gpencil_tag(bGPdata *gpd) /* ************************************************** */ /* Container Creation */ -/* add a new gp-frame to the given layer */ +/** + * Add a new gp-frame to the given layer. + * \param gpl: Grease pencil layer + * \param cframe: Frame number + * \return Pointer to new frame + */ bGPDframe *BKE_gpencil_frame_addnew(bGPDlayer *gpl, int cframe) { bGPDframe *gpf = NULL, *gf = NULL; @@ -356,7 +365,12 @@ bGPDframe *BKE_gpencil_frame_addnew(bGPDlayer *gpl, int cframe) return gpf; } -/* add a copy of the active gp-frame to the given layer */ +/** + * Add a copy of the active gp-frame to the given layer. + * \param gpl: Grease pencil layer + * \param cframe: Frame number + * \return Pointer to new frame + */ bGPDframe *BKE_gpencil_frame_addcopy(bGPDlayer *gpl, int cframe) { bGPDframe *new_frame; @@ -411,7 +425,13 @@ bGPDframe *BKE_gpencil_frame_addcopy(bGPDlayer *gpl, int cframe) return new_frame; } -/* add a new gp-layer and make it the active layer */ +/** + * Add a new gp-layer and make it the active layer. + * \param gpd: Grease pencil data-block + * \param name: Name of the layer + * \param setactive: Set as active + * \return Pointer to new layer + */ bGPDlayer *BKE_gpencil_layer_addnew(bGPdata *gpd, const char *name, bool setactive) { bGPDlayer *gpl = NULL; @@ -481,6 +501,9 @@ bGPDlayer *BKE_gpencil_layer_addnew(bGPdata *gpd, const char *name, bool setacti /** * Add a new grease pencil data-block. + * \param bmain: Main pointer + * \param name: Name of the datablock + * \return Pointer to new data-block */ bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[]) { @@ -526,9 +549,10 @@ bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[]) /* Utilities for easier bulk-creation of geometry */ /** - * Populate stroke with point data from data buffers - * + * Populate stroke with point data from data buffers. + * \param gps: Grease pencil stroke * \param array: Flat array of point data values. Each entry has #GP_PRIM_DATABUF_SIZE values. + * \param totpoints: Total of points * \param mat: 4x4 transform matrix to transform points into the right coordinate space. */ void BKE_gpencil_stroke_add_points(bGPDstroke *gps, @@ -550,7 +574,13 @@ void BKE_gpencil_stroke_add_points(bGPDstroke *gps, } } -/* Create a new stroke, with pre-allocated data buffers. */ +/** + * Create a new stroke, with pre-allocated data buffers. + * \param mat_idx: Index of the material + * \param totpoints: Total points + * \param thickness: Stroke thickness + * \return Pointer to new stroke + */ bGPDstroke *BKE_gpencil_stroke_new(int mat_idx, int totpoints, short thickness) { /* allocate memory for a new stroke */ @@ -584,7 +614,15 @@ bGPDstroke *BKE_gpencil_stroke_new(int mat_idx, int totpoints, short thickness) return gps; } -/* Create a new stroke and add to frame. */ +/** + * Create a new stroke and add to frame. + * \param gpf: Grease pencil frame + * \param mat_idx: Material index + * \param totpoints: Total points + * \param thickness: Stroke thickness + * \param insert_at_head: Add to the head of the strokes list + * \return Pointer to new stroke + */ bGPDstroke *BKE_gpencil_stroke_add( bGPDframe *gpf, int mat_idx, int totpoints, short thickness, const bool insert_at_head) { @@ -603,7 +641,16 @@ bGPDstroke *BKE_gpencil_stroke_add( return gps; } -/* Add a stroke and copy the temporary drawing color value from one of the existing stroke */ +/** + * Add a stroke and copy the temporary drawing color value + * from one of the existing stroke. + * \param gpf: Grease pencil frame + * \param existing: Stroke with the style to copy + * \param mat_idx: Material index + * \param totpoints: Total points + * \param thickness: Stroke thickness + * \return Pointer to new stroke + */ bGPDstroke *BKE_gpencil_stroke_add_existing_style( bGPDframe *gpf, bGPDstroke *existing, int mat_idx, int totpoints, short thickness) { @@ -618,7 +665,11 @@ bGPDstroke *BKE_gpencil_stroke_add_existing_style( /* ************************************************** */ /* Data Duplication */ -/* make a copy of a given gpencil weights */ +/** + * Make a copy of a given gpencil weights. + * \param gps_src: Source grease pencil stroke + * \param gps_dst: Destination grease pencil stroke + */ void BKE_gpencil_stroke_weights_duplicate(bGPDstroke *gps_src, bGPDstroke *gps_dst) { if (gps_src == NULL) { @@ -629,7 +680,12 @@ void BKE_gpencil_stroke_weights_duplicate(bGPDstroke *gps_src, bGPDstroke *gps_d BKE_defvert_array_copy(gps_dst->dvert, gps_src->dvert, gps_src->totpoints); } -/* make a copy of a given gpencil stroke */ +/** + * Make a copy of a given gpencil stroke. + * \param gps_src: Source grease pencil strokeyes + * \param dup_points: Duplicate points data + * \return Pointer to new stroke + */ bGPDstroke *BKE_gpencil_stroke_duplicate(bGPDstroke *gps_src, const bool dup_points) { bGPDstroke *gps_dst = NULL; @@ -654,7 +710,11 @@ bGPDstroke *BKE_gpencil_stroke_duplicate(bGPDstroke *gps_src, const bool dup_poi return gps_dst; } -/* make a copy of a given gpencil frame */ +/** + * Make a copy of a given gpencil frame. + * \param gpf_src: Source grease pencil frame + * \return Pointer to new frame + */ bGPDframe *BKE_gpencil_frame_duplicate(const bGPDframe *gpf_src) { bGPDstroke *gps_dst = NULL; @@ -681,7 +741,11 @@ bGPDframe *BKE_gpencil_frame_duplicate(const bGPDframe *gpf_src) return gpf_dst; } -/* make a copy of strokes between gpencil frames */ +/** + * Make a copy of strokes between gpencil frames. + * \param gpf_src: Source grease pencil frame + * \param gpf_dst: Destination grease pencil frame + */ void BKE_gpencil_frame_copy_strokes(bGPDframe *gpf_src, struct bGPDframe *gpf_dst) { bGPDstroke *gps_dst = NULL; @@ -699,7 +763,11 @@ void BKE_gpencil_frame_copy_strokes(bGPDframe *gpf_src, struct bGPDframe *gpf_ds } } -/* make a copy of a given gpencil layer */ +/** + * Make a copy of a given gpencil layer. + * \param gpl_src: Source grease pencil layer + * \return Pointer to new layer + */ bGPDlayer *BKE_gpencil_layer_duplicate(const bGPDlayer *gpl_src) { const bGPDframe *gpf_src; @@ -742,6 +810,10 @@ bGPDlayer *BKE_gpencil_layer_duplicate(const bGPDlayer *gpl_src) /** * Standard API to make a copy of GP data-block, separate from copying its data. + * + * \param bmain: Main pointer + * \param gpd: Grease pencil data-block + * \return Pointer to new data-block */ bGPdata *BKE_gpencil_copy(Main *bmain, const bGPdata *gpd) { @@ -787,7 +859,10 @@ bGPdata *BKE_gpencil_data_duplicate(Main *bmain, const bGPdata *gpd_src, bool in /* ************************************************** */ /* GP Stroke API */ -/* ensure selection status of stroke is in sync with its points */ +/** + * Ensure selection status of stroke is in sync with its points. + * \param gps: Grease pencil stroke + */ void BKE_gpencil_stroke_sync_selection(bGPDstroke *gps) { bGPDspoint *pt; @@ -814,7 +889,11 @@ void BKE_gpencil_stroke_sync_selection(bGPDstroke *gps) /* ************************************************** */ /* GP Frame API */ -/* delete the last stroke of the given frame */ +/** + * Delete the last stroke of the given frame. + * \param gpl: Grease pencil layer + * \param gpf: Grease pencil frame + */ void BKE_gpencil_frame_delete_laststroke(bGPDlayer *gpl, bGPDframe *gpf) { bGPDstroke *gps = (gpf) ? gpf->strokes.last : NULL; diff --git a/source/blender/blenkernel/intern/gpencil_geom.c b/source/blender/blenkernel/intern/gpencil_geom.c index 0da7891c7bd..49940c2d466 100644 --- a/source/blender/blenkernel/intern/gpencil_geom.c +++ b/source/blender/blenkernel/intern/gpencil_geom.c @@ -56,10 +56,10 @@ /* GP Object - Boundbox Support */ /** *Get min/max coordinate bounds for single stroke. - * \param gps Grease pencil stroke - * \param use_select Include only selected points - * \param r_min Result minimum coordinates - * \param r_max Result maximum coordinates + * \param gps: Grease pencil stroke + * \param use_select: Include only selected points + * \param r_min: Result minimum coordinates + * \param r_max: Result maximum coordinates * \return True if it was possible to calculate */ bool BKE_gpencil_stroke_minmax(const bGPDstroke *gps, @@ -86,9 +86,9 @@ bool BKE_gpencil_stroke_minmax(const bGPDstroke *gps, /** * Get min/max bounds of all strokes in grease pencil data-block. - * \param gpd Grease pencil datablock - * \param r_min Result minimum coordinates - * \param r_max Result maximum coordinates + * \param gpd: Grease pencil datablock + * \param r_min: Result minimum coordinates + * \param r_max: Result maximum coordinates * \return True if it was possible to calculate */ bool BKE_gpencil_data_minmax(const bGPdata *gpd, float r_min[3], float r_max[3]) @@ -116,8 +116,8 @@ bool BKE_gpencil_data_minmax(const bGPdata *gpd, float r_min[3], float r_max[3]) /** * Compute center of bounding box. - * \param gpd Grease pencil data-block - * \param r_centroid Location of the center + * \param gpd: Grease pencil data-block + * \param r_centroid: Location of the center */ void BKE_gpencil_centroid_3d(bGPdata *gpd, float r_centroid[3]) { @@ -131,7 +131,7 @@ void BKE_gpencil_centroid_3d(bGPdata *gpd, float r_centroid[3]) /** * Compute stroke bounding box. - * \param gps Grease pencil Stroke + * \param gps: Grease pencil Stroke */ void BKE_gpencil_stroke_boundingbox_calc(bGPDstroke *gps) { @@ -141,7 +141,7 @@ void BKE_gpencil_stroke_boundingbox_calc(bGPDstroke *gps) /** * Create bounding box values. - * \param ob Grease pencil object + * \param ob: Grease pencil object */ static void boundbox_gpencil(Object *ob) { @@ -168,7 +168,7 @@ static void boundbox_gpencil(Object *ob) /** * Get grease pencil object bounding box. - * \param ob Grease pencil object + * \param ob: Grease pencil object * \return Bounding box */ BoundBox *BKE_gpencil_boundbox_get(Object *ob) @@ -619,10 +619,10 @@ bool BKE_gpencil_stroke_trim_points(bGPDstroke *gps, const int index_from, const /** * Split stroke. - * \param gpf Grease pencil frame - * \param gps Grease pencil original stroke - * \param before_index Position of the point to split - * \param remaining_gps Secondary stroke after split. + * \param gpf: Grease pencil frame + * \param gps: Grease pencil original stroke + * \param before_index: Position of the point to split + * \param remaining_gps: Secondary stroke after split. * \return True if the split was done */ bool BKE_gpencil_stroke_split(bGPDframe *gpf, @@ -986,10 +986,10 @@ bool BKE_gpencil_stroke_smooth_uv(bGPDstroke *gps, int point_index, float influe /** * Get points of stroke always flat to view not affected * by camera view or view position. - * \param points Array of grease pencil points (3D) - * \param totpoints Total of points - * \param points2d Result array of 2D points - * \param r_direction Concave (-1), Convex (1), or Autodetect (0) + * \param points: Array of grease pencil points (3D) + * \param totpoints: Total of points + * \param points2d: Result array of 2D points + * \param r_direction: Return Concave (-1), Convex (1), or Autodetect (0) */ void BKE_gpencil_stroke_2d_flat(const bGPDspoint *points, int totpoints, @@ -1050,13 +1050,13 @@ void BKE_gpencil_stroke_2d_flat(const bGPDspoint *points, /** * Get points of stroke always flat to view not affected by camera view or view position * using another stroke as reference. - * \param ref_points Array of reference points (3D) - * \param ref_totpoints Total reference points - * \param points Array of points to flat (3D) - * \param totpoints Total points - * \param points2d Result array of 2D points - * \param scale Scale factor - * \param r_direction Concave (-1), Convex (1), or Autodetect (0) + * \param ref_points: Array of reference points (3D) + * \param ref_totpoints: Total reference points + * \param points: Array of points to flat (3D) + * \param totpoints: Total points + * \param points2d: Result array of 2D points + * \param scale: Scale factor + * \param r_direction: Return Concave (-1), Convex (1), or Autodetect (0) */ void BKE_gpencil_stroke_2d_flat_ref(const bGPDspoint *ref_points, int ref_totpoints, @@ -1183,7 +1183,7 @@ static void gpencil_calc_stroke_fill_uv(const float (*points2d)[2], /** * Triangulate stroke to generate data for filling areas. - * \param gps Grease pencil stroke + * \param gps: Grease pencil stroke */ void BKE_gpencil_stroke_fill_triangulate(bGPDstroke *gps) { @@ -1245,7 +1245,7 @@ void BKE_gpencil_stroke_fill_triangulate(bGPDstroke *gps) /** * Update Stroke UV data. - * \param gps Grease pencil stroke + * \param gps: Grease pencil stroke */ void BKE_gpencil_stroke_uv_update(bGPDstroke *gps) { @@ -1264,7 +1264,7 @@ void BKE_gpencil_stroke_uv_update(bGPDstroke *gps) /** * Recalc all internal geometry data for the stroke - * \param gps Grease pencil stroke + * \param gps: Grease pencil stroke */ void BKE_gpencil_stroke_geometry_update(bGPDstroke *gps) { @@ -1503,9 +1503,9 @@ bool BKE_gpencil_stroke_close(bGPDstroke *gps) /** * Dissolve points in stroke. - * \param gpf Grease pencil frame - * \param gps Grease pencil stroke - * \param tag Type of tag for point + * \param gpf: Grease pencil frame + * \param gps: Grease pencil stroke + * \param tag: Type of tag for point */ void BKE_gpencil_dissolve_points(bGPDframe *gpf, bGPDstroke *gps, const short tag) { @@ -1589,8 +1589,8 @@ void BKE_gpencil_dissolve_points(bGPDframe *gpf, bGPDstroke *gps, const short ta /** * Calculate stroke normals. - * \param gps Grease pencil stroke - * \param r_normal Normal vector normalized + * \param gps: Grease pencil stroke + * \param r_normal: Return Normal vector normalized */ void BKE_gpencil_stroke_normal(const bGPDstroke *gps, float r_normal[3]) { @@ -1629,8 +1629,8 @@ void BKE_gpencil_stroke_normal(const bGPDstroke *gps, float r_normal[3]) * * Ramer - Douglas - Peucker algorithm * by http ://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm - * \param gps Grease pencil stroke - * \param epsilon Epsilon value to define precision of the algorithm + * \param gps: Grease pencil stroke + * \param epsilon: Epsilon value to define precision of the algorithm */ void BKE_gpencil_stroke_simplify_adaptive(bGPDstroke *gps, float epsilon) { @@ -1738,7 +1738,7 @@ void BKE_gpencil_stroke_simplify_adaptive(bGPDstroke *gps, float epsilon) /** * Simplify alternate vertex of stroke except extremes. - * \param gps Grease pencil stroke + * \param gps: Grease pencil stroke */ void BKE_gpencil_stroke_simplify_fixed(bGPDstroke *gps) { @@ -1802,9 +1802,9 @@ void BKE_gpencil_stroke_simplify_fixed(bGPDstroke *gps) /** * Subdivide grease pencil stroke. - * \param gps Grease pencil stroke - * \param level Level of subdivision - * \param type Type of subdivision + * \param gps: Grease pencil stroke + * \param level: Level of subdivision + * \param type: Type of subdivision */ void BKE_gpencil_stroke_subdivide(bGPDstroke *gps, int level, int type) { |