occtl_geom.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_GEOM_H
#define OCCTL_GEOM_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct
{
  double x; 
  double y; 
} occtl_point2_t;
 
typedef struct
{
  double x; 
  double y; 
} occtl_vector2_t;
 
typedef struct
{
  double x; 
  double y; 
} occtl_direction2_t;
 
typedef struct
{
  double x; 
  double y; 
  double z; 
} occtl_point3_t;
 
typedef struct
{
  double x; 
  double y; 
  double z; 
} occtl_vector3_t;
 
typedef struct
{
  double x; 
  double y; 
  double z; 
} occtl_direction3_t;
 
typedef struct
{
  occtl_point3_t     location;  
  occtl_direction3_t direction; 
} occtl_axis1_placement_t;
 
typedef struct
{
  occtl_point3_t     location; 
  occtl_direction3_t x_dir;    
  occtl_direction3_t
    x_dir_ref; 
} occtl_axis2_placement_t;
 
typedef struct
{
  occtl_point3_t     location; 
  occtl_direction3_t x_dir;    
  occtl_direction3_t y_dir;    
  occtl_direction3_t z_dir;    
} occtl_axis3_placement_t;
 
typedef struct
{
  double m[12]; 
} occtl_transform_t;
 
OCCTL_API double OCCTL_CALL occtl_point3_distance(occtl_point3_t a, occtl_point3_t b);
 
OCCTL_API occtl_point3_t OCCTL_CALL occtl_point3_midpoint(occtl_point3_t a, occtl_point3_t b);
 
OCCTL_API occtl_point3_t OCCTL_CALL occtl_point3_translate(occtl_point3_t p, occtl_vector3_t v);
 
OCCTL_API occtl_point3_t OCCTL_CALL occtl_transform_apply_point3(occtl_transform_t t,
                                                                 occtl_point3_t    p);
 
OCCTL_API double OCCTL_CALL occtl_point2_distance(occtl_point2_t a, occtl_point2_t b);
 
OCCTL_API occtl_point2_t OCCTL_CALL occtl_point2_midpoint(occtl_point2_t a, occtl_point2_t b);
 
OCCTL_API double OCCTL_CALL occtl_vector3_dot(occtl_vector3_t a, occtl_vector3_t b);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_vector3_cross(occtl_vector3_t a, occtl_vector3_t b);
 
OCCTL_API double OCCTL_CALL occtl_vector3_magnitude(occtl_vector3_t v);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_vector3_normalized(occtl_vector3_t  v,
                                                             occtl_vector3_t* out_result);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_vector3_angle(occtl_vector3_t a,
                                                        occtl_vector3_t b,
                                                        double*         out_radians);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_vector3_add(occtl_vector3_t a, occtl_vector3_t b);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_vector3_sub(occtl_vector3_t a, occtl_vector3_t b);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_vector3_scaled(occtl_vector3_t v, double s);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_vector3_reversed(occtl_vector3_t v);
 
OCCTL_API double OCCTL_CALL occtl_vector2_dot(occtl_vector2_t a, occtl_vector2_t b);
 
OCCTL_API double OCCTL_CALL occtl_vector2_cross(occtl_vector2_t a, occtl_vector2_t b);
 
OCCTL_API double OCCTL_CALL occtl_vector2_magnitude(occtl_vector2_t v);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_vector2_normalized(occtl_vector2_t  v,
                                                             occtl_vector2_t* out_result);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_direction3_from_vector(occtl_vector3_t     v,
                                                                 occtl_direction3_t* out_direction);
 
OCCTL_API double OCCTL_CALL occtl_direction3_dot(occtl_direction3_t a, occtl_direction3_t b);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_direction3_cross(occtl_direction3_t a,
                                                            occtl_direction3_t b);
 
OCCTL_API double OCCTL_CALL occtl_direction3_angle(occtl_direction3_t a, occtl_direction3_t b);
 
OCCTL_API occtl_direction3_t OCCTL_CALL occtl_direction3_reversed(occtl_direction3_t d);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_direction3_transform(occtl_direction3_t  d,
                                                               occtl_transform_t   t,
                                                               occtl_direction3_t* out_direction);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_direction2_from_vector(occtl_vector2_t     v,
                                                                 occtl_direction2_t* out_direction);
 
