Files
IfcOpenShell/src/serializers/SvgSerializer.h
T
2024-04-15 13:28:13 +02:00

708 lines
20 KiB
C++

/********************************************************************************
* *
* Copyright 2015 IfcOpenShell and ROOT B.V. *
* *
* This file is part of IfcOpenShell. *
* *
* IfcOpenShell is free software: you can redistribute it and/or modify *
* it under the terms of the Lesser GNU General Public License as published by *
* the Free Software Foundation, either version 3.0 of the License, or *
* (at your option) any later version. *
* *
* IfcOpenShell is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* Lesser GNU General Public License for more details. *
* *
* You should have received a copy of the Lesser GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
********************************************************************************/
#ifdef IFOPSH_WITH_OPENCASCADE
#ifndef SVGSERIALIZER_H
#define SVGSERIALIZER_H
#include "../ifcgeom/GeometrySerializer.h"
#include "../ifcgeom/kernels/opencascade/base_utils.h"
#include "../serializers/serializers_api.h"
#include "../serializers/util.h"
#include "../ifcparse/utils.h"
#include <HLRBRep_Algo.hxx>
#include <HLRBRep_HLRToShape.hxx>
#include <HLRBRep_PolyAlgo.hxx>
#include <HLRAlgo_Projector.hxx>
#include <gp_Pln.hxx>
#include <Bnd_Box.hxx>
#include <Standard_Version.hxx>
#include <BRep_Builder.hxx>
#include <HLRBRep_PolyHLRToShape.hxx>
#include <BRepTopAdaptor_FClass2d.hxx>
#include <Geom_Plane.hxx>
#include <BRepBndLib.hxx>
#if OCC_VERSION_HEX >= 0x70300
#include <Bnd_OBB.hxx>
#endif
#include <sstream>
#include <string>
#include <limits>
#include <array>
typedef std::pair<const IfcUtil::IfcBaseEntity*, std::string> drawing_key;
struct storey_sorter {
bool operator()(const drawing_key& ad, const drawing_key& bd) const {
if (ad.first == nullptr && bd.first != nullptr) {
return false;
} else if (bd.first == nullptr && ad.first != nullptr) {
return true;
} else if (ad.first == nullptr && bd.first == nullptr) {
return std::less<std::string>()(ad.second, bd.second);
}
auto a = ad.first;
auto b = bd.first;
const bool a_is_storey = a->declaration().is("IfcBuildingStorey");
const bool b_is_storey = b->declaration().is("IfcBuildingStorey");
if (a_is_storey && b_is_storey) {
boost::optional<double> a_elev, b_elev;
try {
a_elev = static_cast<double>(*a->get("Elevation"));
b_elev = static_cast<double>(*b->get("Elevation"));
} catch (...) {};
if (a_elev && b_elev) {
if (std::equal_to<double>()(*a_elev, *b_elev)) {
return std::less<unsigned int>()(a->data().id(), b->data().id());
} else {
return std::less<double>()(*a_elev, *b_elev);
}
}
boost::optional<std::string> a_name, b_name;
try {
a_name = static_cast<std::string>(*a->get("Name"));
b_name = static_cast<std::string>(*b->get("Name"));
} catch (...) {};
if (a_name && b_name) {
if (std::equal_to<std::string>()(*a_name, *b_name)) {
return std::less<unsigned int>()(a->data().id(), b->data().id());
} else {
return std::less<std::string>()(*a_name, *b_name);
}
}
}
return std::less<const IfcUtil::IfcBaseEntity*>()(a, b);
}
};
struct horizontal_plan {
const IfcUtil::IfcBaseEntity* storey;
double elevation, offset, next_elevation;
};
struct horizontal_plan_at_element {};
struct vertical_section {
gp_Pln plane;
std::string name;
bool with_projection;
boost::optional<double> scale;
boost::optional<std::pair<double, double>> size;
};
typedef boost::variant<horizontal_plan, horizontal_plan_at_element, vertical_section> section_data;
struct geometry_data {
TopoDS_Shape compound_local;
std::vector<boost::optional<std::vector<double>>> dash_arrays;
gp_Trsf trsf;
const IfcUtil::IfcBaseEntity* product;
const IfcUtil::IfcBaseEntity* storey;
double storey_elevation;
std::string ifc_name, svg_name;
};
struct drawing_meta {
gp_Pln pln_3d;
std::array<std::array<double, 3>, 3> matrix_3;
};
enum subtract_before_project {
ON_SLABS_AT_FLOORPLANS,
ON_SLABS_AND_WALLS,
ALWAYS
};
typedef boost::variant<
boost::blank,
Handle(HLRBRep_Algo),
Handle(HLRBRep_PolyAlgo)
> hlr_brep_or_poly_t;
namespace {
class hlr_writer {
const TopoDS_Shape& shape_;
public:
typedef void result_type;
hlr_writer(const TopoDS_Shape& shape) : shape_(shape)
{}
void operator()(boost::blank&) const {
throw std::runtime_error("");
}
void operator()(Handle(HLRBRep_Algo)& algo) const {
algo->Add(shape_);
}
void operator()(Handle(HLRBRep_PolyAlgo)& algo) const {
BRepMesh_IncrementalMesh(shape_, 0.10);
algo->Load(shape_);
}
};
template <typename T>
TopoDS_Compound occt_join(T t) {
BRep_Builder B;
TopoDS_Compound C;
B.MakeCompound(C);
if (!t.IsNull()) {
TopoDS_Iterator it(t);
for (; it.More(); it.Next()) {
B.Add(C, it.Value());
}
}
return C;
}
template <typename T, typename... Ts>
TopoDS_Compound occt_join(T t, Ts... tss) {
BRep_Builder B;
TopoDS_Compound C;
B.MakeCompound(C);
if (!t.IsNull()) {
TopoDS_Iterator it(t);
for (; it.More(); it.Next()) {
B.Add(C, it.Value());
}
}
auto rest = occt_join(tss...);
if (!rest.IsNull()) {
TopoDS_Iterator it(rest);
for (; it.More(); it.Next()) {
B.Add(C, it.Value());
}
}
return C;
}
class hlr_calc {
private:
const HLRAlgo_Projector& projector_;
public:
typedef TopoDS_Shape result_type;
hlr_calc(const HLRAlgo_Projector& projector) : projector_(projector)
{}
TopoDS_Shape operator()(boost::blank&) const {
throw std::runtime_error("");
}
TopoDS_Shape operator()(Handle(HLRBRep_Algo)& algo) {
algo->Projector(projector_);
algo->Update();
algo->Hide();
HLRBRep_HLRToShape hlr_shapes(algo);
return occt_join(hlr_shapes.OutLineVCompound(), hlr_shapes.VCompound());
}
TopoDS_Shape operator()(Handle(HLRBRep_PolyAlgo)& algo) {
algo->Projector(projector_);
algo->Update();
HLRBRep_PolyHLRToShape hlr_shapes;
hlr_shapes.Update(algo);
return occt_join(hlr_shapes.OutLineVCompound(), hlr_shapes.VCompound());
}
};
class prefiltered_hlr {
class face_info {
private:
gp_XYZ dxyz, xdir, ydir;
public:
std::list<TopoDS_Shape>::const_iterator item;
TopoDS_Face face;
bool is_convex;
// @note copying the BRepTopAdaptor_FClass2d didn't work so it's a pointer
BRepTopAdaptor_FClass2d* fclass;
face_info(std::list<TopoDS_Shape>::const_iterator it, const TopoDS_Face& fa)
: item(it)
, face(fa)
, fclass(nullptr)
{
TopExp_Explorer exp(face, TopAbs_WIRE);
is_convex = exp.More() && IfcGeom::util::is_convex(TopoDS::Wire(exp.Current()), 1.e-5) && ([&exp]() {exp.Next(); return true; })() && !exp.More();
auto surf = BRep_Tool::Surface(fa);
if (surf->DynamicType() != STANDARD_TYPE(Geom_Plane)) {
throw std::runtime_error("Not implemented");
}
auto pln = Handle(Geom_Plane)::DownCast(surf);
dxyz = pln->Position().Location().XYZ();
xdir = pln->Position().XDirection().XYZ();
ydir = pln->Position().YDirection().XYZ();
}
~face_info() {
delete fclass;
}
void project(const gp_Pnt& xyz, gp_Pnt2d& uv) {
const gp_Vec d = xyz.XYZ() - dxyz;
uv.SetX(d.Dot(xdir));
uv.SetY(d.Dot(ydir));
}
void interp(const gp_Pnt2d& a, const gp_Pnt2d& b, double d, gp_Pnt2d& out) {
out.SetCoord(a.X() + (b.X() - a.X()) * d, a.Y() + (b.Y() - a.Y()) * d);
}
bool contains(const gp_Pnt& bottomleft, const gp_Pnt& topright) {
gp_Pnt2d a, b;
project(bottomleft, a);
project(topright, b);
return contains(a, b);
}
bool contains(const gp_Pnt2d& bottomleft, const gp_Pnt2d& topright) {
if (!fclass) {
fclass = new BRepTopAdaptor_FClass2d(face, 1.e-5);
}
// @todo unify with the 2d boolean algo
gp_Pnt2d bottomright(topright.X(), bottomleft.Y());
gp_Pnt2d topleft(bottomleft.X(), topright.Y());
std::array<gp_Pnt2d const*, 4> loop{ {
&bottomleft,
&bottomright,
&topright,
&topleft
} };
if (is_convex) {
for (int i = 0; i < 4; ++i) {
if (fclass->Perform(*loop[i]) == TopAbs_OUT) {
return false;
}
}
} else {
gp_Pnt2d tmp;
for (int i = 0; i < 4; ++i) {
// @todo proper edge intersection
for (int j = 0; j < 16; ++j) {
const gp_Pnt2d& a = *loop[i];
const gp_Pnt2d& b = *loop[(i + 1) % 4];
interp(a, b, j / 16.0, tmp);
if (fclass->Perform(tmp) == TopAbs_OUT) {
return false;
}
}
}
}
return true;
}
};
hlr_brep_or_poly_t engine_;
bool use_prefiltering_;
bool use_hlr_poly_;
gp_Ax1 view_direction_;
HLRAlgo_Projector projector_;
std::multimap<double, face_info> large_ortho_faces_;
std::list<TopoDS_Shape> items_;
public:
prefiltered_hlr(bool use_prefiltering, bool use_hlr_poly, const gp_Pln& view_direction)
: use_prefiltering_(use_prefiltering)
, use_hlr_poly_(use_hlr_poly)
// @nb negative z in accordance with occt projector convention (and opengl)
, view_direction_(view_direction.Axis())
{
if (use_hlr_poly_) {
engine_ = new HLRBRep_PolyAlgo;
} else {
engine_ = new HLRBRep_Algo;
}
gp_Trsf trsf;
trsf.SetTransformation(view_direction.Position());
projector_ = HLRAlgo_Projector(trsf, false, 1.);
}
bool is_obscured_(std::list<TopoDS_Shape>::const_iterator sit) {
const TopoDS_Shape& s = *sit;
double min_d = std::numeric_limits<double>::infinity();
TopExp_Explorer exp(s, TopAbs_VERTEX);
for (; exp.More(); exp.Next()) {
const auto& v = TopoDS::Vertex(exp.Current());
auto pnt = BRep_Tool::Pnt(v);
auto d = -(pnt.XYZ() - view_direction_.Location().XYZ()).Dot(view_direction_.Direction().XYZ());
if (d < min_d) {
min_d = d;
}
}
Bnd_Box box;
BRepBndLib::AddClose(s, box);
auto lower = large_ortho_faces_.lower_bound(0.);
auto upper = large_ortho_faces_.upper_bound(min_d);
for (auto it = lower; it != upper; ++it) {
if (it->second.item == sit) {
continue;
}
if (it->second.contains(box.CornerMin(), box.CornerMax())) {
return true;
}
}
return false;
}
void add(const TopoDS_Shape& s) {
if (!use_prefiltering_) {
items_.insert(items_.end(), s);
}
TopoDS_Compound C;
BRep_Builder BB;
BB.MakeCompound(C);
gp_Pnt P;
gp_Vec V;
gp_Dir D;
if (IfcGeom::util::is_manifold(s)) {
size_t n_faces_included = 0, n_total = 0;
{
TopExp_Explorer exp(s, TopAbs_FACE);
for (; exp.More(); exp.Next(), n_total++) {
const auto& face = TopoDS::Face(exp.Current());
if (BRep_Tool::Surface(face)->DynamicType() == STANDARD_TYPE(Geom_Plane)) {
BRepGProp_Face prop(face);
prop.Normal(0., 0., P, V);
if (V.SquareMagnitude() > 1.e-9) {
D = V;
// keep only front-facing
if (D.Dot(view_direction_.Direction()) > 1.e-3) {
BB.Add(C, face);
n_faces_included++;
}
}
} else {
BB.Add(C, face);
n_faces_included++;
}
}
}
Logger::Notice("Included " + std::to_string(n_faces_included) + " faces out of " + std::to_string(n_total) + " after prefiltering");
auto it = items_.insert(items_.end(), C);
{
TopExp_Explorer exp(C, TopAbs_FACE);
for (; exp.More(); exp.Next()) {
const auto& face = TopoDS::Face(exp.Current());
if (BRep_Tool::Surface(face)->DynamicType() == STANDARD_TYPE(Geom_Plane)) {
// find large faces orthogonal to view dir
BRepGProp_Face prop(face);
prop.Normal(0., 0., P, V);
D = V;
if (D.Dot(view_direction_.Direction()) > (1. - 1.e-3)) {
if (IfcGeom::util::face_area(face) > 2.) {
// arbitrary vertex, is ok because orthogonal to view dir
TopExp_Explorer expv(face, TopAbs_VERTEX);
if (expv.More()) {
const auto& v = TopoDS::Vertex(expv.Current());
auto pnt = BRep_Tool::Pnt(v);
auto d = -(pnt.XYZ() - view_direction_.Location().XYZ()).Dot(view_direction_.Direction().XYZ());
if (d > 1.e-5) {
large_ortho_faces_.insert({ d, face_info(it, face) });
}
}
}
}
}
}
}
} else {
items_.insert(items_.end(), s);
}
}
TopoDS_Shape build() {
size_t n_included = 0;
for (auto it = items_.begin(); it != items_.end(); ++it) {
if (!use_prefiltering_ || !is_obscured_(it)) {
hlr_writer vis(*it);
boost::apply_visitor(vis, engine_);
n_included++;
}
}
if (use_prefiltering_) {
Logger::Notice("Included " + std::to_string(n_included) + " elements out of " + std::to_string(items_.size()) + " after prefiltering");
}
hlr_calc vis(projector_);
return boost::apply_visitor(vis, engine_);
}
};
}
typedef prefiltered_hlr hlr_t;
class SERIALIZERS_API SvgSerializer : public WriteOnlyGeometrySerializer {
public:
typedef std::pair<std::string, std::vector<util::string_buffer> > path_object;
typedef std::vector< boost::shared_ptr<util::string_buffer::float_item> > float_item_list;
enum storey_height_display_types {
SH_NONE, SH_FULL, SH_LEFT
};
protected:
stream_or_filename svg_file;
double xmin, ymin, xmax, ymax;
boost::optional<std::vector<section_data>> section_data_;
boost::optional<std::vector<section_data>> deferred_section_data_;
boost::optional<double> scale_, calculated_scale_, center_x_, center_y_;
boost::optional<double> storey_height_line_length_;
boost::optional<std::pair<double, double>> size_, offset_2d_;
boost::optional<std::string> space_name_transform_;
#if OCC_VERSION_HEX >= 0x70300
boost::optional<Bnd_OBB> view_box_3d_;
#endif
bool with_section_heights_from_storey_, print_space_names_, print_space_areas_;
storey_height_display_types storey_height_display_;
bool draw_door_arcs_, is_floor_plan_;
bool auto_section_, auto_elevation_;
bool use_namespace_, use_hlr_poly_, use_prefiltering_, always_project_, polygonal_;
bool emit_building_storeys_;
bool no_css_;
int profile_threshold_;
IfcParse::IfcFile* file;
const IfcUtil::IfcBaseEntity* storey_;
std::multimap<drawing_key, path_object, storey_sorter> paths;
std::map<drawing_key, drawing_meta> drawing_metadata;
std::map<const IfcUtil::IfcBaseEntity*, hlr_t> storey_hlr;
float_item_list xcoords, ycoords, radii;
size_t xcoords_begin, ycoords_begin, radii_begin;
boost::optional<std::string> section_ref_, elevation_ref_, elevation_ref_guid_;
std::list<geometry_data> element_buffer_;
hlr_t* hlr;
std::string namespace_prefix_;
// Used for drawing the storey elevation heights
// @todo maybe better to rely on a screen-space bounding box
Bnd_Box bnd_;
void draw_hlr(const gp_Pln& pln, const drawing_key& drawing_name);
subtract_before_project subtraction_settings_;
public:
SvgSerializer(const stream_or_filename& out_filename, const ifcopenshell::geometry::Settings& geometry_settings, const ifcopenshell::geometry::SerializerSettings& settings)
: WriteOnlyGeometrySerializer(geometry_settings, settings)
, svg_file(out_filename)
, xmin(+std::numeric_limits<double>::infinity())
, ymin(+std::numeric_limits<double>::infinity())
, xmax(-std::numeric_limits<double>::infinity())
, ymax(-std::numeric_limits<double>::infinity())
, with_section_heights_from_storey_(false)
, print_space_names_(false)
, print_space_areas_(false)
, storey_height_display_(SH_NONE)
, draw_door_arcs_(false)
, is_floor_plan_(true)
, auto_section_(false)
, auto_elevation_(false)
, use_namespace_(false)
, use_hlr_poly_(false)
, use_prefiltering_(false)
, always_project_(false)
, polygonal_(false)
, emit_building_storeys_(true)
, no_css_(false)
, profile_threshold_(-1)
, file(0)
, storey_(0)
, xcoords_begin(0)
, ycoords_begin(0)
, radii_begin(0)
, hlr(nullptr)
, namespace_prefix_("data-")
, subtraction_settings_(ON_SLABS_AT_FLOORPLANS)
{}
void addXCoordinate(const boost::shared_ptr<util::string_buffer::float_item>& fi) { xcoords.push_back(fi); }
void addYCoordinate(const boost::shared_ptr<util::string_buffer::float_item>& fi) { ycoords.push_back(fi); }
void addSizeComponent(const boost::shared_ptr<util::string_buffer::float_item>& fi) { radii.push_back(fi); }
void growBoundingBox(double x, double y) { if (x < xmin) xmin = x; if (x > xmax) xmax = x; if (y < ymin) ymin = y; if (y > ymax) ymax = y; }
void writeHeader();
void doWriteHeader();
bool ready();
void write(const IfcGeom::TriangulationElement* /*o*/) {}
void write(const IfcGeom::BRepElement* o);
void write(path_object& p, const TopoDS_Shape& wire, boost::optional<std::vector<double>> dash_array=boost::none);
void write(const geometry_data& data);
path_object& start_path(const gp_Pln& p, const IfcUtil::IfcBaseEntity* storey, const std::string& id);
path_object& start_path(const gp_Pln& p, const std::string& drawing_name, const std::string& id);
bool isTesselated() const { return false; }
void finalize();
void setUnitNameAndMagnitude(const std::string& /*name*/, float /*magnitude*/) {}
void setFile(IfcParse::IfcFile* f);
void setBoundingRectangle(double width, double height);
void setSectionHeight(double h, const IfcUtil::IfcBaseEntity* storey = 0);
void setSectionHeightsFromStoreys(double offset=1.2);
void setPrintSpaceNames(bool b) { print_space_names_ = b; }
void setPrintSpaceAreas(bool b) { print_space_areas_ = b; }
void setDrawStoreyHeights(storey_height_display_types sh) { storey_height_display_ = sh; }
void setDrawDoorArcs(bool b) { draw_door_arcs_ = b; }
void setStoreyHeightLineLength(double d) { storey_height_line_length_ = d; }
void setSpaceNameTransform(const std::string& v) { space_name_transform_ = v; }
void addTextAnnotations(const drawing_key& k);
std::array<std::array<double, 3>, 3> resize();
void resetScale();
void setSectionRef(const boost::optional<std::string>& s) {
section_ref_ = s;
}
void setElevationRef(const boost::optional<std::string>& s) {
elevation_ref_ = s;
elevation_ref_guid_ = boost::none;
}
void setElevationRefGuid(const boost::optional<std::string>& s) {
elevation_ref_ = boost::none;
elevation_ref_guid_ = s;
}
void setAutoSection(bool b) {
auto_section_ = b;
}
void setAutoElevation(bool b) {
auto_elevation_ = b;
}
void setUseNamespace(bool b) {
use_namespace_ = b;
namespace_prefix_ = use_namespace_ ? "ifc:" : "data-";
}
void setUseHlrPoly(bool b) {
use_hlr_poly_ = b;
}
void setUsePrefiltering(bool b) {
use_prefiltering_ = b;
}
bool getUsePrefiltering() const {
return use_prefiltering_;
}
void setPolygonal(bool b) {
polygonal_ = b;
}
void setAlwaysProject(bool b) {
always_project_ = b;
}
void setWithoutStoreys(bool b) {
emit_building_storeys_ = !b;
}
void setNoCSS(bool b) {
no_css_ = b;
}
void setScale(double s) { scale_ = s; }
void setDrawingCenter(double x, double y) {
center_x_ = x; center_y_ = y;
}
std::string nameElement(const IfcUtil::IfcBaseEntity* storey, const IfcGeom::Element* elem);
std::string nameElement(const IfcUtil::IfcBaseEntity* elem);
std::string idElement(const IfcUtil::IfcBaseEntity* elem);
std::string object_id(const IfcUtil::IfcBaseEntity* storey, const IfcGeom::Element* o) {
if (storey) {
return idElement(storey) + "-" + GeometrySerializer::object_id(o);
} else {
return GeometrySerializer::object_id(o);
}
}
void addDrawing(const gp_Pnt& pos, const gp_Dir& dir, const gp_Dir& ref, const std::string& name, bool include_projection) {
deferred_section_data_.emplace();
deferred_section_data_->push_back(vertical_section{ gp_Pln(gp_Ax3(pos, dir, ref)), name, include_projection });
}
void setSubtractionSettings(subtract_before_project sbp) {
subtraction_settings_ = sbp;
}
subtract_before_project getSubtractionSettings() const {
return subtraction_settings_;
}
void setProfileThreshold(int i) {
profile_threshold_ = i;
}
int getProfileThreshold() const {
return profile_threshold_;
}
protected:
std::string writeMetadata(const drawing_meta& m);
};
#endif
#endif