Pixyco-XYZ/openmesh
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- added some documentation to the BaseWriter

Browse Source 
git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@747 fdac6126-5c0c-442c-9429-916003d36597
This commit is contained in:
Isaak Lim
2012-10-15 10:42:13 +00:00
parent fc7acde663
commit d370b6e06c
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/OpenMesh/Core/IO/writer/BaseWriter.hh
View File

@@ -96,13 +96,23 @@ public:
/// Returns true if writer can parse _filename (checks extension) /// Returns true if writer can parse _filename (checks extension)
virtual bool can_u_write(const std::string& _filename) const; virtual bool can_u_write(const std::string& _filename) const;
/// Write to file _filename. Data source specified by BaseExporter _be. /** Write to a file
* @param _filename write to file with the given filename
* @param _be BaseExporter, which specifies the data source
* @param _opt writing options
* @param _precision can be used to specify the precision of the floating point notation.
*/
virtual bool write(const std::string& _filename, virtual bool write(const std::string& _filename,
BaseExporter& _be, BaseExporter& _be,
Options _opt, Options _opt,
std::streamsize _precision = 6) const = 0; std::streamsize _precision = 6) const = 0;
/// Write to std::ostream _os. Data source specified by BaseExporter _be. /** Write to a std::ostream
* @param _os write to std::ostream
* @param _be BaseExporter, which specifies the data source
* @param _opt writing options
* @param _precision can be used to specify the precision of the floating point notation.
*/
virtual bool write(std::ostream& _os, virtual bool write(std::ostream& _os,
BaseExporter& _be, BaseExporter& _be,
Options _opt, Options _opt,