occtl_topo_relation.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_TOPO_RELATION_H
#define OCCTL_TOPO_RELATION_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_geom.h"
#include "occtl_topo_types.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum occtl_shape_continuity
{
  OCCTL_CONTINUITY_C0              = 0, 
  OCCTL_CONTINUITY_C1              = 1, 
  OCCTL_CONTINUITY_C2              = 2, 
  OCCTL_CONTINUITY_C3              = 3, 
  OCCTL_CONTINUITY_CN              = 4, 
  OCCTL_CONTINUITY_G1              = 5, 
  OCCTL_CONTINUITY_G2              = 6, 
  OCCTL_CONTINUITY_RESERVED_FUTURE = 0x7fffffff
} occtl_shape_continuity_t;
 
typedef enum occtl_orientation
{
  OCCTL_ORIENTATION_FORWARD         = 0, 
  OCCTL_ORIENTATION_REVERSED        = 1, 
  OCCTL_ORIENTATION_INTERNAL        = 2, 
  OCCTL_ORIENTATION_EXTERNAL        = 3, 
  OCCTL_ORIENTATION_RESERVED_FUTURE = 0x7fffffff
} occtl_orientation_t;
 
typedef struct occtl_oriented_node
{
  occtl_node_id_t     id;          
  occtl_orientation_t orientation; 
} occtl_oriented_node_t;
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_wire_order_edges(const occtl_graph_t*   graph,
                                                                occtl_node_id_t        wire,
                                                                occtl_oriented_node_t* out_buf,
                                                                size_t                 cap,
                                                                size_t*                out_count);
 
typedef struct occtl_topo_explorer_iter occtl_topo_explorer_iter_t;
 
typedef enum occtl_topo_explorer_traversal
{
  OCCTL_TOPO_EXPLORER_RECURSIVE                 = 0, 
  OCCTL_TOPO_EXPLORER_DIRECT_CHILDREN           = 1, 
  OCCTL_TOPO_EXPLORER_TRAVERSAL_RESERVED_FUTURE = 0x7fffffff
} occtl_topo_explorer_traversal_t;
 
#define OCCTL_TOPO_CHILD_EXPLORER_CONFIG_VERSION_1 1u
 
typedef struct occtl_topo_child_explorer_config
{
  uint32_t    struct_version;           
  const void* p_next;                   
  occtl_topo_explorer_traversal_t mode; 
  occtl_node_kind_t
    target_kind; 
  occtl_node_kind_t
          avoid_kind;      
  int32_t emit_avoid_kind; 
  int32_t
    accumulate_location; 
  int32_t accumulate_orientation; 
} occtl_topo_child_explorer_config_t;
 
#define OCCTL_TOPO_CHILD_EXPLORER_CONFIG_INIT                                                      \
  {OCCTL_TOPO_CHILD_EXPLORER_CONFIG_VERSION_1,                                                     \
   NULL,                                                                                           \
   OCCTL_TOPO_EXPLORER_RECURSIVE,                                                                  \
   OCCTL_KIND_INVALID,                                                                             \
   OCCTL_KIND_INVALID,                                                                             \
   0,                                                                                              \
   1,                                                                                              \
   1}
 
OCCTL_API void OCCTL_CALL
  occtl_topo_child_explorer_config_init(occtl_topo_child_explorer_config_t* config);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_child_explorer_create(const occtl_graph_t*                      graph,
                                   occtl_node_id_t                           root,
                                   const occtl_topo_child_explorer_config_t* config,
                                   occtl_topo_explorer_iter_t**              out_iter);
 
#define OCCTL_TOPO_PARENT_EXPLORER_CONFIG_VERSION_1 1u
 
typedef struct occtl_topo_parent_explorer_config
{
  uint32_t    struct_version; 
  const void* p_next;         
  occtl_topo_explorer_traversal_t mode; 
  occtl_node_kind_t
    target_kind; 
  occtl_node_kind_t
          avoid_kind;      
  int32_t emit_avoid_kind; 
} occtl_topo_parent_explorer_config_t;
 
#define OCCTL_TOPO_PARENT_EXPLORER_CONFIG_INIT                                                     \
  {OCCTL_TOPO_PARENT_EXPLORER_CONFIG_VERSION_1,                                                    \
   NULL,                                                                                           \
   OCCTL_TOPO_EXPLORER_RECURSIVE,                                                                  \
   OCCTL_KIND_INVALID,                                                                             \
   OCCTL_KIND_INVALID,                                                                             \
   0}
 
