occtl_prim_sketch.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_PRIM_SKETCH_H
#define OCCTL_PRIM_SKETCH_H
 
#include "occtl_core.h"
#include "occtl_curves2d.h"
#include "occtl_geom.h"
#include "occtl_surfaces.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define OCCTL_PRIM_POLYLINE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_polyline_info
{
  uint32_t              struct_version; 
  const void*           p_next;         
  const occtl_point3_t* points; 
  size_t                point_count; 
  int32_t closed; 
} occtl_prim_polyline_info_t;
 
#define OCCTL_PRIM_POLYLINE_INFO_INIT {OCCTL_PRIM_POLYLINE_INFO_VERSION_1, NULL, NULL, 0, 0}
 
OCCTL_API void OCCTL_CALL occtl_prim_polyline_info_init(occtl_prim_polyline_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_polyline(occtl_graph_t* graph,
                                                             const occtl_prim_polyline_info_t* info,
                                                             occtl_node_id_t* out_wire);
 
#define OCCTL_PRIM_REGULAR_POLYGON_INFO_VERSION_1 1u
 
typedef struct occtl_prim_regular_polygon_info
{
  uint32_t    struct_version;        
  const void* p_next;                
  occtl_axis2_placement_t placement; 
  double  circumradius;              
  int32_t sides;                     
  double  rotation;                  
} occtl_prim_regular_polygon_info_t;
 
#define OCCTL_PRIM_REGULAR_POLYGON_INFO_INIT                                                       \
  {OCCTL_PRIM_REGULAR_POLYGON_INFO_VERSION_1,                                                      \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   3,                                                                                              \
   0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_regular_polygon_info_init(occtl_prim_regular_polygon_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_regular_polygon(occtl_graph_t*                           graph,
                                  const occtl_prim_regular_polygon_info_t* info,
                                  occtl_node_id_t*                         out_wire);
 
#define OCCTL_PRIM_RECTANGLE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_rectangle_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  width;  
  double                  height; 
} occtl_prim_rectangle_info_t;
 
#define OCCTL_PRIM_RECTANGLE_INFO_INIT                                                             \
  {OCCTL_PRIM_RECTANGLE_INFO_VERSION_1,                                                            \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_rectangle_info_init(occtl_prim_rectangle_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_rectangle(occtl_graph_t*                     graph,
                            const occtl_prim_rectangle_info_t* info,
                            occtl_node_id_t*                   out_wire);
 
#define OCCTL_PRIM_CIRCLE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_circle_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
} occtl_prim_circle_info_t;
 
#define OCCTL_PRIM_CIRCLE_INFO_INIT                                                                \
  {OCCTL_PRIM_CIRCLE_INFO_VERSION_1, NULL, {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}}, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_circle_info_init(occtl_prim_circle_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_circle(occtl_graph_t*                  graph,
                                                           const occtl_prim_circle_info_t* info,
                                                           occtl_node_id_t* out_wire);
 
#define OCCTL_PRIM_ELLIPSE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_ellipse_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  major; 
  double                  minor; 
} occtl_prim_ellipse_info_t;
 
#define OCCTL_PRIM_ELLIPSE_INFO_INIT                                                               \
  {OCCTL_PRIM_ELLIPSE_INFO_VERSION_1,                                                              \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_ellipse_info_init(occtl_prim_ellipse_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_ellipse(occtl_graph_t*                   graph,
                                                            const occtl_prim_ellipse_info_t* info,
                                                            occtl_node_id_t* out_wire);
 
#define OCCTL_PRIM_PLANAR_FACE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_planar_face_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t outer_wire;     
  const occtl_node_id_t*
         inner_wires;      
  size_t inner_wire_count; 
} occtl_prim_planar_face_info_t;
 
#define OCCTL_PRIM_PLANAR_FACE_INFO_INIT                                                           \
  {OCCTL_PRIM_PLANAR_FACE_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, NULL, 0}
 
OCCTL_API void OCCTL_CALL occtl_prim_planar_face_info_init(occtl_prim_planar_face_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_planar_face(occtl_graph_t*                       graph,
                              const occtl_prim_planar_face_info_t* info,
                              occtl_node_id_t*                     out_face);
 
#define OCCTL_PRIM_CONVEX_HULL_2D_INFO_VERSION_1 1u
 
typedef struct occtl_prim_convex_hull_2d_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  const occtl_point3_t*   points;         
  size_t                  point_count;    
  const occtl_node_id_t*  vertices;       
  size_t                  vertex_count;   
  double                  tolerance;      
  int32_t                 make_face; 
} occtl_prim_convex_hull_2d_info_t;
 
#define OCCTL_PRIM_CONVEX_HULL_2D_INFO_INIT                                                        \
  {OCCTL_PRIM_CONVEX_HULL_2D_INFO_VERSION_1,                                                       \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   NULL,                                                                                           \
   0u,                                                                                             \
   NULL,                                                                                           \
   0u,                                                                                             \
   1.0e-7,                                                                                         \
   0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_convex_hull_2d_info_init(occtl_prim_convex_hull_2d_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_convex_hull_2d(occtl_graph_t*                          graph,
                                 const occtl_prim_convex_hull_2d_info_t* info,
                                 occtl_node_id_t*                        out_node);
 
#define OCCTL_PRIM_TRACE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_trace_info
{
  uint32_t                         struct_version; 
  const void*                      p_next;         
  occtl_node_id_t                  path;           
  double                           width;          
  occtl_direction3_t               normal; 
  occtl_topo_wire_offset_2d_join_t join;   
  int32_t approximate;                     
} occtl_prim_trace_info_t;
 
#define OCCTL_PRIM_TRACE_INFO_INIT                                                                 \
  {OCCTL_PRIM_TRACE_INFO_VERSION_1,                                                                \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   1.0,                                                                                            \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_TOPO_WIRE_OFFSET_2D_JOIN_ARC,                                                             \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_trace_info_init(occtl_prim_trace_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_trace(occtl_graph_t*                 graph,
                                                          const occtl_prim_trace_info_t* info,
                                                          occtl_node_id_t*               out_face);
 
#define OCCTL_PRIM_CONSTRAINED_EDGE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_constrained_edge_info
{
  uint32_t       struct_version;     
  const void*    p_next;             
  occtl_rep_id_t curve;              
  occtl_axis2_placement_t placement; 
  int32_t use_parameter_range;       
  double  first_parameter;           
  double  last_parameter;            
} occtl_prim_constrained_edge_info_t;
 
#define OCCTL_PRIM_CONSTRAINED_EDGE_INFO_INIT                                                      \
  {OCCTL_PRIM_CONSTRAINED_EDGE_INFO_VERSION_1,                                                     \
   NULL,                                                                                           \
   OCCTL_REP_ID_INVALID,                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0,                                                                                              \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_constrained_edge_info_init(occtl_prim_constrained_edge_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_constrained_edge(occtl_graph_t*                            graph,
                                   const occtl_prim_constrained_edge_info_t* info,
                                   occtl_node_id_t*                          out_edge);
 
#define OCCTL_PRIM_ARC_3PT_INFO_VERSION_1 1u
 
typedef struct occtl_prim_arc_3pt_info
{
  uint32_t       struct_version; 
  const void*    p_next;         
  occtl_point3_t start;          
  occtl_point3_t via;            
  occtl_point3_t end;            
} occtl_prim_arc_3pt_info_t;
 
#define OCCTL_PRIM_ARC_3PT_INFO_INIT                                                               \
  {OCCTL_PRIM_ARC_3PT_INFO_VERSION_1, NULL, {0.0, 0.0, 0.0}, {0.0, 0.0, 0.0}, {0.0, 0.0, 0.0}}
 
OCCTL_API void OCCTL_CALL occtl_prim_arc_3pt_info_init(occtl_prim_arc_3pt_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_arc_3pt(occtl_graph_t*                   graph,
                                                            const occtl_prim_arc_3pt_info_t* info,
                                                            occtl_node_id_t* out_wire);
 
#define OCCTL_PRIM_ARC_CENTER_INFO_VERSION_1 1u
 
typedef struct occtl_prim_arc_center_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
  double                  start_angle;    
  double                  end_angle;      
} occtl_prim_arc_center_info_t;
 
#define OCCTL_PRIM_ARC_CENTER_INFO_INIT                                                            \
  {OCCTL_PRIM_ARC_CENTER_INFO_VERSION_1,                                                           \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_arc_center_info_init(occtl_prim_arc_center_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_arc_center(occtl_graph_t*                      graph,
                             const occtl_prim_arc_center_info_t* info,
                             occtl_node_id_t*                    out_wire);
 
#define OCCTL_PRIM_SPLINE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_spline_info
{
  uint32_t              struct_version; 
  const void*           p_next;         
  const occtl_point3_t* points;         
  size_t                point_count;    
  int32_t               degree_min;     
  int32_t               degree_max;     
  double                tolerance; 
} occtl_prim_spline_info_t;
 
#define OCCTL_PRIM_SPLINE_INFO_INIT {OCCTL_PRIM_SPLINE_INFO_VERSION_1, NULL, NULL, 0, 3, 8, 1.0e-3}
 
OCCTL_API void OCCTL_CALL occtl_prim_spline_info_init(occtl_prim_spline_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_spline(occtl_graph_t*                  graph,
                                                           const occtl_prim_spline_info_t* info,
                                                           occtl_node_id_t* out_wire);
 
#define OCCTL_PRIM_PLANE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_plane_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  width;          
  double                  height;         
} occtl_prim_plane_info_t;
 
#define OCCTL_PRIM_PLANE_INFO_INIT                                                                 \
  {OCCTL_PRIM_PLANE_INFO_VERSION_1,                                                                \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_plane_info_init(occtl_prim_plane_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_plane(occtl_graph_t*                 graph,
                                                          const occtl_prim_plane_info_t* info,
                                                          occtl_node_id_t*               out_face);
 
#define OCCTL_PRIM_DISK_INFO_VERSION_1 1u
 
typedef struct occtl_prim_disk_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
} occtl_prim_disk_info_t;
 
#define OCCTL_PRIM_DISK_INFO_INIT                                                                  \
  {OCCTL_PRIM_DISK_INFO_VERSION_1, NULL, {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}}, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_disk_info_init(occtl_prim_disk_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_disk(occtl_graph_t*                graph,
                                                         const occtl_prim_disk_info_t* info,
                                                         occtl_node_id_t*              out_face);
 
#define OCCTL_PRIM_SLOT_INFO_VERSION_1 1u
 
typedef struct occtl_prim_slot_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  length;         
  double                  width;          
} occtl_prim_slot_info_t;
 
#define OCCTL_PRIM_SLOT_INFO_INIT                                                                  \
  {OCCTL_PRIM_SLOT_INFO_VERSION_1,                                                                 \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_slot_info_init(occtl_prim_slot_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_slot(occtl_graph_t*                graph,
                                                         const occtl_prim_slot_info_t* info,
                                                         occtl_node_id_t*              out_wire);
 
#define OCCTL_PRIM_TUBE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_tube_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  outer_radius;   
  double                  inner_radius;   
  double                  height;         
} occtl_prim_tube_info_t;
 
#define OCCTL_PRIM_TUBE_INFO_INIT                                                                  \
  {OCCTL_PRIM_TUBE_INFO_VERSION_1,                                                                 \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0,                                                                                            \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_tube_info_init(occtl_prim_tube_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_tube(occtl_graph_t*                graph,
                                                         const occtl_prim_tube_info_t* info,
                                                         occtl_node_id_t*              out_solid);
 
#define OCCTL_PRIM_HELIX_INFO_VERSION_1 1u
 
typedef struct occtl_prim_helix_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
  double                  pitch;          
  double                  height;         
  int32_t left_handed; 
} occtl_prim_helix_info_t;
 
#define OCCTL_PRIM_HELIX_INFO_INIT                                                                 \
  {OCCTL_PRIM_HELIX_INFO_VERSION_1,                                                                \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   0.0,                                                                                            \
   0.0,                                                                                            \
   0.0,                                                                                            \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_helix_info_init(occtl_prim_helix_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_helix(occtl_graph_t*                 graph,
                                                          const occtl_prim_helix_info_t* info,
                                                          occtl_node_id_t*               out_wire);
 
#define OCCTL_PRIM_FILLET_2D_INFO_VERSION_1 1u
 
typedef struct occtl_prim_fillet_2d_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t face;           
  const occtl_node_id_t*
         vertices;     
  size_t vertex_count; 
  double radius;       
} occtl_prim_fillet_2d_info_t;
 
#define OCCTL_PRIM_FILLET_2D_INFO_INIT                                                             \
  {OCCTL_PRIM_FILLET_2D_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, NULL, 0, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_fillet_2d_info_init(occtl_prim_fillet_2d_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_fillet_2d(occtl_graph_t*                     graph,
                            const occtl_prim_fillet_2d_info_t* info,
                            occtl_node_id_t*                   out_face);
 
#define OCCTL_PRIM_FULL_ROUND_2D_INFO_VERSION_1 1u
 
typedef struct occtl_prim_full_round_2d_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t face;           
  occtl_node_id_t edge;           
  double          radius; 
  uint32_t search_steps;  
} occtl_prim_full_round_2d_info_t;
 
#define OCCTL_PRIM_FULL_ROUND_2D_INFO_INIT                                                         \
  {OCCTL_PRIM_FULL_ROUND_2D_INFO_VERSION_1,                                                        \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   0.0,                                                                                            \
   32u}
 
OCCTL_API void OCCTL_CALL occtl_prim_full_round_2d_info_init(occtl_prim_full_round_2d_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_full_round_2d(occtl_graph_t*                         graph,
                                const occtl_prim_full_round_2d_info_t* info,
                                occtl_node_id_t*                       out_face);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OCCTL_PRIM_SKETCH_H */