occtl_io_vrml.h

Go to the documentation of this file.

// Copyright (c) 2026 Capgemini Engineering Research and Development.
//
// This file is part of OCCT-Light software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Affero General Public License version 3 as published
// by the Free Software Foundation, with an option to use any later version.
// Consult the file LICENSE_AGPL_30.txt included in OCCT-Light distribution
// for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of a commercial
// license or contractual agreement.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#ifndef OCCTL_IO_VRML_H
#define OCCTL_IO_VRML_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum occtl_io_vrml_coordinate_system
{
  OCCTL_IO_VRML_COORDINATE_SYSTEM_Y_UP            = 0, 
  OCCTL_IO_VRML_COORDINATE_SYSTEM_Z_UP            = 1, 
  OCCTL_IO_VRML_COORDINATE_SYSTEM_GLTF            = 2, 
  OCCTL_IO_VRML_COORDINATE_SYSTEM_RESERVED_FUTURE = 0x7fffffff
} occtl_io_vrml_coordinate_system_t;
 
typedef enum occtl_io_vrml_writer_version
{
  OCCTL_IO_VRML_WRITER_VERSION_1               = 1, 
  OCCTL_IO_VRML_WRITER_VERSION_2               = 2, 
  OCCTL_IO_VRML_WRITER_VERSION_RESERVED_FUTURE = 0x7fffffff
} occtl_io_vrml_writer_version_t;
 
typedef enum occtl_io_vrml_representation
{
  OCCTL_IO_VRML_REPRESENTATION_SHADED          = 0, 
  OCCTL_IO_VRML_REPRESENTATION_WIREFRAME       = 1, 
  OCCTL_IO_VRML_REPRESENTATION_BOTH            = 2, 
  OCCTL_IO_VRML_REPRESENTATION_RESERVED_FUTURE = 0x7fffffff
} occtl_io_vrml_representation_t;
 
#define OCCTL_IO_VRML_READ_OPTIONS_VERSION_1 1u
#define OCCTL_IO_VRML_WRITE_OPTIONS_VERSION_1 1u
 
typedef struct occtl_io_vrml_read_options
{
  uint32_t    struct_version;     
  const void* p_next;             
  double      file_length_unit_m; 
  occtl_io_vrml_coordinate_system_t
    system_coordinate_system; 
  occtl_io_vrml_coordinate_system_t
          file_coordinate_system; 
  int32_t fill_incomplete;        
} occtl_io_vrml_read_options_t;
 
#define OCCTL_IO_VRML_READ_OPTIONS_INIT                                                            \
  {OCCTL_IO_VRML_READ_OPTIONS_VERSION_1,                                                           \
   NULL,                                                                                           \
   1.0,                                                                                            \
   OCCTL_IO_VRML_COORDINATE_SYSTEM_Z_UP,                                                           \
   OCCTL_IO_VRML_COORDINATE_SYSTEM_Y_UP,                                                           \
   1}
 
typedef struct occtl_io_vrml_write_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  occtl_io_vrml_writer_version_t writer_version; 
  occtl_io_vrml_representation_t representation; 
} occtl_io_vrml_write_options_t;
 
#define OCCTL_IO_VRML_WRITE_OPTIONS_INIT                                                           \
  {OCCTL_IO_VRML_WRITE_OPTIONS_VERSION_1,                                                          \
   NULL,                                                                                           \
   OCCTL_IO_VRML_WRITER_VERSION_2,                                                                 \
   OCCTL_IO_VRML_REPRESENTATION_WIREFRAME}
 
OCCTL_API void OCCTL_CALL occtl_io_vrml_read_options_init(occtl_io_vrml_read_options_t* options);
 
OCCTL_API void OCCTL_CALL occtl_io_vrml_write_options_init(occtl_io_vrml_write_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_io_vrml_read(const char*      path,
                                                       occtl_graph_t**  out_graph,
                                                       occtl_node_id_t* out_root,
                                                       const occtl_io_vrml_read_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_io_vrml_write(const occtl_graph_t*                 graph,
                      occtl_node_id_t                      root,
                      const char*                          path,
                      const occtl_io_vrml_write_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_io_vrml_read_memory(const uint8_t*                      data,
                            size_t                              size,
                            occtl_graph_t**                     out_graph,
                            occtl_node_id_t*                    out_root,
                            const occtl_io_vrml_read_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_io_vrml_write_memory(const occtl_graph_t*                 graph,
                             occtl_node_id_t                      root,
                             const occtl_io_vrml_write_options_t* options,
                             uint8_t*                             out_data,
                             size_t                               capacity,
                             size_t*                              out_size);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_IO_VRML_H */