occtl_prim_solid.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_SOLID_H
#define OCCTL_PRIM_SOLID_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_BOX_INFO_VERSION_1 1u
 
typedef struct occtl_prim_box_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  dx;             
  double                  dy;             
  double                  dz;             
} occtl_prim_box_info_t;
 
#define OCCTL_PRIM_BOX_INFO_INIT                                                                   \
  {OCCTL_PRIM_BOX_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_box_info_init(occtl_prim_box_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_box(occtl_graph_t*               graph,
                                                        const occtl_prim_box_info_t* info,
                                                        occtl_node_id_t*             out_solid);
 
#define OCCTL_PRIM_SPHERE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_sphere_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
  double                  angle1;         
  double                  angle2; 
  double                  angle;  
} occtl_prim_sphere_info_t;
 
#define OCCTL_PRIM_SPHERE_INFO_INIT                                                                \
  {OCCTL_PRIM_SPHERE_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_PI_OVER_TWO,                                                                             \
   OCCTL_PI_OVER_TWO,                                                                              \
   OCCTL_TWO_PI}
 
OCCTL_API void OCCTL_CALL occtl_prim_sphere_info_init(occtl_prim_sphere_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_sphere(occtl_graph_t*                  graph,
                                                           const occtl_prim_sphere_info_t* info,
                                                           occtl_node_id_t* out_solid);
 
#define OCCTL_PRIM_CYLINDER_INFO_VERSION_1 1u
 
typedef struct occtl_prim_cylinder_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  radius;         
  double                  height;         
  double                  angle;          
} occtl_prim_cylinder_info_t;
 
#define OCCTL_PRIM_CYLINDER_INFO_INIT                                                              \
  {OCCTL_PRIM_CYLINDER_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_TWO_PI}
 
OCCTL_API void OCCTL_CALL occtl_prim_cylinder_info_init(occtl_prim_cylinder_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_cylinder(occtl_graph_t* graph,
                                                             const occtl_prim_cylinder_info_t* info,
                                                             occtl_node_id_t* out_solid);
 
#define OCCTL_PRIM_CONE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_cone_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  r1;             
  double                  r2;             
  double                  height;         
  double                  angle;          
} occtl_prim_cone_info_t;
 
#define OCCTL_PRIM_CONE_INFO_INIT                                                                  \
  {OCCTL_PRIM_CONE_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_TWO_PI}
 
OCCTL_API void OCCTL_CALL occtl_prim_cone_info_init(occtl_prim_cone_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_cone(occtl_graph_t*                graph,
                                                         const occtl_prim_cone_info_t* info,
                                                         occtl_node_id_t*              out_solid);
 
#define OCCTL_PRIM_TORUS_INFO_VERSION_1 1u
 
typedef struct occtl_prim_torus_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  r1;             
  double                  r2;             
  double                  angle1;         
  double                  angle2;         
  double                  angle;          
} occtl_prim_torus_info_t;
 
#define OCCTL_PRIM_TORUS_INFO_INIT                                                                 \
  {OCCTL_PRIM_TORUS_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_TWO_PI,                                                                                   \
   OCCTL_TWO_PI}
 
OCCTL_API void OCCTL_CALL occtl_prim_torus_info_init(occtl_prim_torus_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_torus(occtl_graph_t*                 graph,
                                                          const occtl_prim_torus_info_t* info,
                                                          occtl_node_id_t*               out_solid);
 
#define OCCTL_PRIM_WEDGE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_wedge_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  double                  dx;             
  double                  dy;  
  double                  dz;  
  double                  ltx; 
} occtl_prim_wedge_info_t;
 
#define OCCTL_PRIM_WEDGE_INFO_INIT                                                                 \
  {OCCTL_PRIM_WEDGE_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.0}
 
OCCTL_API void OCCTL_CALL occtl_prim_wedge_info_init(occtl_prim_wedge_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_prim_make_wedge(occtl_graph_t*                 graph,
                                                          const occtl_prim_wedge_info_t* info,
                                                          occtl_node_id_t*               out_solid);
 
#define OCCTL_PRIM_HALFSPACE_INFO_VERSION_1 1u
 
typedef struct occtl_prim_halfspace_info
{
  uint32_t        struct_version; 
  const void*     p_next;         
  occtl_node_id_t face; 
  occtl_point3_t  reference_point; 
} occtl_prim_halfspace_info_t;
 
#define OCCTL_PRIM_HALFSPACE_INFO_INIT                                                             \
  {OCCTL_PRIM_HALFSPACE_INFO_VERSION_1, NULL, OCCTL_NODE_ID_INVALID, {0.0, 0.0, 0.0}}
 
OCCTL_API void OCCTL_CALL occtl_prim_halfspace_info_init(occtl_prim_halfspace_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL
  occtl_prim_make_halfspace(occtl_graph_t*                     graph,
                            const occtl_prim_halfspace_info_t* info,
                            occtl_node_id_t*                   out_solid);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OCCTL_PRIM_SOLID_H */