Skip to content

Commit 58ef3c7

Browse files
committed
Add missing doc
1 parent af09478 commit 58ef3c7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/core/pal/feature.h

+9
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,15 @@ namespace pal
177177
*/
178178
int createCandidatesAlongLineNearMidpoint( QList<LabelPosition *> &lPos, PointSet *mapShape, double initialCost = 0.0 );
179179

180+
/** Returns the label position for a curved label at a specific offset along a path.
181+
* @param path_positions line path to place label on
182+
* @param path_distances array of distances to each segment on path
183+
* @param orientation can be 0 for automatic calculation of orientation, or -1/+1 for a specific label orientation
184+
* @param index
185+
* @param distance distance to offset label along curve by
186+
* @param flip
187+
* @returns calculated label position
188+
*/
180189
LabelPosition* curvedPlacementAtOffset( PointSet* path_positions, double* path_distances,
181190
int& orientation, int index, double distance, bool& flip );
182191

0 commit comments

Comments
 (0)