occtl_text.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_TEXT_H
#define OCCTL_TEXT_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "occtl_core.h"
#include "occtl_geom.h"
#include "occtl_topo.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum occtl_text_font_aspect
{
  OCCTL_TEXT_FONT_ASPECT_REGULAR         = 0, 
  OCCTL_TEXT_FONT_ASPECT_BOLD            = 1,
  OCCTL_TEXT_FONT_ASPECT_ITALIC          = 2,
  OCCTL_TEXT_FONT_ASPECT_BOLD_ITALIC     = 3,
  OCCTL_TEXT_FONT_ASPECT_RESERVED_FUTURE = 0x7fffffff
} occtl_text_font_aspect_t;
 
typedef enum occtl_text_halign
{
  OCCTL_TEXT_HALIGN_LEFT            = 0, 
  OCCTL_TEXT_HALIGN_CENTER          = 1,
  OCCTL_TEXT_HALIGN_RIGHT           = 2,
  OCCTL_TEXT_HALIGN_RESERVED_FUTURE = 0x7fffffff
} occtl_text_halign_t;
 
typedef enum occtl_text_valign
{
  OCCTL_TEXT_VALIGN_BOTTOM          = 0,
  OCCTL_TEXT_VALIGN_BASELINE        = 1, 
  OCCTL_TEXT_VALIGN_CENTER          = 2,
  OCCTL_TEXT_VALIGN_TOP             = 3,
  OCCTL_TEXT_VALIGN_RESERVED_FUTURE = 0x7fffffff
} occtl_text_valign_t;
 
#define OCCTL_TEXT_INFO_VERSION_1 1u
#define OCCTL_TEXT_LAYOUT_OPTIONS_VERSION_1 1u
#define OCCTL_TEXT_METRICS_VERSION_1 1u
 
typedef struct occtl_text_info
{
  uint32_t                struct_version; 
  const void*             p_next;         
  occtl_axis2_placement_t placement;      
  const char*             utf8_text;      
  const char*
    font_family; 
  const char*
    font_path; 
  occtl_text_font_aspect_t font_aspect; 
  double                   height;      
  occtl_text_halign_t      horizontal_align; 
  occtl_text_valign_t      vertical_align;   
} occtl_text_info_t;
 
typedef struct occtl_text_layout_options
{
  uint32_t    struct_version; 
  const void* p_next;         
  double wrapping_width; 
  int32_t word_wrapping; 
} occtl_text_layout_options_t;
 
typedef struct occtl_text_metrics
{
  uint32_t    struct_version;   
  const void* p_next;           
  double      width;            
  double      height;           
  double      left;             
  double      right;            
  double      bottom;           
  double      top;              
  double      ascender;         
  double      descender;        
  double      line_spacing;     
  double      max_symbol_width; 
} occtl_text_metrics_t;
 
#define OCCTL_TEXT_INFO_INIT                                                                       \
  {OCCTL_TEXT_INFO_VERSION_1,                                                                      \
   NULL,                                                                                           \
   {{0.0, 0.0, 0.0}, {0.0, 0.0, 1.0}, {1.0, 0.0, 0.0}},                                            \
   NULL,                                                                                           \
   NULL,                                                                                           \
   NULL,                                                                                           \
   OCCTL_TEXT_FONT_ASPECT_REGULAR,                                                                 \
   0.0,                                                                                            \
   OCCTL_TEXT_HALIGN_LEFT,                                                                         \
   OCCTL_TEXT_VALIGN_BASELINE}
 
#define OCCTL_TEXT_LAYOUT_OPTIONS_INIT {OCCTL_TEXT_LAYOUT_OPTIONS_VERSION_1, NULL, 0.0, 1}
 
#define OCCTL_TEXT_METRICS_INIT                                                                    \
  {OCCTL_TEXT_METRICS_VERSION_1, NULL, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0}
 
OCCTL_API void OCCTL_CALL occtl_text_info_init(occtl_text_info_t* info);
 
OCCTL_API void OCCTL_CALL occtl_text_layout_options_init(occtl_text_layout_options_t* options);
 
OCCTL_API void OCCTL_CALL occtl_text_metrics_init(occtl_text_metrics_t* metrics);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_text_measure(const occtl_text_info_t* info,
                                                       occtl_text_metrics_t*    out_metrics);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_text_make_faces(occtl_graph_t*           graph,
                                                          const occtl_text_info_t* info,
                                                          occtl_node_id_t*         out_compound);
 
OCCTL_API occtl_status_t OCCTL_CALL occtl_text_make_wires(occtl_graph_t*           graph,
                                                          const occtl_text_info_t* info,
                                                          occtl_node_id_t*         out_compound);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OCCTL_TEXT_H */