OCCTL_API void OCCTL_CALL
  occtl_topo_parent_explorer_config_init(occtl_topo_parent_explorer_config_t* config);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_parent_explorer_create(const occtl_graph_t*                       graph,
                                    occtl_node_id_t                            node,
                                    const occtl_topo_parent_explorer_config_t* config,
                                    occtl_topo_explorer_iter_t**               out_iter);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_explorer_iter_next(occtl_topo_explorer_iter_t* iter,
                                occtl_node_id_t*            out_node,
                                occtl_transform_t*          out_transform,
                                occtl_orientation_t*        out_orientation);
 
OCCTL_API void OCCTL_CALL occtl_topo_explorer_iter_free(occtl_topo_explorer_iter_t* iter);
 
typedef struct occtl_topo_related_iter occtl_topo_related_iter_t;
 
typedef struct occtl_topo_axis_hit_iter occtl_topo_axis_hit_iter_t;
 
#define OCCTL_TOPO_RELATION_OPTIONS_VERSION_1 1u
 
typedef struct occtl_topo_relation_options
{
  uint32_t    struct_version;           
  const void* p_next;                   
  double      tolerance;                
  int32_t     include_tangent_contacts; 
  int32_t     include_overlaps;         
  int32_t     include_lower_dimension_results; 
} occtl_topo_relation_options_t;
 
#define OCCTL_TOPO_RELATION_OPTIONS_INIT                                                           \
  {OCCTL_TOPO_RELATION_OPTIONS_VERSION_1, NULL, 1.0e-7, 1, 1, 1}
 
OCCTL_API void OCCTL_CALL occtl_topo_relation_options_init(occtl_topo_relation_options_t* options);
 
typedef struct occtl_topo_touch_iter occtl_topo_touch_iter_t;
 
typedef struct occtl_topo_intersection_iter occtl_topo_intersection_iter_t;
 
typedef enum occtl_relation_kind
{
  OCCTL_RELATION_BOUNDARY_EDGE        = 0, 
  OCCTL_RELATION_ADJACENT_FACE        = 1, 
  OCCTL_RELATION_OUTER_WIRE           = 2, 
  OCCTL_RELATION_REFERENCED_BY        = 3, 
  OCCTL_RELATION_INCIDENT_VERTEX      = 4, 
  OCCTL_RELATION_WIRE_COEDGE          = 5, 
  OCCTL_RELATION_OWNING_FACE          = 6, 
  OCCTL_RELATION_INCIDENT_EDGE        = 7, 
  OCCTL_RELATION_PARENT_EDGE          = 8, 
  OCCTL_RELATION_SEAM_PAIR            = 9, 
  OCCTL_RELATION_KIND_RESERVED_FUTURE = 0x7fffffff
} occtl_relation_kind_t;
 
typedef enum occtl_topo_point_class
{
  OCCTL_TOPO_POINT_CLASS_IN              = 0, 
  OCCTL_TOPO_POINT_CLASS_OUT             = 1, 
  OCCTL_TOPO_POINT_CLASS_ON              = 2, 
  OCCTL_TOPO_POINT_CLASS_UNKNOWN         = 3, 
  OCCTL_TOPO_POINT_CLASS_RESERVED_FUTURE = 0x7fffffff
} occtl_topo_point_class_t;
 
typedef struct occtl_topo_distance_pair
{
  double          distance;       
  occtl_point3_t  point_a;        
  occtl_point3_t  point_b;        
  occtl_node_id_t support_a;      
  occtl_node_id_t support_b;      
  int32_t         inner_solution; 
  int32_t         solution_count; 
} occtl_topo_distance_pair_t;
 
typedef struct occtl_topo_axis_hit
{
  occtl_node_id_t          face;      
  occtl_point3_t           point;     
  occtl_point2_t           uv;        
  double                   parameter; 
  occtl_direction3_t       normal;    
  int32_t                  has_normal; 
  occtl_topo_point_class_t location;   
} occtl_topo_axis_hit_t;
 
