occtl_curves.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_CURVES_H
#define OCCTL_CURVES_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_curves_common.h"
#include "occtl_geom.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct occtl_graph occtl_graph_t;
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_line(occtl_graph_t*    graph,
                                                            occtl_geom_line_t line,
                                                            occtl_rep_id_t*   out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_circle(occtl_graph_t*      graph,
                                                              occtl_geom_circle_t circle,
                                                              occtl_rep_id_t*     out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_ellipse(occtl_graph_t*       graph,
                                                               occtl_geom_ellipse_t ellipse,
                                                               occtl_rep_id_t*      out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_hyperbola(occtl_graph_t*         graph,
                                                                 occtl_geom_hyperbola_t hyperbola,
                                                                 occtl_rep_id_t*        out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_parabola(occtl_graph_t*        graph,
                                                                occtl_geom_parabola_t parabola,
                                                                occtl_rep_id_t*       out_id);
 
typedef struct occtl_curve_bspline_create_info
{
  uint32_t              struct_version; 
  const void*           p_next;         
  const occtl_point3_t* poles;          
  size_t                pole_count;     
  const double*         weights;        
  const double*  knots; 
  const int32_t* multiplicities; 
  size_t         knot_count;     
  int32_t        degree;         
  int32_t        is_periodic;    
} occtl_curve_bspline_create_info_t;
 
#define OCCTL_CURVE_BSPLINE_CREATE_INFO_VERSION_1 1u
 
#define OCCTL_CURVE_BSPLINE_CREATE_INFO_INIT                                                       \
  {OCCTL_CURVE_BSPLINE_CREATE_INFO_VERSION_1, NULL, NULL, 0, NULL, NULL, NULL, 0, 0, 0}
 
OCCTL_API void OCCTL_CALL
  occtl_curve_bspline_create_info_init(occtl_curve_bspline_create_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_bspline(occtl_graph_t*                           graph,
                             const occtl_curve_bspline_create_info_t* info,
                             occtl_rep_id_t*                          out_id);
 
typedef struct occtl_curve_bezier_create_info
{
  uint32_t              struct_version; 
  const void*           p_next;         
  const occtl_point3_t* poles;          
  size_t                pole_count;     
  const double*         weights;        
} occtl_curve_bezier_create_info_t;
 
#define OCCTL_CURVE_BEZIER_CREATE_INFO_VERSION_1 1u
 
#define OCCTL_CURVE_BEZIER_CREATE_INFO_INIT                                                        \
  {OCCTL_CURVE_BEZIER_CREATE_INFO_VERSION_1, NULL, NULL, 0, NULL}
 
OCCTL_API void OCCTL_CALL
  occtl_curve_bezier_create_info_init(occtl_curve_bezier_create_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_bezier(occtl_graph_t*                          graph,
                            const occtl_curve_bezier_create_info_t* info,
                            occtl_rep_id_t*                         out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_trimmed(occtl_graph_t*                           graph,
                             const occtl_curve_trimmed_create_info_t* info,
                             occtl_rep_id_t*                          out_id);
 
typedef struct occtl_curve_offset_create_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_rep_id_t  basis;          
  occtl_vector3_t offset_dir;     
  double          offset;         
} occtl_curve_offset_create_info_t;
 
#define OCCTL_CURVE_OFFSET_CREATE_INFO_VERSION_1 1u
 
#define OCCTL_CURVE_OFFSET_CREATE_INFO_INIT                                                        \
  {OCCTL_CURVE_OFFSET_CREATE_INFO_VERSION_1, NULL, {0}, {0.0, 0.0, 1.0}, 0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_curve_offset_create_info_init(occtl_curve_offset_create_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_offset(occtl_graph_t*                          graph,
                            const occtl_curve_offset_create_info_t* info,
                            occtl_rep_id_t*                         out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_reverse(occtl_graph_t*  graph,
                                                        occtl_rep_id_t  curve_id,
                                                        occtl_rep_id_t* out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_transformed(occtl_graph_t*    graph,
                                                            occtl_rep_id_t    curve_id,
                                                            occtl_transform_t transform,
                                                            occtl_rep_id_t*   out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_translated(occtl_graph_t*  graph,
                                                           occtl_rep_id_t  curve_id,
                                                           occtl_vector3_t delta,
                                                           occtl_rep_id_t* out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_rotated(occtl_graph_t*          graph,
                                                        occtl_rep_id_t          curve_id,
                                                        occtl_axis1_placement_t axis,
                                                        double                  angle,
                                                        occtl_rep_id_t*         out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_scaled(occtl_graph_t*  graph,
                                                       occtl_rep_id_t  curve_id,
                                                       occtl_point3_t  origin,
                                                       double          factor,
                                                       occtl_rep_id_t* out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_length(const occtl_graph_t* graph,
                                                       occtl_rep_id_t       curve_id,
                                                       double*              out_length);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_project_point(const occtl_graph_t* graph,
                                                              occtl_rep_id_t       curve_id,
                                                              occtl_point3_t       point,
                                                              double*              out_param,
                                                              double*              out_distance);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_parameter_of_point(const occtl_graph_t* graph,
                                                                   occtl_rep_id_t       curve_id,
                                                                   occtl_point3_t       point,
                                                                   double*              out_param);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_kind(const occtl_graph_t* graph,
                                                     occtl_rep_id_t       curve_id,
                                                     occtl_curve_kind_t*  out_kind);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_is_periodic(const occtl_graph_t* graph,
                                                            occtl_rep_id_t       curve_id,
                                                            int32_t*             out_is_periodic);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_is_closed(const occtl_graph_t* graph,
                                                          occtl_rep_id_t       curve_id,
                                                          int32_t*             out_is_closed);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_continuity(const occtl_graph_t*     graph,
                                                           occtl_rep_id_t           curve_id,
                                                           occtl_geom_continuity_t* out_continuity);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_parameter_range(const occtl_graph_t* graph,
                                                                occtl_rep_id_t       curve_id,
                                                                double*              out_u_min,
                                                                double*              out_u_max);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_line(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        occtl_geom_line_t*   out_line);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_circle(const occtl_graph_t* graph,
                                                          occtl_rep_id_t       curve_id,
                                                          occtl_geom_circle_t* out_circle);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_ellipse(const occtl_graph_t*  graph,
                                                           occtl_rep_id_t        curve_id,
                                                           occtl_geom_ellipse_t* out_ellipse);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_hyperbola(const occtl_graph_t*    graph,
                                                             occtl_rep_id_t          curve_id,
                                                             occtl_geom_hyperbola_t* out_hyperbola);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_parabola(const occtl_graph_t*   graph,
                                                            occtl_rep_id_t         curve_id,
                                                            occtl_geom_parabola_t* out_parabola);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_trimmed(const occtl_graph_t* graph,
                                                           occtl_rep_id_t       curve_id,
                                                           double*              out_u_first,
                                                           double*              out_u_last);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_offset(const occtl_graph_t* graph,
                                                          occtl_rep_id_t       curve_id,
                                                          double*              out_offset,
                                                          occtl_vector3_t*     out_offset_dir);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_degree(const occtl_graph_t* graph,
                                                               occtl_rep_id_t       curve_id,
                                                               int32_t*             out_degree);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_pole_count(const occtl_graph_t* graph,
                                                                   occtl_rep_id_t       curve_id,
                                                                   size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_knot_count(const occtl_graph_t* graph,
                                                                   occtl_rep_id_t       curve_id,
                                                                   size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_is_rational(const occtl_graph_t* graph,
                                                                    occtl_rep_id_t       curve_id,
                                                                    int32_t* out_is_rational);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bezier_degree(const occtl_graph_t* graph,
                                                              occtl_rep_id_t       curve_id,
                                                              int32_t*             out_degree);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bezier_pole_count(const occtl_graph_t* graph,
                                                                  occtl_rep_id_t       curve_id,
                                                                  size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bezier_is_rational(const occtl_graph_t* graph,
                                                                   occtl_rep_id_t       curve_id,
                                                                   int32_t* out_is_rational);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_poles(const occtl_graph_t* graph,
                                                              occtl_rep_id_t       curve_id,
                                                              occtl_point3_t*      out_buf,
                                                              size_t               capacity,
                                                              size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_knots(const occtl_graph_t* graph,
                                                              occtl_rep_id_t       curve_id,
                                                              double*              out_buf,
                                                              size_t               capacity,
                                                              size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_multiplicities(const occtl_graph_t* graph,
                                                                       occtl_rep_id_t curve_id,
                                                                       int32_t*       out_buf,
                                                                       size_t         capacity,
                                                                       size_t*        out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_weights(const occtl_graph_t* graph,
                                                                occtl_rep_id_t       curve_id,
                                                                double*              out_buf,
                                                                size_t               capacity,
                                                                size_t*              out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_poles_view(const occtl_graph_t*   graph,
                                                                   occtl_rep_id_t         curve_id,
                                                                   const occtl_point3_t** out_data,
                                                                   size_t* out_count);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_bspline_flat_knots(const occtl_graph_t* graph,
                                                                   occtl_rep_id_t       curve_id,
                                                                   double*              out_buf,
                                                                   size_t               capacity,
                                                                   size_t*              out_count);
 
typedef struct occtl_curve_bspline
{
  uint32_t    struct_version; 
  const void* p_next;         
  int32_t degree;          
  int32_t is_rational;     
  int32_t is_periodic;     
  int32_t is_closed;       
  int32_t continuity;      
  size_t  pole_count;      
  size_t  knot_count;      
  size_t  flat_knot_count; 
  const occtl_point3_t* poles;   
  const double*         weights; 
  const double*  knots;          
  const int32_t* multiplicities; 
  const double*  flat_knots;     
} occtl_curve_bspline_t;
 
#define OCCTL_CURVE_BSPLINE_VERSION_1 1u
 
#define OCCTL_CURVE_BSPLINE_INIT                                                                   \
  {OCCTL_CURVE_BSPLINE_VERSION_1, NULL, 0, 0, 0, 0, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL}
 
OCCTL_API void OCCTL_CALL occtl_curve_bspline_init(occtl_curve_bspline_t* out);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_as_bspline(const occtl_graph_t*   graph,
                                                           occtl_rep_id_t         curve_id,
                                                           occtl_curve_bspline_t* out);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_eval_d0(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        double               u,
                                                        occtl_point3_t*      out_point);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_eval_d1(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        double               u,
                                                        occtl_point3_t*      out_point,
                                                        occtl_vector3_t*     out_d1);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_eval_d2(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        double               u,
                                                        occtl_point3_t*      out_point,
                                                        occtl_vector3_t*     out_d1,
                                                        occtl_vector3_t*     out_d2);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_eval_d3(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        double               u,
                                                        occtl_point3_t*      out_point,
                                                        occtl_vector3_t*     out_d1,
                                                        occtl_vector3_t*     out_d2,
                                                        occtl_vector3_t*     out_d3);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_eval_dn(const occtl_graph_t* graph,
                                                        occtl_rep_id_t       curve_id,
                                                        double               u,
                                                        int32_t              n,
                                                        occtl_vector3_t*     out_derivative);
 
typedef struct occtl_curve_airfoil_naca4_info
{
  uint32_t    struct_version;  
  const void* p_next;          
  double      max_camber;      
  double      camber_position; 
  double      thickness;       
  double      chord_length;    
  size_t      point_count;     
  int32_t
    finite_trailing_edge; 
  int32_t degree_min;     
  int32_t degree_max; 
  double  tolerance;  
} occtl_curve_airfoil_naca4_info_t;
 
#define OCCTL_CURVE_AIRFOIL_NACA4_INFO_VERSION_1 1u
 
#define OCCTL_CURVE_AIRFOIL_NACA4_INFO_INIT                                                        \
  {OCCTL_CURVE_AIRFOIL_NACA4_INFO_VERSION_1, NULL, 0.0, 0.0, 0.12, 1.0, 50, 0, 3, 8, 1.0e-5}
 
OCCTL_API void OCCTL_CALL
  occtl_curve_airfoil_naca4_info_init(occtl_curve_airfoil_naca4_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_airfoil_naca4(occtl_graph_t*                          graph,
                                   const occtl_curve_airfoil_naca4_info_t* info,
                                   occtl_rep_id_t*                         out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_curve_create_arc_of_circle_3pt(occtl_graph_t*  graph,
                                                                         occtl_point3_t  p1,
                                                                         occtl_point3_t  p2,
                                                                         occtl_point3_t  p3,
                                                                         occtl_rep_id_t* out_id);
 
typedef struct occtl_curve_interpolated_info
{
  uint32_t              struct_version; 
  const void*           p_next;         
  const occtl_point3_t* points;         
  size_t                point_count;    
  int32_t               is_periodic;    
  double                tolerance;      
} occtl_curve_interpolated_info_t;
 
#define OCCTL_CURVE_INTERPOLATED_INFO_VERSION_1 1u
#define OCCTL_CURVE_INTERPOLATED_INFO_INIT                                                         \
  {OCCTL_CURVE_INTERPOLATED_INFO_VERSION_1, NULL, NULL, 0, 0, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_curve_interpolated_info_init(occtl_curve_interpolated_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_interpolated(occtl_graph_t*                         graph,
                                  const occtl_curve_interpolated_info_t* info,
                                  occtl_rep_id_t*                        out_id);
 
typedef struct occtl_curve_approximated_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;      
  int32_t               is_periodic;    
} occtl_curve_approximated_info_t;
 
#define OCCTL_CURVE_APPROXIMATED_INFO_VERSION_1 1u
#define OCCTL_CURVE_APPROXIMATED_INFO_INIT                                                         \
  {OCCTL_CURVE_APPROXIMATED_INFO_VERSION_1, NULL, NULL, 0, 1, 3, 1e-3, 0}
 
OCCTL_API void OCCTL_CALL occtl_curve_approximated_info_init(occtl_curve_approximated_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_create_approximated(occtl_graph_t*                         graph,
                                  const occtl_curve_approximated_info_t* info,
                                  occtl_rep_id_t*                        out_id);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_to_bezier_segments(occtl_graph_t*                               graph,
                                 occtl_rep_id_t                               curve_id,
                                 const occtl_curve_bezier_segments_options_t* options,
                                 occtl_rep_id_t**                             out_ids,
                                 size_t*                                      out_count);
 
OCCTL_API void OCCTL_CALL occtl_curve_free_bezier_segments(occtl_rep_id_t* ids);
 
typedef struct occtl_curve_intersection_point
{
  occtl_point3_t point;   
  double         param_a; 
  double         param_b; 
} occtl_curve_intersection_point_t;
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_curve_intersect(occtl_graph_t*                           graph,
                        occtl_rep_id_t                           curve_id_a,
                        occtl_rep_id_t                           curve_id_b,
                        const occtl_curve_intersection_point_t** out_results,
                        size_t*                                  out_count);
 
OCCTL_API void OCCTL_CALL
  occtl_curve_free_intersection_points(occtl_curve_intersection_point_t* results);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_CURVES_H */