cgal/Stream_support/include/CGAL/IO/STL.h

419 lines
15 KiB
C++

// Copyright (c) 2018-2020 GeometryFactory Sarl (France).
// All rights reserved.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is part of CGAL (www.cgal.org)
//
// $URL$
// $Id$
// SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-Commercial
//
// Author(s) : Maxime Gimeno
#ifndef CGAL_IO_STL_H
#define CGAL_IO_STL_H
#include <CGAL/IO/STL/STL_reader.h>
#include <CGAL/boost/graph/Named_function_parameters.h>
#include <CGAL/boost/graph/named_params_helper.h>
#include <CGAL/Kernel/global_functions_3.h>
#include <boost/range/value_type.hpp>
#include <iostream>
#include <fstream>
#include <string>
#ifdef DOXYGEN_RUNNING
#define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters
#define CGAL_BGL_NP_CLASS NamedParameters
#endif
namespace CGAL {
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////
// Read
/*!
* \ingroup PkgStreamSupportIoFuncsSTL
*
* \brief reads the content of `is` into `points` and `facets`, using the \ref IOStreamSTL.
*
* \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
* \tparam TriangleRange a model of the concept `SequenceContainer`
* whose value_type is itself a model of the concept `SequenceContainer`
* whose value_type is an integer type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param is the input stream
* \param points points of the soup of triangles
* \param facets a `TriangleRange`. Each element in it describes a triangle
* using the indices of the points in `points`.
* \param np optional \ref bgl_namedparameters "Named Parameters" described below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{verbose}
* \cgalParamDescription{indicates whether output warnings and error messages should be printed or not.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`true`}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \returns `true` if the reading was successful, `false` otherwise.
*/
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool read_STL(std::istream& is,
PointRange& points,
TriangleRange& facets,
const CGAL_BGL_NP_CLASS& np
#ifndef DOXYGEN_RUNNING
, typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr
#endif
)
{
const bool verbose = parameters::choose_parameter(parameters::get_parameter(np, internal_np::verbose), true);
if(!is.good())
{
if(verbose)
std::cerr<<"File doesn't exist."<<std::endl;
return false;
}
int pos = 0;
// Ignore all initial whitespace
unsigned char c;
while(is.read(reinterpret_cast<char*>(&c), sizeof(c)))
{
if(!isspace(c))
{
is.unget(); // move back to the first interesting char
break;
}
++pos;
}
if(!is.good()) // reached the end
return true;
// If we have gone beyond 80 characters and have not read anything yet,
// then this must be an ASCII file.
if(pos > 80)
return IO::internal::parse_ASCII_STL(is, points, facets, verbose);
// We are within the first 80 characters, both ASCII and binary are possible
// Read the 5 first characters to check if the first word is "solid"
std::string s;
char word[6];
if(is.read(reinterpret_cast<char*>(&word[0]), sizeof(c)) &&
is.read(reinterpret_cast<char*>(&word[1]), sizeof(c)) &&
is.read(reinterpret_cast<char*>(&word[2]), sizeof(c)) &&
is.read(reinterpret_cast<char*>(&word[3]), sizeof(c)) &&
is.read(reinterpret_cast<char*>(&word[4]), sizeof(c)) &&
is.read(reinterpret_cast<char*>(&word[5]), sizeof(c)))
{
s = std::string(word, 5);
pos += 5;
}
else
{
return true; // empty file
}
// If the first word is not 'solid', the file must be binary
if(s != "solid" || (word[5] !='\n' && word[5] != ' '))
{
if(IO::internal::parse_binary_STL(is, points, facets, verbose))
{
return true;
}
else
{
// If we failed to read it as a binary, try as ASCII just in case...
// The file does not start with 'solid' anyway, so it's fine to reset it.
is.clear();
is.seekg(0, std::ios::beg);
return IO::internal::parse_ASCII_STL(is, points, facets, verbose);
}
}
// Now, we have found the keyword "solid" which is supposed to indicate that the file is ASCII
is.clear();
is.seekg(0, std::ios::beg); // the parser needs to read all "solid" to work correctly.
if(IO::internal::parse_ASCII_STL(is, points, facets, verbose))
{
// correctly read the input as an ASCII file
return true;
}
else // Failed to read the ASCII file
{
// It might have actually have been a binary file... ?
return IO::internal::parse_binary_STL(is, points, facets, verbose);
}
}
/// \cond SKIP_IN_MANUAL
template <typename PointRange, typename TriangleRange>
bool read_STL(std::istream& is, PointRange& points, TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return read_STL(is, points, facets, parameters::all_default());
}
/// \endcond
/*!
* \ingroup PkgStreamSupportIoFuncsSTL
*
* \brief reads the content of a file named `fname` into `points` and `facets`, using the \ref IOStreamSTL.
*
* \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
* \tparam TriangleRange a model of the concept `SequenceContainer`
* whose value_type is itself a model of the concept `SequenceContainer`
* whose value_type is an integer type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param fname the path to the input file
* \param points points of the soup of triangles
* \param facets a `TriangleRange`. Each element in it describes a triangle
* using the indices of the points in `points`.
* \param np optional \ref bgl_namedparameters "Named Parameters" described below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{verbose}
* \cgalParamDescription{indicates whether output warnings and error messages should be printed or not.}
* \cgalParamType{Boolean}
* \cgalParamDefault{`true`}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \returns `true` if the reading was successful, `false` otherwise.
*/
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool read_STL(const char* fname, PointRange& points, TriangleRange& facets, const CGAL_BGL_NP_CLASS& np,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
std::ifstream in(fname);
return read_STL(in, points, facets, np);
}
/// \cond SKIP_IN_MANUAL
template <typename PointRange, typename TriangleRange>
bool read_STL(const char* fname, PointRange& points, TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return read_STL(fname, points, facets, parameters::all_default());
}
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool read_STL(const std::string& fname, PointRange& points, TriangleRange& facets, const CGAL_BGL_NP_CLASS& np,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return read_STL(fname.c_str(), points, facets, np);
}
template <typename PointRange, typename TriangleRange>
bool read_STL(const std::string& fname, PointRange& points, TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return read_STL(fname, points, facets, parameters::all_default());
}
/// \endcond
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////
// Write
/*!
* \ingroup PkgStreamSupportIoFuncsSTL
*
* writes the content of `points` and `facets` in `os`, using the \ref IOStreamSTL.
*
* \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
* \tparam TriangleRange a model of the concept `SequenceContainer`
* whose value_type is itself a model of the concept `SequenceContainer`
* whose value_type is an integer type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param os the output stream
* \param points points of the soup of triangles
* \param facets a `TriangleRange`. Each element in it describes a triangle
* using the indices of the points in `points`.
* \param np optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{stream_precision}
* \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
* \cgalParamType{int}
* \cgalParamDefault{`6`}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \return `true` if the writing was successful, `false` otherwise.
*/
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool write_STL(std::ostream& os,
const PointRange& points,
const TriangleRange& facets,
const CGAL_BGL_NP_CLASS& np
#ifndef DOXYGEN_RUNNING
, typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr
#endif
)
{
typedef typename boost::range_value<TriangleRange>::type Triangle;
using parameters::choose_parameter;
using parameters::get_parameter;
typedef typename CGAL::GetPointMap<PointRange, CGAL_BGL_NP_CLASS>::type PointMap;
PointMap point_map = choose_parameter<PointMap>(get_parameter(np, internal_np::point_map));
typedef typename boost::property_traits<PointMap>::value_type Point;
typedef typename boost::property_traits<PointMap>::reference Point_ref;
typedef typename CGAL::Kernel_traits<Point>::Kernel K;
typedef typename K::Vector_3 Vector_3;
if(!os.good())
return false;
const int precision = choose_parameter(get_parameter(np, internal_np::stream_precision), 6);
os << std::setprecision(precision);
if(get_mode(os) == IO::BINARY)
{
os << "FileType: Binary ";
const boost::uint32_t N32 = static_cast<boost::uint32_t>(facets.size());
os.write(reinterpret_cast<const char *>(&N32), sizeof(N32));
for(const Triangle& face : facets)
{
const Point_ref p = get(point_map, points[face[0]]);
const Point_ref q = get(point_map, points[face[1]]);
const Point_ref r = get(point_map, points[face[2]]);
const Vector_3 n = collinear(p,q,r) ? Vector_3(1,0,0) : unit_normal(p,q,r);
const float coords[12] = { static_cast<float>(n.x()), static_cast<float>(n.y()), static_cast<float>(n.z()),
static_cast<float>(p.x()), static_cast<float>(p.y()), static_cast<float>(p.z()),
static_cast<float>(q.x()), static_cast<float>(q.y()), static_cast<float>(q.z()),
static_cast<float>(r.x()), static_cast<float>(r.y()), static_cast<float>(r.z()) };
for(int i=0; i<12; ++i)
os.write(reinterpret_cast<const char *>(&coords[i]), sizeof(coords[i]));
os << " ";
}
}
else
{
os << "solid\n";
for(const Triangle& face : facets)
{
const Point_ref p = get(point_map, points[face[0]]);
const Point_ref q = get(point_map, points[face[1]]);
const Point_ref r = get(point_map, points[face[2]]);
const Vector_3 n = collinear(p,q,r) ? Vector_3(1,0,0) : unit_normal(p,q,r);
os << "facet normal " << n << "\nouter loop\n";
os << "vertex " << p << "\n";
os << "vertex " << q << "\n";
os << "vertex " << r << "\n";
os << "endloop\nendfacet"<<std::endl;
}
os << "endsolid"<<std::endl;
}
return !os.fail();
}
/// \cond SKIP_IN_MANUAL
template <typename PointRange, typename TriangleRange>
bool write_STL(std::ostream& os, const PointRange& points, const TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return write_STL(os, points, facets, parameters::all_default());
}
/// \endcond
/*!
* \ingroup PkgStreamSupportIoFuncsSTL
*
* \brief writes the content of `points` and `facets` in a file named `fname`, using the \ref IOStreamSTL.
*
* \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
* \tparam TriangleRange a model of the concept `SequenceContainer`
* whose value_type is itself a model of the concept `SequenceContainer`
* whose value_type is an integer type.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
*
* \param fname the path to the output file
* \param points points of the soup of triangles
* \param facets a `TriangleRange`. Each element in it describes a triangle
* using the indices of the points in `points`.
* \param np optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{stream_precision}
* \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
* \cgalParamType{int}
* \cgalParamDefault{`6`}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \return `true` if the writing was successful, `false` otherwise.
*/
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool write_STL(const char* fname,
const PointRange& points,
const TriangleRange& facets,
const CGAL_BGL_NP_CLASS& np
#ifndef DOXYGEN_RUNNING
, typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr
#endif
)
{
std::ofstream os(fname);
return write_STL(os, points, facets, np);
}
/// \cond SKIP_IN_MANUAL
template <typename PointRange, typename TriangleRange>
bool write_STL(const char* fname, const PointRange& points, const TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return write_STL(fname, points, facets, parameters::all_default());
}
template <typename PointRange, typename TriangleRange, typename CGAL_BGL_NP_TEMPLATE_PARAMETERS>
bool write_STL(const std::string& fname, const PointRange& points, const TriangleRange& facets, const CGAL_BGL_NP_CLASS& np,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return write_STL(fname.c_str(), points, facets, np);
}
template <typename PointRange, typename TriangleRange>
bool write_STL(const std::string& fname, const PointRange& points, const TriangleRange& facets,
typename boost::enable_if<IO::internal::is_Range<TriangleRange> >::type* = nullptr)
{
return write_STL(fname.c_str(), points, facets, parameters::all_default());
}
/// \endcond
} // namespace CGAL
#endif // CGAL_IO_STL_H