occtl_prim_feature.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_FEATURE_H
#define OCCTL_PRIM_FEATURE_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_FACE_FROM_SURFACE_OPTIONS_VERSION_1 1u
 
typedef struct occtl_prim_face_from_surface_options
{
  uint32_t       struct_version; 
  const void*    p_next;         
  occtl_rep_id_t surface_id;     
  occtl_node_id_t
    outer_wire; 
  const occtl_node_id_t* inner_wires;      
  size_t                 inner_wire_count; 
  double                 tolerance;        
} occtl_prim_face_from_surface_options_t;
 
#define OCCTL_PRIM_FACE_FROM_SURFACE_OPTIONS_INIT                                                  \
  {OCCTL_PRIM_FACE_FROM_SURFACE_OPTIONS_VERSION_1,                                                 \
   NULL,                                                                                           \
   OCCTL_REP_ID_INVALID,                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   NULL,                                                                                           \
   0,                                                                                              \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_face_from_surface_options_init(occtl_prim_face_from_surface_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_face_from_surface(occtl_graph_t*                                graph,
                                    const occtl_prim_face_from_surface_options_t* options,
                                    occtl_node_id_t*                              out_face);
 
#define OCCTL_PRIM_FACE_FROM_POINT_GRID_OPTIONS_VERSION_1 1u
 
typedef struct occtl_prim_face_from_point_grid_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  occtl_surface_point_grid_create_info_t surface; 
  double tolerance; 
} occtl_prim_face_from_point_grid_options_t;
 
#define OCCTL_PRIM_FACE_FROM_POINT_GRID_OPTIONS_INIT                                               \
  {OCCTL_PRIM_FACE_FROM_POINT_GRID_OPTIONS_VERSION_1,                                              \
   NULL,                                                                                           \
   OCCTL_SURFACE_POINT_GRID_CREATE_INFO_INIT,                                                      \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_face_from_point_grid_options_init(occtl_prim_face_from_point_grid_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_face_from_point_grid(occtl_graph_t*                                   graph,
                                       const occtl_prim_face_from_point_grid_options_t* options,
                                       occtl_node_id_t*                                 out_face);
 
#define OCCTL_PRIM_FACE_FROM_BOUNDARY_CURVES_OPTIONS_VERSION_1 1u
 
typedef struct occtl_prim_face_from_boundary_curves_options
{
  uint32_t struct_version; 
  const void* p_next;      
  occtl_surface_boundary_curves_create_info_t
         surface;   
  double tolerance; 
} occtl_prim_face_from_boundary_curves_options_t;
 
#define OCCTL_PRIM_FACE_FROM_BOUNDARY_CURVES_OPTIONS_INIT                                          \
  {OCCTL_PRIM_FACE_FROM_BOUNDARY_CURVES_OPTIONS_VERSION_1,                                         \
   NULL,                                                                                           \
   OCCTL_SURFACE_BOUNDARY_CURVES_CREATE_INFO_INIT,                                                 \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL occtl_prim_face_from_boundary_curves_options_init(
  occtl_prim_face_from_boundary_curves_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_face_from_boundary_curves(
  occtl_graph_t*                                        graph,
  const occtl_prim_face_from_boundary_curves_options_t* options,
  occtl_node_id_t*                                      out_face);
 
#define OCCTL_PRIM_FACE_FROM_CURVE_GRID_OPTIONS_VERSION_1 1u
 
typedef struct occtl_prim_face_from_curve_grid_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  occtl_surface_curve_grid_create_info_t surface; 
  double tolerance; 
} occtl_prim_face_from_curve_grid_options_t;
 
#define OCCTL_PRIM_FACE_FROM_CURVE_GRID_OPTIONS_INIT                                               \
  {OCCTL_PRIM_FACE_FROM_CURVE_GRID_OPTIONS_VERSION_1,                                              \
   NULL,                                                                                           \
   OCCTL_SURFACE_CURVE_GRID_CREATE_INFO_INIT,                                                      \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_face_from_curve_grid_options_init(occtl_prim_face_from_curve_grid_options_t* options);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_face_from_curve_grid(occtl_graph_t*                                   graph,
                                       const occtl_prim_face_from_curve_grid_options_t* options,
                                       occtl_node_id_t*                                 out_face);
 
#define OCCTL_PRIM_BRAKE_FORMED_OPTIONS_VERSION_1 1u
 
typedef enum occtl_prim_brake_side
{
  OCCTL_PRIM_BRAKE_SIDE_LEFT            = 0, 
  OCCTL_PRIM_BRAKE_SIDE_RIGHT           = 1, 
  OCCTL_PRIM_BRAKE_SIDE_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_brake_side_t;
 
typedef struct occtl_prim_brake_formed_options
{
  uint32_t        struct_version;        
  const void*     p_next;                
  occtl_node_id_t line;                  
  double          thickness;             
  const double*   station_widths;        
  size_t          station_width_count;   
  occtl_prim_brake_side_t          side; 
  occtl_topo_wire_offset_2d_join_t join; 
  int32_t approximate;                   
  double  tolerance;                     
} occtl_prim_brake_formed_options_t;
 
#define OCCTL_PRIM_BRAKE_FORMED_OPTIONS_INIT                                                       \
  {OCCTL_PRIM_BRAKE_FORMED_OPTIONS_VERSION_1,                                                      \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   1.0,                                                                                            \
   NULL,                                                                                           \
   0,                                                                                              \
   OCCTL_PRIM_BRAKE_SIDE_LEFT,                                                                     \
   OCCTL_TOPO_WIRE_OFFSET_2D_JOIN_ARC,                                                             \
   0,                                                                                              \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_brake_formed_options_init(occtl_prim_brake_formed_options_t* opts);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_brake_formed(const occtl_graph_t*                     graph,
                               const occtl_prim_brake_formed_options_t* options,
                               occtl_graph_t**                          out_graph,
                               occtl_node_id_t*                         out_root);
 
#define OCCTL_PRIM_DRAFT_PRISM_INFO_VERSION_1 1u
 
typedef struct occtl_prim_draft_prism_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t profile;        
  double          height;         
  double          taper_angle;    
} occtl_prim_draft_prism_info_t;
 
#define OCCTL_PRIM_DRAFT_PRISM_INFO_INIT                                                           \
  {OCCTL_PRIM_DRAFT_PRISM_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, 1.0, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_draft_prism_info_init(occtl_prim_draft_prism_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_draft_prism(occtl_graph_t*                       graph,
                              const occtl_prim_draft_prism_info_t* info,
                              occtl_node_id_t*                     out_shape);
 
#define OCCTL_PRIM_EXTRUDE_TAPERED_INFO_VERSION_1 1u
 
typedef struct occtl_prim_extrude_tapered_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t profile_face;   
  double          height;         
  double          taper_angle;    
} occtl_prim_extrude_tapered_info_t;
 
#define OCCTL_PRIM_EXTRUDE_TAPERED_INFO_INIT                                                       \
  {OCCTL_PRIM_EXTRUDE_TAPERED_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, 1.0, 0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_extrude_tapered_info_init(occtl_prim_extrude_tapered_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_extrude_tapered(occtl_graph_t*                           graph,
                                  const occtl_prim_extrude_tapered_info_t* info,
                                  occtl_node_id_t*                         out_shape);
 
#define OCCTL_PRIM_RULED_SURFACE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_ruled_surface_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t section_a;      
  occtl_node_id_t section_b;      
} occtl_prim_ruled_surface_info_t;
 
#define OCCTL_PRIM_RULED_SURFACE_INFO_INIT                                                         \
  {OCCTL_PRIM_RULED_SURFACE_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, OCCTL_NODE_ID_INVALID}
 
OCCTL_API void OCCTL_CALL occtl_prim_ruled_surface_info_init(occtl_prim_ruled_surface_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_ruled_surface(occtl_graph_t*                         graph,
                                const occtl_prim_ruled_surface_info_t* info,
                                occtl_node_id_t*                       out_shape);
 
typedef enum occtl_prim_until_kind
{
  OCCTL_UNTIL_LENGTH          = 0, 
  OCCTL_UNTIL_SHAPE           = 1, 
  OCCTL_UNTIL_THRU_ALL        = 2, 
  OCCTL_UNTIL_HEIGHT          = 3, 
  OCCTL_UNTIL_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_until_kind_t;
 
typedef enum occtl_prim_feat_combine
{
  OCCTL_FEAT_SEPARATE = 0, 
  OCCTL_FEAT_CUT      = 1, 
  OCCTL_FEAT_FUSE     = 2, 
  OCCTL_FEAT_COMBINE_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_feat_combine_t;
 
#define OCCTL_PRIM_FEAT_PRISM_INFO_VERSION_1 1u
 
typedef struct occtl_prim_feat_prism_info
{
  uint32_t           struct_version; 
  const void*        p_next;         
  occtl_node_id_t    base_shape; 
  occtl_node_id_t    profile;    
  occtl_node_id_t    sketch_face;    
  occtl_direction3_t direction;      
  occtl_prim_feat_combine_t combine; 
  int32_t                   modify;  
  occtl_prim_until_kind_t   until_kind; 
  occtl_node_id_t until_shape; 
  double          length;      
} occtl_prim_feat_prism_info_t;
 
#define OCCTL_PRIM_FEAT_PRISM_INFO_INIT                                                            \
  {OCCTL_PRIM_FEAT_PRISM_INFO_VERSION_1,                                                           \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_FEAT_FUSE,                                                                                \
   1,                                                                                              \
   OCCTL_UNTIL_LENGTH,                                                                             \
   OCCTL_NODE_ID_INVALID,                                                                          \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_feat_prism_info_init(occtl_prim_feat_prism_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_feat_prism(occtl_graph_t*                      graph,
                             const occtl_prim_feat_prism_info_t* info,
                             occtl_node_id_t*                    out_shape);
 
typedef enum occtl_prim_extrude_until_side
{
  OCCTL_EXTRUDE_UNTIL_NEXT            = 0, 
  OCCTL_EXTRUDE_UNTIL_LAST            = 1, 
  OCCTL_EXTRUDE_UNTIL_PREVIOUS        = 2, 
  OCCTL_EXTRUDE_UNTIL_FIRST           = 3, 
  OCCTL_EXTRUDE_UNTIL_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_extrude_until_side_t;
 
#define OCCTL_PRIM_EXTRUDE_UNTIL_INFO_VERSION_1 1u
 
typedef struct occtl_prim_extrude_until_info
{
  uint32_t           struct_version; 
  const void*        p_next;         
  occtl_node_id_t    base_shape; 
  occtl_node_id_t    profile;    
  occtl_node_id_t    sketch_face;  
  occtl_node_id_t    target_shape; 
  occtl_direction3_t direction;    
  occtl_prim_extrude_until_side_t side;    
  occtl_prim_feat_combine_t       combine; 
  int32_t                         modify;  
  double limit; 
} occtl_prim_extrude_until_info_t;
 
#define OCCTL_PRIM_EXTRUDE_UNTIL_INFO_INIT                                                         \
  {OCCTL_PRIM_EXTRUDE_UNTIL_INFO_VERSION_1,                                                        \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_EXTRUDE_UNTIL_NEXT,                                                                       \
   OCCTL_FEAT_FUSE,                                                                                \
   1,                                                                                              \
   0.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_extrude_until_info_init(occtl_prim_extrude_until_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_extrude_until(occtl_graph_t*                         graph,
                                const occtl_prim_extrude_until_info_t* info,
                                occtl_node_id_t*                       out_shape);
 
#define OCCTL_PRIM_FEAT_DRAFT_PRISM_INFO_VERSION_1 1u
 
typedef struct occtl_prim_feat_draft_prism_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t base_shape;   
  occtl_node_id_t profile_face; 
  occtl_node_id_t sketch_face;  
  double          taper_angle;  
  occtl_prim_feat_combine_t combine;    
  int32_t                   modify;     
  occtl_prim_until_kind_t   until_kind; 
  occtl_node_id_t until_shape; 
  double          length;      
} occtl_prim_feat_draft_prism_info_t;
 
#define OCCTL_PRIM_FEAT_DRAFT_PRISM_INFO_INIT                                                      \
  {OCCTL_PRIM_FEAT_DRAFT_PRISM_INFO_VERSION_1,                                                     \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   0.0,                                                                                            \
   OCCTL_FEAT_FUSE,                                                                                \
   1,                                                                                              \
   OCCTL_UNTIL_LENGTH,                                                                             \
   OCCTL_NODE_ID_INVALID,                                                                          \
   0.0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_feat_draft_prism_info_init(occtl_prim_feat_draft_prism_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_feat_draft_prism(occtl_graph_t*                            graph,
                                   const occtl_prim_feat_draft_prism_info_t* info,
                                   occtl_node_id_t*                          out_shape);
 
typedef enum occtl_prim_cylindrical_hole_kind
{
  OCCTL_CYLINDRICAL_HOLE_THROUGH_ALL =
    0, 
  OCCTL_CYLINDRICAL_HOLE_BETWEEN_PARAMS =
    1,                                  
  OCCTL_CYLINDRICAL_HOLE_THRU_NEXT = 2, 
  OCCTL_CYLINDRICAL_HOLE_UNTIL_END = 3, 
  OCCTL_CYLINDRICAL_HOLE_BLIND     = 4, 
  OCCTL_CYLINDRICAL_HOLE_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_cylindrical_hole_kind_t;
 
#define OCCTL_PRIM_CYLINDRICAL_HOLE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_cylindrical_hole_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t base_shape;     
  occtl_axis1_placement_t            axis;   
  double                             radius; 
  occtl_prim_cylindrical_hole_kind_t kind;   
  double                             p_from; 
  double  p_to;   
  double  length; 
  int32_t with_control; 
} occtl_prim_cylindrical_hole_info_t;
 
#define OCCTL_PRIM_CYLINDRICAL_HOLE_INFO_INIT                                                      \
  {OCCTL_PRIM_CYLINDRICAL_HOLE_INFO_VERSION_1,                                                     \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},                                                             \
   0.0,                                                                                            \
   OCCTL_CYLINDRICAL_HOLE_THROUGH_ALL,                                                             \
   0.0,                                                                                            \
   0.0,                                                                                            \
   0.0,                                                                                            \
   1}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_cylindrical_hole_info_init(occtl_prim_cylindrical_hole_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_cylindrical_hole(occtl_graph_t*                            graph,
                                   const occtl_prim_cylindrical_hole_info_t* info,
                                   occtl_node_id_t*                          out_shape);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OCCTL_PRIM_FEATURE_H */