io_vrml.hpp File Reference

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

#include <occtl/occtl_io_vrml.h>
#include <occtl-hpp/core.hpp>
#include <occtl-hpp/topo.hpp>
#include <string>
#include <utility>
#include <vector>

Include dependency graph for io_vrml.hpp:

Go to the source code of this file.

Classes
struct	occtl::io_vrml::ReadOptions
	Options for read. PascalCase mirror of occtl_io_vrml_read_options_t. More...
struct	occtl::io_vrml::WriteOptions
	Options for write. PascalCase mirror of occtl_io_vrml_write_options_t. More...

Enumerations
enum class	occtl::io_vrml::CoordinateSystem { YUp = OCCTL_IO_VRML_COORDINATE_SYSTEM_Y_UP , ZUp = OCCTL_IO_VRML_COORDINATE_SYSTEM_Z_UP , Gltf = OCCTL_IO_VRML_COORDINATE_SYSTEM_GLTF }
	Coordinate system used by VRML import/export conversion.
enum class	occtl::io_vrml::WriterVersion { V1 = OCCTL_IO_VRML_WRITER_VERSION_1 , V2 = OCCTL_IO_VRML_WRITER_VERSION_2 }
	VRML writer version.
enum class	occtl::io_vrml::Representation { Shaded = OCCTL_IO_VRML_REPRESENTATION_SHADED , Wireframe = OCCTL_IO_VRML_REPRESENTATION_WIREFRAME , Both = OCCTL_IO_VRML_REPRESENTATION_BOTH }
	VRML output representation.

Functions
std::pair< Graph, NodeId >	occtl::io_vrml::read (const std::string &thePath, const ReadOptions &theOptions=ReadOptions{})
	Reads a VRML file into a fresh graph and returns (graph, root).
void	occtl::io_vrml::write (const Graph &theGraph, const NodeId theRoot, const std::string &thePath, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot to a VRML file.
std::pair< Graph, NodeId >	occtl::io_vrml::read_memory (const std::vector< uint8_t > &theData, const ReadOptions &theOptions=ReadOptions{})
	Reads a VRML memory buffer into a fresh graph.
std::vector< uint8_t >	occtl::io_vrml::write_memory (const Graph &theGraph, const NodeId theRoot, const WriteOptions &theOptions=WriteOptions{})
	Writes the topology rooted at theRoot to a VRML memory buffer.

Detailed Description

C++ veneer for VRML I/O.

Function Documentation

read()

std::pair< Graph, NodeId > occtl::io_vrml::read ( const std::string &  thePath, const ReadOptions &  theOptions = ReadOptions{}  )

inline

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

Exceptions

Error

on failure.

read_memory()

std::pair< Graph, NodeId > occtl::io_vrml::read_memory ( const std::vector< uint8_t > &  theData, const ReadOptions &  theOptions = ReadOptions{}  )

inline

Reads a VRML memory buffer into a fresh graph.

Exceptions

Error

on failure.

write()

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

inline

Writes the topology rooted at theRoot to a VRML file.

Exceptions

Error

on failure.

write_memory()

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

inline

Writes the topology rooted at theRoot to a VRML memory buffer.

Exceptions

Error

on failure.