occtl_core.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_CORE_H
#define OCCTL_CORE_H
 
#include <stddef.h>
#include <stdint.h>
 
#define OCCTL_PI 3.14159265358979323846
 
#define OCCTL_TWO_PI (2.0 * OCCTL_PI)
 
#define OCCTL_PI_OVER_TWO (0.5 * OCCTL_PI)
 
#define OCCTL_RAD_PER_DEG (OCCTL_PI / 180.0)
 
#define OCCTL_ANGLE_1_DEG_RAD OCCTL_RAD_PER_DEG
 
#define OCCTL_ANGLE_5_DEG_RAD (5.0 * OCCTL_RAD_PER_DEG)
 
#define OCCTL_ANGLE_20_DEG_RAD (20.0 * OCCTL_RAD_PER_DEG)
 
#define OCCTL_ANGLE_30_DEG_RAD (30.0 * OCCTL_RAD_PER_DEG)
 
#define OCCTL_ANGLE_90_DEG_RAD OCCTL_PI_OVER_TWO
 
#ifndef OCCTL_VERSION_MAJOR
  #define OCCTL_VERSION_MAJOR 0
#endif
#ifndef OCCTL_VERSION_MINOR
  #define OCCTL_VERSION_MINOR 0
#endif
#ifndef OCCTL_VERSION_PATCH
  #define OCCTL_VERSION_PATCH 0
#endif
 
#ifndef OCCTL_ABI_VERSION
  #define OCCTL_ABI_VERSION 1
#endif
 
#if defined(_WIN32) && !defined(OCCTL_STATIC_BUILD)
  #if defined(OCCTL_BUILD_SHARED)
    #define OCCTL_API __declspec(dllexport)
  #else
    #define OCCTL_API __declspec(dllimport)
  #endif
  #define OCCTL_CALL __cdecl
#else
  #if defined(__GNUC__) || defined(__clang__)
    #define OCCTL_API __attribute__((visibility("default")))
  #else
    #define OCCTL_API
  #endif
  #define OCCTL_CALL
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum occtl_status
{
  OCCTL_OK               = 0,  
  OCCTL_ERROR            = 1,  
  OCCTL_INVALID_ARGUMENT = 2,  
  OCCTL_INVALID_HANDLE   = 3,  
  OCCTL_NOT_FOUND        = 4,  
  OCCTL_OUT_OF_MEMORY    = 5,  
  OCCTL_OUT_OF_RANGE     = 6,  
  OCCTL_NOT_DONE         = 7,  
  OCCTL_GEOMETRY_INVALID = 8,  
  OCCTL_TOPOLOGY_INVALID = 9,  
  OCCTL_IO_ERROR         = 10, 
  OCCTL_FORMAT_ERROR     = 11, 
  OCCTL_UNSUPPORTED      = 12, 
  OCCTL_CANCELLED        = 13, 
  OCCTL_BUFFER_TOO_SMALL = 14, 
  OCCTL_VERSION_MISMATCH = 15, 
  OCCTL_INTERNAL         = 16, 
  OCCTL_WRONG_KIND       = 17, 
  OCCTL_STATUS_RESERVED_FUTURE = 0x7fffffff
} occtl_status_t;
 
#define OCCTL_FAILED(status) ((status) != OCCTL_OK)
 
#define OCCTL_SUCCEEDED(status) ((status) == OCCTL_OK)
 
OCCTL_API const char* OCCTL_CALL occtl_status_to_string(occtl_status_t status);
 
typedef enum occtl_node_kind
{
  OCCTL_KIND_INVALID              = 0,  
  OCCTL_KIND_SOLID                = 1,  
  OCCTL_KIND_SHELL                = 2,  
  OCCTL_KIND_FACE                 = 3,  
  OCCTL_KIND_WIRE                 = 4,  
  OCCTL_KIND_EDGE                 = 5,  
  OCCTL_KIND_VERTEX               = 6,  
  OCCTL_KIND_COMPOUND             = 7,  
  OCCTL_KIND_COMPSOLID            = 8,  
  OCCTL_KIND_COEDGE               = 9,  
  OCCTL_KIND_PRODUCT              = 10, 
  OCCTL_KIND_OCCURRENCE           = 11, 
  OCCTL_NODE_KIND_RESERVED_FUTURE = 0x7fffffff
} occtl_node_kind_t;
 
