occtl_prim_sweep.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_SWEEP_H
#define OCCTL_PRIM_SWEEP_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_PRISM_INFO_VERSION_1 1u
 
typedef struct occtl_prim_prism_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t profile;        
  occtl_vector3_t direction;      
  int32_t         copy;           
  int32_t canonize; 
} occtl_prim_prism_info_t;
 
#define OCCTL_PRIM_PRISM_INFO_INIT                                                                 \
  {OCCTL_PRIM_PRISM_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, {0.0, 0.0, 0.0}, 0, 1}
 
OCCTL_API void OCCTL_CALL occtl_prim_prism_info_init(occtl_prim_prism_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_prism(occtl_graph_t*                 graph,
                                                          const occtl_prim_prism_info_t* info,
                                                          occtl_node_id_t*               out_shape);
 
#define OCCTL_PRIM_TWIST_EXTRUSION_INFO_VERSION_1 1u
 
typedef struct occtl_prim_twist_extrusion_info
{
  uint32_t        struct_version;        
  const void*     p_next;                
  occtl_node_id_t profile_wire;          
  occtl_axis1_placement_t axis;          
  double                  height;        
  double                  angle;         
  int32_t                 section_count; 
  int32_t make_solid; 
  int32_t ruled;      
  double  pres3d;     
} occtl_prim_twist_extrusion_info_t;
 
#define OCCTL_PRIM_TWIST_EXTRUSION_INFO_INIT                                                       \
  {OCCTL_PRIM_TWIST_EXTRUSION_INFO_VERSION_1,                                                      \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},                                                             \
   1.0,                                                                                            \
   0.0,                                                                                            \
   9,                                                                                              \
   1,                                                                                              \
   1,                                                                                              \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_twist_extrusion_info_init(occtl_prim_twist_extrusion_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_twist_extrusion(occtl_graph_t*                           graph,
                                  const occtl_prim_twist_extrusion_info_t* info,
                                  occtl_node_id_t*                         out_shape);
 
#define OCCTL_PRIM_EXTRUDE_TWIST_INFO_VERSION_1 1u
 
typedef struct occtl_prim_extrude_twist_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_node_id_t         profile_wire;   
  occtl_axis1_placement_t axis;           
  double                  height;         
  double                  angle;          
  int32_t                 section_count;  
  int32_t make_solid; 
  int32_t ruled;      
  double  pres3d;     
} occtl_prim_extrude_twist_info_t;
 
#define OCCTL_PRIM_EXTRUDE_TWIST_INFO_INIT                                                         \
  {OCCTL_PRIM_EXTRUDE_TWIST_INFO_VERSION_1,                                                        \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},                                                             \
   1.0,                                                                                            \
   0.0,                                                                                            \
   9,                                                                                              \
   1,                                                                                              \
   1,                                                                                              \
   1.0e-6}
 
OCCTL_API void OCCTL_CALL occtl_prim_extrude_twist_info_init(occtl_prim_extrude_twist_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_extrude_twist(occtl_graph_t*                         graph,
                                const occtl_prim_extrude_twist_info_t* info,
                                occtl_node_id_t*                       out_shape);
 
#define OCCTL_PRIM_REVOL_INFO_VERSION_1 1u
 
typedef struct occtl_prim_revol_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_node_id_t         profile; 
  occtl_axis1_placement_t axis;    
  double                  angle;   
  int32_t                 copy; 
} occtl_prim_revol_info_t;
 
#define OCCTL_PRIM_REVOL_INFO_INIT                                                                 \
  {OCCTL_PRIM_REVOL_INFO_VERSION_1,                                                                \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}},                                                             \
   OCCTL_TWO_PI,                                                                                   \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_revol_info_init(occtl_prim_revol_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_revol(occtl_graph_t*                 graph,
                                                          const occtl_prim_revol_info_t* info,
                                                          occtl_node_id_t*               out_shape);
 
#define OCCTL_PRIM_PIPE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_pipe_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t profile;        
  occtl_node_id_t spine_wire;     
} occtl_prim_pipe_info_t;
 
#define OCCTL_PRIM_PIPE_INFO_INIT                                                                  \
  {OCCTL_PRIM_PIPE_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, OCCTL_NODE_ID_INVALID}
 
