occtl_mesh.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_MESH_H
#define OCCTL_MESH_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_geom.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct occtl_aabb3
{
  occtl_point3_t min; 
  occtl_point3_t max; 
} occtl_aabb3_t;
 
#define OCCTL_MESH_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  double deflection; 
  double angle;      
  double
    deflection_interior; 
  double angle_interior; 
  double
    min_size; 
  int32_t in_parallel; 
  int32_t relative;    
  int32_t internal_vertices_mode;     
  int32_t control_surface_deflection; 
  int32_t control_surface_deflection_all; 
  int32_t clean_model;     
  int32_t adjust_min_size; 
  int32_t force_face_deflection;  
  int32_t allow_quality_decrease; 
  int32_t use_bbox;   
  occtl_aabb3_t bbox; 
  double deviation_coefficient; 
  double deviation_angle;       
} occtl_mesh_options_t;
 
#define OCCTL_MESH_OPTIONS_INIT                                                                    \
  {OCCTL_MESH_OPTIONS_VERSION_1,                                                                   \
   NULL,                                                                                           \
   0.001,                                                                                          \
   0.5,                                                                                            \
   -1.0,                                                                                           \
   -1.0,                                                                                           \
   -1.0,                                                                                           \
   0,                                                                                              \
   0,                                                                                              \
   1,                                                                                              \
   1,                                                                                              \
   0,                                                                                              \
   1,                                                                                              \
   0,                                                                                              \
   0,                                                                                              \
   0,                                                                                              \
   0,                                                                                              \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 0.0}},                                                             \
   0.001,                                                                                          \
   OCCTL_ANGLE_20_DEG_RAD}
 