OCCTL_API double OCCTL_CALL occtl_direction2_angle(occtl_direction2_t a, occtl_direction2_t b);
 
OCCTL_API occtl_transform_t OCCTL_CALL occtl_transform_identity(void);
 
OCCTL_API occtl_transform_t OCCTL_CALL occtl_transform_translation(occtl_vector3_t v);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_transform_rotation(occtl_axis1_placement_t axis,
                                                             double                  angle,
                                                             occtl_transform_t*      out_transform);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_transform_scale(occtl_point3_t     center,
                                                          double             s,
                                                          occtl_transform_t* out_transform);
 
OCCTL_API occtl_transform_t OCCTL_CALL occtl_transform_compose(occtl_transform_t first,
                                                               occtl_transform_t second);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_transform_inverted(occtl_transform_t  t,
                                                             occtl_transform_t* out_transform);
 
OCCTL_API occtl_vector3_t OCCTL_CALL occtl_transform_apply_vector3(occtl_transform_t t,
                                                                   occtl_vector3_t   v);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_transform_from_axis2(occtl_axis2_placement_t frame,
                                                               occtl_transform_t* out_transform);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_transform_from_axis3(occtl_axis3_placement_t frame,
                                                               occtl_transform_t* out_transform);
 
typedef struct
{
  occtl_point2_t     location; 
  occtl_direction2_t x_dir;    
} occtl_axis2_placement2d_t;
 
typedef enum occtl_geom_continuity
{
  OCCTL_GEOM_CONTINUITY_C0              = 0, 
  OCCTL_GEOM_CONTINUITY_G1              = 1, 
  OCCTL_GEOM_CONTINUITY_C1              = 2, 
  OCCTL_GEOM_CONTINUITY_G2              = 3, 
  OCCTL_GEOM_CONTINUITY_C2              = 4, 
  OCCTL_GEOM_CONTINUITY_C3              = 5, 
  OCCTL_GEOM_CONTINUITY_CN              = 6, 
  OCCTL_GEOM_CONTINUITY_RESERVED_FUTURE = 0x7fffffff
} occtl_geom_continuity_t;
 
typedef occtl_axis1_placement_t occtl_geom_line_t;
 
typedef struct
{
  occtl_axis2_placement_t position; 
  double                  radius;   
} occtl_geom_circle_t;
 
typedef struct
{
  occtl_axis2_placement_t position;     
  double                  major_radius; 
  double                  minor_radius; 
} occtl_geom_ellipse_t;
 
typedef struct
{
  occtl_axis2_placement_t position;     
  double                  major_radius; 
  double                  minor_radius; 
} occtl_geom_hyperbola_t;
 
typedef struct
{
  occtl_axis2_placement_t position;     
  double                  focal_length; 
} occtl_geom_parabola_t;
 
typedef struct
{
  occtl_axis2_placement2d_t position; 
} occtl_geom2d_line_t;
 
typedef struct
{
  occtl_axis2_placement2d_t position; 
  double                    radius;   
} occtl_geom2d_circle_t;
 
typedef struct
{
  occtl_axis2_placement2d_t position;     
  double                    major_radius; 
  double                    minor_radius; 
} occtl_geom2d_ellipse_t;
 
typedef struct
{
  occtl_axis2_placement2d_t position;     
  double                    major_radius; 
  double                    minor_radius; 
} occtl_geom2d_hyperbola_t;
 
typedef struct
{
  occtl_axis2_placement2d_t position;     
  double                    focal_length; 
} occtl_geom2d_parabola_t;
 
typedef struct
{
  occtl_axis3_placement_t position; 
} occtl_geom_plane_t;
 
typedef struct
{
  occtl_axis3_placement_t position; 
  double                  radius;   
} occtl_geom_cylindrical_surface_t;
 
typedef struct
{
  occtl_axis3_placement_t position; 
  double                  radius;   
} occtl_geom_spherical_surface_t;
 
typedef struct
{
  occtl_axis3_placement_t position;   
  double                  semi_angle; 
  double                  radius;     
} occtl_geom_conical_surface_t;
 
typedef struct
{
  occtl_axis3_placement_t position;     
  double                  major_radius; 
  double                  minor_radius; 
} occtl_geom_toroidal_surface_t;
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_GEOM_H */