From 151b4d50cefc10f1ef9ecff66bd439c332d3e792 Mon Sep 17 00:00:00 2001
From: alemuntoni
Date: Mon, 25 Oct 2021 15:01:53 +0200
Subject: [PATCH] documentation for ply in FunctionSet
---
src/common/python/function_set.cpp | 26 ++++++++++++++------------
1 file changed, 14 insertions(+), 12 deletions(-)
diff --git a/src/common/python/function_set.cpp b/src/common/python/function_set.cpp
index 66e3cf9d9..9124bd60c 100644
--- a/src/common/python/function_set.cpp
+++ b/src/common/python/function_set.cpp
@@ -97,21 +97,23 @@ void pymeshlab::FunctionSet::loadIOPlugin(IOPlugin* iop)
RichParameterList rps = iop->initSaveParameter(outputFormat, *dummyMeshDocument.mm());
if (outputFormat.toUpper() == "PLY"){
f.setDescription(
- "Ply files also support saving custom attributes. You'll need to add an "
+ "Save PLY format.
Ply exporter also support saving custom attributes. "
+ "You'll need to add an "
"additional boolean parameter for each one of that you want to save, and use "
"only non-capital letters for parameter names. These parameters have a prefix "
"for each type of custom attribute:"
- "- ``__ca_vs__``: Custom Attribute Vertex Scalar;"
- "- ``__ca_vp__``: Custom Attribute Vertex Point;"
- "- ``__ca_fs__``: Custom Attribute Face Scalar;"
- "- ``__ca_fp__``: Custom Attribute Face Point;"
- "For example, if your mesh has a custom per vertex scalar attribute called "
- "'MyAttribute', you can save it in a ply file by calling:"
- "``ms.save_current_mesh(file_name='myfile.ply', __ca_vs__myattribute=True)`` "
- ""
- "You can check the parameters available on a mesh by calling the MeshSet "
- "method :py:meth:`pmeshlab.MeshSet.filter_parameter_values`, with first "
- "parameter ``ply``.");
+ ""
+ " __ca_vs__: Custom Attribute Vertex Scalar; "
+ " __ca_vp__: Custom Attribute Vertex Point; "
+ " __ca_fs__: Custom Attribute Face Scalar; "
+ " __ca_fp__: Custom Attribute Face Point; "
+ "
For example, if your mesh has a custom per vertex scalar attribute "
+ "called MyAttribute, you can save it in a ply file by "
+ "calling:"
+ "ms.save_current_mesh(file_name='myfile.ply', __ca_vs__myattribute=True)"
+ " You can check the parameters available on a mesh by calling the "
+ "MeshSet method MeshSet.filter_parameter_values, with first "
+ "parameter 'ply'.");
}
//filename parameter
QString sv = "file_name." + outputFormat;