OCCTL_API void OCCTL_CALL occtl_mesh_options_init(occtl_mesh_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_model_metadata_set(occtl_graph_t* graph,
                                                                  const char*    key,
                                                                  size_t         keyLen,
                                                                  const char*    value,
                                                                  size_t         valueLen);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_model_metadata_get(const occtl_graph_t* graph,
                                                                  const char*          key,
                                                                  size_t               keyLen,
                                                                  char*                buf,
                                                                  size_t               bufSize,
                                                                  size_t* out_required);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_model_metadata_keys(const occtl_graph_t*       graph,
                                 occtl_metadata_key_view_t* out_keys,
                                 size_t                     cap,
                                 size_t*                    out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_model_metadata_unset(occtl_graph_t* graph,
                                                                    const char*    key,
                                                                    size_t         keyLen);
 
#define OCCTL_MESH_FROM_BUFFERS_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_from_buffers_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  const double*   nodes;      
  size_t          node_count; 
  const uint32_t* triangles;  
  size_t          triangle_count; 
  double deflection; 
} occtl_mesh_from_buffers_options_t;
 
#define OCCTL_MESH_FROM_BUFFERS_OPTIONS_INIT                                                       \
  {OCCTL_MESH_FROM_BUFFERS_OPTIONS_VERSION_1, NULL, NULL, 0, NULL, 0, 0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_mesh_from_buffers_options_init(occtl_mesh_from_buffers_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_from_buffers(const occtl_mesh_from_buffers_options_t* options,
                          occtl_graph_t**                          out_graph,
                          occtl_node_id_t*                         out_root);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_generate(occtl_graph_t*              graph,
                                                        const occtl_node_id_t*      nodes,
                                                        size_t                      n_nodes,
                                                        const occtl_mesh_options_t* options);
 
typedef struct occtl_triangulation_view
{
  const double* nodes;      
  size_t        node_count; 
  const double*
    normals;         
  const double* uvs; 
  const uint32_t* triangles; 
  size_t          triangle_count; 
  double          deflection; 
  occtl_uid_t     source_uid; 
} occtl_triangulation_view_t;
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_face_triangulation(const occtl_graph_t*        graph,
                                occtl_node_id_t             face,
                                occtl_triangulation_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_face_triangulation_count(const occtl_graph_t* graph,
                                                                        occtl_node_id_t      face,
                                                                        uint32_t* out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_face_triangulation_indexed(const occtl_graph_t*        graph,
                                        occtl_node_id_t             face,
                                        uint32_t                    index,
                                        occtl_triangulation_view_t* out_view);
 
typedef struct occtl_polygon3d_view
{
  const double* nodes;      
  size_t        node_count; 
  const double*
         parameters; 
  double deflection; 
  occtl_uid_t source_uid; 
} occtl_polygon3d_view_t;
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_edge_polygon3d(const occtl_graph_t*    graph,
                                                              occtl_node_id_t         edge,
                                                              occtl_polygon3d_view_t* out_view);
 
typedef struct occtl_polygon_on_tri_view
{
  const uint32_t* node_indices; 
  size_t node_count;            
  const double*
         parameters; 
  double deflection; 
  occtl_uid_t source_uid; 
} occtl_polygon_on_tri_view_t;
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_coedge_polygon_on_tri(const occtl_graph_t*         graph,
                                   occtl_node_id_t              coedge,
                                   occtl_polygon_on_tri_view_t* out_view);
 
typedef struct occtl_mesh_triangle_buffers_view
{
  const double*   nodes;      
  size_t          node_count; 
  const uint32_t* triangles; 
  size_t          triangle_count; 
  size_t          face_count;     
  occtl_node_id_t root; 
} occtl_mesh_triangle_buffers_view_t;
 
#define OCCTL_MESH_TRIANGLE_ADJACENCY_BOUNDARY UINT32_MAX
 
typedef struct occtl_mesh_triangle_analysis_view
{
  const double* triangle_normals; 
  const uint32_t*
         triangle_adjacency; 
  size_t triangle_count;     
  size_t face_count;         
  occtl_node_id_t root; 
} occtl_mesh_triangle_analysis_view_t;
 
#define OCCTL_MESH_TRIANGLE_COMPONENTS_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_triangle_components_options
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t root;    
  double max_normal_angle; 
  int32_t include_opposite_normals; 
} occtl_mesh_triangle_components_options_t;
 
#define OCCTL_MESH_TRIANGLE_COMPONENTS_OPTIONS_INIT                                                \
  {OCCTL_MESH_TRIANGLE_COMPONENTS_OPTIONS_VERSION_1,                                               \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_ANGLE_1_DEG_RAD,                                                                          \
   1}
 
typedef struct occtl_mesh_triangle_components_view
{
  const uint32_t*
         triangle_component_ids;   
  size_t triangle_count;           
  const uint32_t* component_sizes; 
  size_t          component_count; 
  occtl_node_id_t root; 
} occtl_mesh_triangle_components_view_t;
 
typedef struct occtl_mesh_triangle_component_triangles_view
{
  const uint32_t* triangles; 
  size_t          triangle_count; 
  uint32_t        component_id;   
  occtl_node_id_t root; 
} occtl_mesh_triangle_component_triangles_view_t;
 
typedef struct occtl_mesh_triangle_component_boundary_edge
{
  uint32_t triangle;          
  uint32_t local_edge;        
  uint32_t node0;             
  uint32_t node1;             
  uint32_t adjacent_triangle; 
} occtl_mesh_triangle_component_boundary_edge_t;
 
typedef struct occtl_mesh_triangle_component_boundary_chain
{
  uint32_t first_edge; 
  uint32_t edge_count; 
  int32_t  is_closed;  
} occtl_mesh_triangle_component_boundary_chain_t;
 
typedef struct occtl_mesh_component_boundary_polyline
{
  uint32_t first_point; 
  uint32_t point_count; 
  int32_t  is_closed;   
} occtl_mesh_component_boundary_polyline_t;
 
typedef struct occtl_mesh_triangle_component_boundary_view
{
  const occtl_mesh_triangle_component_boundary_edge_t*
                  edges;        
  size_t          edge_count;   
  uint32_t        component_id; 
  occtl_node_id_t root; 
} occtl_mesh_triangle_component_boundary_view_t;
 
typedef struct occtl_mesh_triangle_component_boundary_chains_view
{
  const occtl_mesh_triangle_component_boundary_edge_t*
         edges;      
  size_t edge_count; 
  const occtl_mesh_triangle_component_boundary_chain_t*
                  chains;       
  size_t          chain_count;  
  uint32_t        component_id; 
  occtl_node_id_t root; 
} occtl_mesh_triangle_component_boundary_chains_view_t;
 
typedef struct occtl_mesh_component_boundary_polylines_view
{
  const occtl_point3_t* points;      
  size_t                point_count; 
  const occtl_mesh_component_boundary_polyline_t*
                  polylines;      
  size_t          polyline_count; 
  uint32_t        component_id;   
  occtl_node_id_t root; 
} occtl_mesh_component_boundary_polylines_view_t;
 
typedef struct occtl_mesh_triangle_component_summary
{
  uint32_t        component_id;   
  uint32_t        triangle_count; 
  double          area;           
  occtl_point3_t  centroid;       
  occtl_vector3_t normal; 
  occtl_aabb3_t   bounds; 
} occtl_mesh_triangle_component_summary_t;
 
typedef struct occtl_mesh_triangle_component_summaries_view
{
  const occtl_mesh_triangle_component_summary_t*
                  summaries;       
  size_t          component_count; 
  size_t          triangle_count;  
  occtl_node_id_t root; 
} occtl_mesh_triangle_component_summaries_view_t;
 
#define OCCTL_MESH_TRIANGLE_PLANE_COMPONENTS_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_triangle_plane_components_options
{
  uint32_t struct_version; 
  const void*     p_next;  
  occtl_node_id_t root;    
  double max_normal_angle; 
  int32_t  include_opposite_normals; 
  double   max_distance;       
  double   min_area;           
  uint32_t min_triangle_count; 
} occtl_mesh_triangle_plane_components_options_t;
 
#define OCCTL_MESH_TRIANGLE_PLANE_COMPONENTS_OPTIONS_INIT                                          \
  {OCCTL_MESH_TRIANGLE_PLANE_COMPONENTS_OPTIONS_VERSION_1,                                         \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_ANGLE_1_DEG_RAD,                                                                          \
   1,                                                                                              \
   1.0e-6,                                                                                         \
   0.0,                                                                                            \
   1u}
 
typedef struct occtl_mesh_triangle_plane_component
{
  uint32_t        component_id;   
  uint32_t        triangle_count; 
  double          area;           
  occtl_point3_t  origin;         
  occtl_vector3_t normal;         
  occtl_aabb3_t   bounds;         
  double          max_distance;   
} occtl_mesh_triangle_plane_component_t;
 
typedef struct occtl_mesh_triangle_plane_components_view
{
  const occtl_mesh_triangle_plane_component_t*
                  components;      
  size_t          component_count; 
  size_t          triangle_count;  
  occtl_node_id_t root; 
} occtl_mesh_triangle_plane_components_view_t;
 
#define OCCTL_MESH_TRIANGLE_SPHERE_COMPONENTS_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_triangle_sphere_components_options
{
  uint32_t struct_version; 
  const void*     p_next;  
  occtl_node_id_t root;    
  double max_normal_angle; 
  int32_t  include_opposite_normals; 
  double   max_distance;             
  double   min_area;                 
  uint32_t min_triangle_count;       
  double   min_radius;               
} occtl_mesh_triangle_sphere_components_options_t;
 
#define OCCTL_MESH_TRIANGLE_SPHERE_COMPONENTS_OPTIONS_INIT                                         \
  {OCCTL_MESH_TRIANGLE_SPHERE_COMPONENTS_OPTIONS_VERSION_1,                                        \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_ANGLE_30_DEG_RAD,                                                                         \
   1,                                                                                              \
   1.0e-3,                                                                                         \
   0.0,                                                                                            \
   4u,                                                                                             \
   1.0e-9}
 
typedef struct occtl_mesh_triangle_sphere_component
{
  uint32_t       component_id;   
  uint32_t       triangle_count; 
  double         area;           
  occtl_point3_t center;         
  double         radius;         
  occtl_aabb3_t  bounds;         
  double         max_distance;   
} occtl_mesh_triangle_sphere_component_t;
 
typedef struct occtl_mesh_triangle_sphere_components_view
{
  const occtl_mesh_triangle_sphere_component_t*
                  components;      
  size_t          component_count; 
  size_t          triangle_count;  
  occtl_node_id_t root; 
} occtl_mesh_triangle_sphere_components_view_t;
 
#define OCCTL_MESH_TRIANGLE_CYLINDER_COMPONENTS_OPTIONS_VERSION_1 1u
 
typedef struct occtl_mesh_triangle_cylinder_components_options
{
  uint32_t
    struct_version; 
  const void*     p_next;  
  occtl_node_id_t root;    
  double max_normal_angle; 
  int32_t  include_opposite_normals; 
  double   max_distance;             
  double   min_area;                 
  uint32_t min_triangle_count;       
  double   min_radius;               
} occtl_mesh_triangle_cylinder_components_options_t;
 
#define OCCTL_MESH_TRIANGLE_CYLINDER_COMPONENTS_OPTIONS_INIT                                       \
  {OCCTL_MESH_TRIANGLE_CYLINDER_COMPONENTS_OPTIONS_VERSION_1,                                      \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_ANGLE_30_DEG_RAD,                                                                         \
   1,                                                                                              \
   1.0e-3,                                                                                         \
   0.0,                                                                                            \
   4u,                                                                                             \
   1.0e-9}
 
typedef struct occtl_mesh_triangle_cylinder_component
{
  uint32_t        component_id;   
  uint32_t        triangle_count; 
  double          area;           
  occtl_point3_t  axis_origin;    
  occtl_vector3_t axis_direction; 
  double          radius;         
  double          height_min;     
  double          height_max;     
  occtl_aabb3_t   bounds;         
  double          max_distance;   
} occtl_mesh_triangle_cylinder_component_t;
 
typedef struct occtl_mesh_triangle_cylinder_components_view
{
  const occtl_mesh_triangle_cylinder_component_t*
                  components;      
  size_t          component_count; 
  size_t          triangle_count;  
  occtl_node_id_t root; 
} occtl_mesh_triangle_cylinder_components_view_t;
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_buffers(const occtl_graph_t*                graph,
                              occtl_node_id_t                     root,
                              occtl_mesh_triangle_buffers_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_analysis(const occtl_graph_t*                 graph,
                               occtl_node_id_t                      root,
                               occtl_mesh_triangle_analysis_view_t* out_view);
 
OCCTL_API void OCCTL_CALL
  occtl_mesh_triangle_components_options_init(occtl_mesh_triangle_components_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_components(const occtl_graph_t*                            graph,
                                 const occtl_mesh_triangle_components_options_t* options,
                                 occtl_mesh_triangle_components_view_t*          out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_component_triangles(const occtl_graph_t*                            graph,
                                          const occtl_mesh_triangle_components_options_t* options,
                                          uint32_t component_id,
                                          occtl_mesh_triangle_component_triangles_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_component_boundary(const occtl_graph_t*                            graph,
                                         const occtl_mesh_triangle_components_options_t* options,
                                         uint32_t component_id,
                                         occtl_mesh_triangle_component_boundary_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_triangle_component_boundary_chains(
  const occtl_graph_t*                                  graph,
  const occtl_mesh_triangle_components_options_t*       options,
  uint32_t                                              component_id,
  occtl_mesh_triangle_component_boundary_chains_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_component_boundary_polylines(const occtl_graph_t*                            graph,
                                          const occtl_mesh_triangle_components_options_t* options,
                                          uint32_t component_id,
                                          occtl_mesh_component_boundary_polylines_view_t* out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_mesh_triangle_component_summaries(const occtl_graph_t*                            graph,
                                          const occtl_mesh_triangle_components_options_t* options,
                                          occtl_mesh_triangle_component_summaries_view_t* out_view);
 
OCCTL_API void OCCTL_CALL occtl_mesh_triangle_plane_components_options_init(
  occtl_mesh_triangle_plane_components_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_triangle_plane_components(
  const occtl_graph_t*                                  graph,
  const occtl_mesh_triangle_plane_components_options_t* options,
  occtl_mesh_triangle_plane_components_view_t*          out_view);
 
OCCTL_API void OCCTL_CALL occtl_mesh_triangle_sphere_components_options_init(
  occtl_mesh_triangle_sphere_components_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_triangle_sphere_components(
  const occtl_graph_t*                                   graph,
  const occtl_mesh_triangle_sphere_components_options_t* options,
  occtl_mesh_triangle_sphere_components_view_t*          out_view);
 
OCCTL_API void OCCTL_CALL occtl_mesh_triangle_cylinder_components_options_init(
  occtl_mesh_triangle_cylinder_components_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_triangle_cylinder_components(
  const occtl_graph_t*                                     graph,
  const occtl_mesh_triangle_cylinder_components_options_t* options,
  occtl_mesh_triangle_cylinder_components_view_t*          out_view);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_sphere_component_solid(
  occtl_graph_t*                                         graph,
  const occtl_mesh_triangle_sphere_components_options_t* options,
  uint32_t                                               component_id,
  occtl_node_id_t*                                       out_solid);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_cylinder_component_solid(
  occtl_graph_t*                                           graph,
  const occtl_mesh_triangle_cylinder_components_options_t* options,
  uint32_t                                                 component_id,
  occtl_node_id_t*                                         out_solid);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_sphere_component_solids(
  occtl_graph_t*                                         graph,
  const occtl_mesh_triangle_sphere_components_options_t* options,
  occtl_node_id_t*                                       out_buf,
  size_t                                                 cap,
  size_t*                                                out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_cylinder_component_solids(
  occtl_graph_t*                                           graph,
  const occtl_mesh_triangle_cylinder_components_options_t* options,
  occtl_node_id_t*                                         out_buf,
  size_t                                                   cap,
  size_t*                                                  out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_plane_component_face(
  occtl_graph_t*                                        graph,
  const occtl_mesh_triangle_plane_components_options_t* options,
  uint32_t                                              component_id,
  occtl_node_id_t*                                      out_face);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_mesh_make_plane_component_faces(
  occtl_graph_t*                                        graph,
  const occtl_mesh_triangle_plane_components_options_t* options,
  occtl_node_id_t*                                      out_buf,
  size_t                                                cap,
  size_t*                                               out_count);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_MESH_H */