typedef enum occtl_ref_kind
{
  OCCTL_REF_KIND_INVALID         = 0, 
  OCCTL_REF_KIND_SHELL           = 1, 
  OCCTL_REF_KIND_FACE            = 2, 
  OCCTL_REF_KIND_WIRE            = 3, 
  OCCTL_REF_KIND_COEDGE          = 4, 
  OCCTL_REF_KIND_VERTEX          = 5, 
  OCCTL_REF_KIND_SOLID           = 6, 
  OCCTL_REF_KIND_CHILD           = 7, 
  OCCTL_REF_KIND_OCCURRENCE      = 8, 
  OCCTL_REF_KIND_RESERVED_FUTURE = 0x7fffffff
} occtl_ref_kind_t;
 
typedef enum occtl_rep_kind
{
  OCCTL_REP_KIND_INVALID         = 0, 
  OCCTL_REP_KIND_SURFACE         = 1, 
  OCCTL_REP_KIND_CURVE3D         = 2, 
  OCCTL_REP_KIND_CURVE2D         = 3, 
  OCCTL_REP_KIND_TRIANGULATION   = 4, 
  OCCTL_REP_KIND_POLYGON3D       = 5, 
  OCCTL_REP_KIND_POLYGON2D       = 6, 
  OCCTL_REP_KIND_POLYGON_ON_TRI  = 7, 
  OCCTL_REP_KIND_RESERVED_FUTURE = 0x7fffffff
} occtl_rep_kind_t;
 
typedef struct occtl_rep_id
{
  uint64_t bits; 
} occtl_rep_id_t;
 
#ifdef __cplusplus
  #define OCCTL_REP_ID_INVALID (occtl_rep_id_t{0})
#else
  #define OCCTL_REP_ID_INVALID ((occtl_rep_id_t){0})
#endif
 
typedef struct occtl_uid
{
  uint64_t bits;
} occtl_uid_t;
 
#ifdef __cplusplus
  #define OCCTL_UID_INVALID (occtl_uid_t{0})
#else
  #define OCCTL_UID_INVALID ((occtl_uid_t){0})
#endif
 
typedef struct occtl_error
{
  occtl_status_t status;   
  const char*    message;  
  occtl_uid_t    source;   
  uint32_t       extended; 
} occtl_error_t;
 
OCCTL_API const occtl_error_t* OCCTL_CALL occtl_error_last(void);
 
OCCTL_API void OCCTL_CALL occtl_error_clear(void);
 
#define OCCTL_RUNTIME_INIT_INFO_VERSION_1 1u
 
typedef struct occtl_runtime_init_info
{
  uint32_t    struct_version; 
  const void* p_next;         
} occtl_runtime_init_info_t;
 
#define OCCTL_RUNTIME_INIT_INFO_INIT {OCCTL_RUNTIME_INIT_INFO_VERSION_1, NULL}
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_runtime_init(const occtl_runtime_init_info_t* info);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_runtime_init_info_init(occtl_runtime_init_info_t* info);
 
OCCTL_API void OCCTL_CALL occtl_runtime_shutdown(void);
 
OCCTL_API void OCCTL_CALL occtl_runtime_version(uint32_t* out_major,
                                                uint32_t* out_minor,
                                                uint32_t* out_patch);
 
OCCTL_API uint32_t OCCTL_CALL occtl_runtime_abi_version(void);
 
OCCTL_API const char* OCCTL_CALL occtl_runtime_occt_version(void);
 
#define OCCTL_UID_WIRE_SIZE 16u
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_uid_to_bytes(occtl_uid_t uid, uint8_t* out_bytes);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_uid_from_bytes(const uint8_t* in_bytes,
                                                         occtl_uid_t*   out_uid);
 
OCCTL_API int32_t OCCTL_CALL occtl_uid_equal(occtl_uid_t a, occtl_uid_t b);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_CORE_H */