typedef struct occtl_topo_touch_hit
{
  occtl_node_id_t node_a;         
  occtl_node_id_t node_b;         
  occtl_node_id_t support_a;      
  occtl_node_id_t support_b;      
  occtl_point3_t  point_a;        
  occtl_point3_t  point_b;        
  double          distance;       
  int32_t         inner_solution; 
} occtl_topo_touch_hit_t;
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_related_iter_create(const occtl_graph_t*        graph,
                                 occtl_node_id_t             node,
                                 occtl_topo_related_iter_t** out_iter);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_distance_pair(const occtl_graph_t*        graph,
                                                             occtl_node_id_t             node_a,
                                                             occtl_node_id_t             node_b,
                                                             occtl_topo_distance_pair_t* out_pair);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_closest_point_to_point(const occtl_graph_t* graph,
                                                                      occtl_node_id_t      node,
                                                                      occtl_point3_t       point,
                                                                      occtl_point3_t* out_closest,
                                                                      double*         out_distance);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_axis_intersect_faces(const occtl_graph_t*         graph,
                                  occtl_node_id_t              root,
                                  occtl_axis1_placement_t      axis,
                                  double                       min_parameter,
                                  double                       max_parameter,
                                  double                       tolerance,
                                  occtl_topo_axis_hit_iter_t** out_iter);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_touch_iter_create(const occtl_graph_t*                 graph,
                               occtl_node_id_t                      node_a,
                               occtl_node_id_t                      node_b,
                               const occtl_topo_relation_options_t* options,
                               occtl_topo_touch_iter_t**            out_iter);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_intersection_iter_create(occtl_graph_t*                       graph,
                                      occtl_node_id_t                      node_a,
                                      occtl_node_id_t                      node_b,
                                      const occtl_topo_relation_options_t* options,
                                      occtl_topo_intersection_iter_t**     out_iter);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_is_same_geometry(const occtl_graph_t* graph,
                                                                occtl_node_id_t      node_a,
                                                                occtl_node_id_t      node_b,
                                                                double               tolerance,
                                                                int32_t* out_is_same_geometry);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_common_vertices(const occtl_graph_t* graph,
                                                               occtl_node_id_t      node_a,
                                                               occtl_node_id_t      node_b,
                                                               occtl_node_id_t*     out_buf,
                                                               size_t               cap,
                                                               size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_adjacent_edges(const occtl_graph_t* graph,
                                                              occtl_node_id_t      edge,
                                                              occtl_node_id_t*     out_buf,
                                                              size_t               cap,
                                                              size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_adjacent_faces(const occtl_graph_t* graph,
                                                              occtl_node_id_t      face,
                                                              occtl_node_id_t*     out_buf,
                                                              size_t               cap,
                                                              size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_connected_edges(const occtl_graph_t* graph,
                                                               occtl_node_id_t      seed_edge,
                                                               occtl_node_id_t*     out_buf,
                                                               size_t               cap,
                                                               size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_connected_faces(const occtl_graph_t* graph,
                                                               occtl_node_id_t      seed_face,
                                                               occtl_node_id_t*     out_buf,
                                                               size_t               cap,
                                                               size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_graph_distance(const occtl_graph_t*   graph,
                                                              occtl_node_id_t        root,
                                                              const occtl_node_id_t* sources,
                                                              size_t                 source_count,
                                                              occtl_node_id_t        target,
                                                              int32_t*               out_distance);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_classify_point(const occtl_graph_t*      graph,
                                                              occtl_node_id_t           solid,
                                                              occtl_point3_t            point,
                                                              double                    tolerance,
                                                              occtl_topo_point_class_t* out_class);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_is_inside(const occtl_graph_t* graph,
                                                         occtl_node_id_t      solid,
                                                         occtl_point3_t       point,
                                                         double               tolerance,
                                                         int32_t              include_boundary,
                                                         int32_t*             out_is_inside);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_axis_hit_iter_next(occtl_topo_axis_hit_iter_t* iter,
                                                                  occtl_topo_axis_hit_t* out_hit);
 
OCCTL_API void OCCTL_CALL occtl_topo_axis_hit_iter_free(occtl_topo_axis_hit_iter_t* iter);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_touch_iter_next(occtl_topo_touch_iter_t* iter,
                                                               occtl_topo_touch_hit_t*  out_hit);
 
OCCTL_API void OCCTL_CALL occtl_topo_touch_iter_free(occtl_topo_touch_iter_t* iter);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_topo_intersection_iter_next(occtl_topo_intersection_iter_t* iter,
                                    occtl_node_id_t*                out_node);
 
OCCTL_API void OCCTL_CALL occtl_topo_intersection_iter_free(occtl_topo_intersection_iter_t* iter);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_topo_related_iter_next(occtl_topo_related_iter_t* iter,
                                                                 occtl_node_id_t*       out_node,
                                                                 occtl_relation_kind_t* out_kind);
 
OCCTL_API void OCCTL_CALL occtl_topo_related_iter_free(occtl_topo_related_iter_t* iter);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_TOPO_RELATION_H */