bool.hpp File Reference

C++ veneer for boolean operations. More...

#include <occtl/occtl_bool.h>
#include <occtl-hpp/core.hpp>
#include <occtl-hpp/topo.hpp>
#include <cstddef>
#include <cstdint>
#include <vector>

Include dependency graph for bool.hpp:

Go to the source code of this file.

Classes
struct	occtl::bool_::BoolOptions
	PascalCase mirror of occtl_bool_options_t with idiomatic defaults. More...

Namespaces
namespace	occtl::bool_
	Boolean-operation veneer namespace; trailing underscore avoids the C++ keyword.

Typedefs
using	occtl::bool_::detail::EntryFn = ::occtl_status_t(*)(::occtl_graph_t *, const ::occtl_node_id_t *, std::size_t, const ::occtl_node_id_t *, std::size_t, const ::occtl_bool_options_t *, ::occtl_node_id_t *)

Functions
NodeId	occtl::bool_::detail::run (const EntryFn theFn, Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts)
NodeId	occtl::bool_::fuse (Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts={})
	Boolean Fuse of two argument groups. See occtl_bool_fuse.
NodeId	occtl::bool_::cut (Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts={})
	Boolean Cut. See occtl_bool_cut.
NodeId	occtl::bool_::common (Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts={})
	Boolean Common (intersection). See occtl_bool_common.
NodeId	occtl::bool_::section (Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts={})
	Boolean Section. See occtl_bool_section.
NodeId	occtl::bool_::split (Graph &theGraph, const std::vector< NodeId > &theObjects, const std::vector< NodeId > &theTools, const BoolOptions &theOpts={})
	Boolean Split. See occtl_bool_split.

Detailed Description

C++ veneer for boolean operations.

Provides idiomatic free functions for the five boolean operations, returning the result root. Failures translate to occtl::Error via check().