PointCloudLibrary/pcl

Replace pcl::visualization::createPlane and pcl::visualization::PCLVisualizer::addPlane overloads by default arguments

Open

#1,653 opened on Jul 18, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (9,023 stars) (4,506 forks)batch import
good first issuekind: todomodule: visualization

Description

The code is pretty similar and can be probably reduced by simply making a change to its signature with default initializers.

bool addPlane (const pcl::ModelCoefficients &coefficients, 
               double x = 0,
               double y = 0,
               double z = 0,
               const std::string &id = "plane",
               int viewport = 0);

and

PCL_EXPORTS vtkSmartPointer<vtkDataSet> 
createPlane (const pcl::ModelCoefficients &coefficients, double x = 0, double y = 0, double z = 0);

pcl::visualization::PCLVisualizer::addPlane method:

pcl::visualization::createPlane method:

Contributor guide

Tech stack
cpp
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ knowledgedefault argumentsfunction overloading
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue identifies two sets of overloaded functions: addPlane in pcl visualizer.cpp and createPlane in shapes.cpp. The goal is to replace the separate overloads with single functions that use default arguments for the optional parameters. Examine the current implementations linked in the issue, particularly lines 2460-2488 and 2490-2518 for addPlane, and lines 170-183 and 186-212 for createPlane. Then modify the function signatures in the header files to have default arguments and remove the duplicated definitions in the source files. Ensure that the changes compile and the behavior remains unchanged. No comments or PRs are linked, so the approach is straightforward.