OCCTL_API void OCCTL_CALL occtl_prim_pipe_info_init(occtl_prim_pipe_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_pipe(occtl_graph_t*                graph,
                                                         const occtl_prim_pipe_info_t* info,
                                                         occtl_node_id_t*              out_shape);
 
#define OCCTL_PRIM_LOFT_INFO_VERSION_1 1u
 
typedef struct occtl_prim_loft_info
{
  uint32_t               struct_version; 
  const void*            p_next;         
  const occtl_node_id_t* sections;       
  size_t                 section_count;  
  int32_t                is_solid;       
  int32_t                ruled;          
  double                 pres3d;         
} occtl_prim_loft_info_t;
 
#define OCCTL_PRIM_LOFT_INFO_INIT {OCCTL_PRIM_LOFT_INFO_VERSION_1, NULL, NULL, 0, 0, 0, 1.0e-6}
 
OCCTL_API void OCCTL_CALL occtl_prim_loft_info_init(occtl_prim_loft_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_loft(occtl_graph_t*                graph,
                                                         const occtl_prim_loft_info_t* info,
                                                         occtl_node_id_t*              out_shape);
 
typedef enum occtl_prim_pipe_mode
{
  OCCTL_PIPE_MODE_CORRECTED_FRENET = 0, 
  OCCTL_PIPE_MODE_FRENET           = 1, 
  OCCTL_PIPE_MODE_DISCRETE         = 2, 
  OCCTL_PIPE_MODE_CONSTANT_AXIS =
    3, 
  OCCTL_PIPE_MODE_CONSTANT_BINORMAL =
    4, 
  OCCTL_PIPE_MODE_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_pipe_mode_t;
 
typedef enum occtl_prim_pipe_transition
{
  OCCTL_PIPE_TRANSITION_MODIFIED     = 0, 
  OCCTL_PIPE_TRANSITION_RIGHT_CORNER = 1, 
  OCCTL_PIPE_TRANSITION_ROUND_CORNER = 2, 
  OCCTL_PIPE_TRANSITION_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_pipe_transition_t;
 
#define OCCTL_PRIM_PIPE_SHELL_INFO_VERSION_1 1u
 
typedef struct occtl_prim_pipe_shell_info
{
  uint32_t                struct_version;    
  const void*             p_next;            
  occtl_node_id_t         spine_wire;        
  const occtl_node_id_t*  profiles;          
  size_t                  profile_count;     
  occtl_prim_pipe_mode_t  mode;              
  occtl_axis2_placement_t mode_axis;         
  occtl_direction3_t      mode_binormal;     
  occtl_prim_pipe_transition_t transition;   
  int32_t                      with_contact; 
  int32_t with_correction; 
  int32_t make_solid;      
} occtl_prim_pipe_shell_info_t;
 
#define OCCTL_PRIM_PIPE_SHELL_INFO_INIT                                                            \
  {OCCTL_PRIM_PIPE_SHELL_INFO_VERSION_1,                                                           \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   NULL,                                                                                           \
   0,                                                                                              \
   OCCTL_PIPE_MODE_CORRECTED_FRENET,                                                               \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_PIPE_TRANSITION_MODIFIED,                                                                 \
   0,                                                                                              \
   0,                                                                                              \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_pipe_shell_info_init(occtl_prim_pipe_shell_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_pipe_shell(occtl_graph_t*                      graph,
                             const occtl_prim_pipe_shell_info_t* info,
                             occtl_node_id_t*                    out_shape);
 
#define OCCTL_PRIM_PIPE_SHELL_LINEAR_LAW_INFO_VERSION_1 1u
 
typedef struct occtl_prim_pipe_shell_linear_law_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t spine_wire;     
  occtl_node_id_t profile;        
  double          scale_first;    
  double          scale_last;     
  occtl_prim_pipe_mode_t       mode;          
  occtl_axis2_placement_t      mode_axis;     
  occtl_direction3_t           mode_binormal; 
  occtl_prim_pipe_transition_t transition;    
  int32_t                      with_contact;  
  int32_t with_correction; 
  int32_t make_solid;      
} occtl_prim_pipe_shell_linear_law_info_t;
 
#define OCCTL_PRIM_PIPE_SHELL_LINEAR_LAW_INFO_INIT                                                 \
  {OCCTL_PRIM_PIPE_SHELL_LINEAR_LAW_INFO_VERSION_1,                                                \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   1.0,                                                                                            \
   1.0,                                                                                            \
   OCCTL_PIPE_MODE_CORRECTED_FRENET,                                                               \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_PIPE_TRANSITION_MODIFIED,                                                                 \
   0,                                                                                              \
   0,                                                                                              \
   0}
 
OCCTL_API void OCCTL_CALL
  occtl_prim_pipe_shell_linear_law_info_init(occtl_prim_pipe_shell_linear_law_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_pipe_shell_linear_law(occtl_graph_t*                                 graph,
                                        const occtl_prim_pipe_shell_linear_law_info_t* info,
                                        occtl_node_id_t*                               out_shape);
 
#define OCCTL_PRIM_PIPE_SHELL_INTERPOLATED_LAW_INFO_VERSION_1 1u
 
typedef struct occtl_prim_pipe_shell_interpolated_law_info
{
  uint32_t struct_version; 
  const void*     p_next;  
  occtl_node_id_t spine_wire; 
  occtl_node_id_t profile;    
  const double*
    parameters;         
  const double* scales; 
  size_t        sample_count; 
  occtl_prim_pipe_mode_t       mode;          
  occtl_axis2_placement_t      mode_axis;     
  occtl_direction3_t           mode_binormal; 
  occtl_prim_pipe_transition_t transition;    
  int32_t                      with_contact;  
  int32_t with_correction; 
  int32_t make_solid;      
} occtl_prim_pipe_shell_interpolated_law_info_t;
 
#define OCCTL_PRIM_PIPE_SHELL_INTERPOLATED_LAW_INFO_INIT                                           \
  {OCCTL_PRIM_PIPE_SHELL_INTERPOLATED_LAW_INFO_VERSION_1,                                          \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   OCCTL_NODE_ID_INVALID,                                                                          \
   NULL,                                                                                           \
   NULL,                                                                                           \
   0,                                                                                              \
   OCCTL_PIPE_MODE_CORRECTED_FRENET,                                                               \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   {0.0, 0.0, 1.0},                                                                                \
   OCCTL_PIPE_TRANSITION_MODIFIED,                                                                 \
   0,                                                                                              \
   0,                                                                                              \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_pipe_shell_interpolated_law_info_init(
  occtl_prim_pipe_shell_interpolated_law_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_pipe_shell_interpolated_law(
  occtl_graph_t*                                       graph,
  const occtl_prim_pipe_shell_interpolated_law_info_t* info,
  occtl_node_id_t*                                     out_shape);
 
typedef enum occtl_prim_offset_mode
{
  OCCTL_OFFSET_MODE_SKIN            = 0, 
  OCCTL_OFFSET_MODE_PIPE            = 1, 
  OCCTL_OFFSET_MODE_RECTO_VERSO     = 2, 
  OCCTL_OFFSET_MODE_RESERVED_FUTURE = 0x7fffffff
} occtl_prim_offset_mode_t;
 
#define OCCTL_PRIM_OFFSET_SHAPE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_offset_shape_info
{
  uint32_t                 struct_version; 
  const void*              p_next;         
  occtl_node_id_t          shape;          
  double                   offset;         
  double                   tolerance;      
  occtl_prim_offset_mode_t mode;           
  occtl_offset_join_type_t join;           
  int32_t
    intersection; 
  int32_t self_intersection; 
  int32_t
    remove_internal_edges; 
} occtl_prim_offset_shape_info_t;
 
#define OCCTL_PRIM_OFFSET_SHAPE_INFO_INIT                                                          \
  {OCCTL_PRIM_OFFSET_SHAPE_INFO_VERSION_1,                                                         \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   0.0,                                                                                            \
   1.0e-3,                                                                                         \
   OCCTL_OFFSET_MODE_SKIN,                                                                         \
   OCCTL_OFFSET_JOIN_ARC,                                                                          \
   0,                                                                                              \
   0,                                                                                              \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_offset_shape_info_init(occtl_prim_offset_shape_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_offset_shape(occtl_graph_t*                        graph,
                               const occtl_prim_offset_shape_info_t* info,
                               occtl_node_id_t*                      out_shape);
 
#define OCCTL_PRIM_THICK_SOLID_INFO_VERSION_1 1u
 
typedef struct occtl_prim_thick_solid_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t solid;          
  const occtl_node_id_t*
         closing_faces;          
  size_t closing_face_count;     
  double offset;                 
  double tolerance;              
  occtl_prim_offset_mode_t mode; 
  occtl_offset_join_type_t join; 
  int32_t                  intersection;          
  int32_t                  self_intersection;     
  int32_t                  remove_internal_edges; 
} occtl_prim_thick_solid_info_t;
 
#define OCCTL_PRIM_THICK_SOLID_INFO_INIT                                                           \
  {OCCTL_PRIM_THICK_SOLID_INFO_VERSION_1,                                                          \
   NULL,                                                                                           \
   OCCTL_NODE_ID_INVALID,                                                                          \
   NULL,                                                                                           \
   0,                                                                                              \
   0.0,                                                                                            \
   1.0e-3,                                                                                         \
   OCCTL_OFFSET_MODE_SKIN,                                                                         \
   OCCTL_OFFSET_JOIN_ARC,                                                                          \
   0,                                                                                              \
   0,                                                                                              \
   0}
 
OCCTL_API void OCCTL_CALL occtl_prim_thick_solid_info_init(occtl_prim_thick_solid_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_thick_solid(occtl_graph_t*                       graph,
                              const occtl_prim_thick_solid_info_t* info,
                              occtl_node_id_t*                     out_solid);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OCCTL_PRIM_SWEEP_H */