io_stl.hpp File Reference

C++ veneer for STL I/O. More...

#include <occtl/occtl_io_stl.h>
#include <occtl-hpp/core.hpp>
#include <occtl-hpp/topo.hpp>
#include <cstddef>
#include <cstdint>
#include <string>
#include <utility>
#include <vector>

Include dependency graph for io_stl.hpp:

Go to the source code of this file.

Classes
struct	occtl::io_stl::WriteOptions
	Options for write. PascalCase mirror of occtl_io_stl_write_options_t. More...

Functions
std::pair< Graph, NodeId >	occtl::io_stl::read (const std::string &thePath)
	Reads an STL file into a fresh graph and returns (graph, root).
std::pair< Graph, NodeId >	occtl::io_stl::read_memory (const uint8_t *const theData, const std::size_t theSize)
	Reads an STL payload from memory into a fresh graph and returns (graph, root).
std::pair< Graph, NodeId >	occtl::io_stl::read_memory (const std::vector< uint8_t > &theData)
	Reads an STL payload from memory into a fresh graph and returns (graph, root).
void	occtl::io_stl::write (const Graph &theGraph, const NodeId theRoot, const std::string &thePath, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot to an STL file.
std::vector< uint8_t >	occtl::io_stl::write_memory (const Graph &theGraph, const NodeId theRoot, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot to an STL payload in memory.

Detailed Description

C++ veneer for STL I/O.

Function Documentation

read()

std::pair< Graph, NodeId > occtl::io_stl::read ( const std::string &  thePath )

inline

Reads an STL file into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

read_memory() [1/2]

std::pair< Graph, NodeId > occtl::io_stl::read_memory ( const std::vector< uint8_t > &  theData )

inline

Reads an STL payload from memory into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

read_memory() [2/2]

std::pair< Graph, NodeId > occtl::io_stl::read_memory ( const uint8_t *const  theData, const std::size_t  theSize  )

inline

Reads an STL payload from memory into a fresh graph and returns (graph, root).

Exceptions

Error

on failure.

write()

void occtl::io_stl::write ( const Graph &  theGraph, const NodeId  theRoot, const std::string &  thePath, const WriteOptions &  theOptions = WriteOptions{}  )

inline

Writes the topology rooted at theRoot to an STL file.

Exceptions

Error

on failure.

write_memory()

std::vector< uint8_t > occtl::io_stl::write_memory ( const Graph &  theGraph, const NodeId  theRoot, const WriteOptions &  theOptions = WriteOptions{}  )

inline

Writes the topology rooted at theRoot to an STL payload in memory.

Exceptions

Error

on failure.