wx_bgi_dds.h

Go to the documentation of this file.

#pragma once
 
#include "bgi_types.h"  // BGI_API, BGI_CALL
 
// DDS object-type constants (returned by wxbgi_dds_get_type).
// Values match bgi::DdsObjectType; kept as plain ints for C compatibility.
#define WXBGI_DDS_CAMERA         0
#define WXBGI_DDS_UCS            1
#define WXBGI_DDS_WORLD_EXTENTS  2
#define WXBGI_DDS_POINT          3
#define WXBGI_DDS_LINE           4
#define WXBGI_DDS_CIRCLE         5
#define WXBGI_DDS_ARC            6
#define WXBGI_DDS_ELLIPSE        7
#define WXBGI_DDS_FILL_ELLIPSE   8
#define WXBGI_DDS_PIE_SLICE      9
#define WXBGI_DDS_SECTOR         10
#define WXBGI_DDS_RECTANGLE      11
#define WXBGI_DDS_BAR            12
#define WXBGI_DDS_BAR3D          13
#define WXBGI_DDS_POLYGON        14
#define WXBGI_DDS_FILL_POLY      15
#define WXBGI_DDS_TEXT           16
#define WXBGI_DDS_IMAGE          17
// Phase 4 — 3D Solid Primitives
#define WXBGI_DDS_BOX            18
#define WXBGI_DDS_SPHERE         19
#define WXBGI_DDS_CYLINDER       20
#define WXBGI_DDS_CONE           21
#define WXBGI_DDS_TORUS          22
// Phase 5 — 3D Surfaces
#define WXBGI_DDS_HEIGHTMAP      23
#define WXBGI_DDS_PARAM_SURFACE  24
// Phase 6 — 2D→3D Extrusion
#define WXBGI_DDS_EXTRUSION      25
#define WXBGI_DDS_TRANSFORM      26
#define WXBGI_DDS_SET_UNION      27
#define WXBGI_DDS_SET_INTERSECTION 28
#define WXBGI_DDS_SET_DIFFERENCE 29
#define WXBGI_DDS_UNKNOWN        -1
 
// Parametric surface formula constants
#define WXBGI_PARAM_SPHERE    0
#define WXBGI_PARAM_CYLINDER  1
#define WXBGI_PARAM_TORUS     2
#define WXBGI_PARAM_SADDLE    3
#define WXBGI_PARAM_MOBIUS    4
 
// Solid draw mode constants
#define WXBGI_SOLID_WIREFRAME  0
#define WXBGI_SOLID_SOLID      1   
#define WXBGI_SOLID_FLAT       1   
#define WXBGI_SOLID_SMOOTH     2   
 
// CoordSpace constants (returned by wxbgi_dds_get_coord_space).
#define WXBGI_COORD_BGI_PIXEL  0  
#define WXBGI_COORD_WORLD_3D   1  
#define WXBGI_COORD_UCS_LOCAL  2  
 
#ifdef __cplusplus
extern "C" {
#endif
 
// =============================================================================
// Scene inspection and management
// =============================================================================
 
BGI_API int BGI_CALL wxbgi_dds_object_count(void);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_id_at(int index);
 
BGI_API int BGI_CALL wxbgi_dds_get_type(const char *id);
 
BGI_API int BGI_CALL wxbgi_dds_get_coord_space(const char *id);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_label(const char *id);
 
BGI_API void BGI_CALL wxbgi_dds_set_label(const char *id, const char *label);
 
BGI_API int BGI_CALL wxbgi_dds_set_external_attr(const char *id, const char *key, const char *value);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_external_attr(const char *id, const char *key);
 
BGI_API int BGI_CALL wxbgi_dds_clear_external_attr(const char *id, const char *key);
 
BGI_API int BGI_CALL wxbgi_dds_external_attr_count(const char *id);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_external_attr_key_at(const char *id, int index);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_external_attr_value_at(const char *id, int index);
 
BGI_API const char *BGI_CALL wxbgi_dds_find_by_label(const char *label);
 
BGI_API void BGI_CALL wxbgi_dds_set_visible(const char *id, int visible);
 
BGI_API int BGI_CALL wxbgi_dds_get_visible(const char *id);
 
BGI_API int BGI_CALL wxbgi_object_set_face_color(const char *id, int color);
 
BGI_API int BGI_CALL wxbgi_dds_remove(const char *id);
 
BGI_API void BGI_CALL wxbgi_dds_clear(void);
 
BGI_API void BGI_CALL wxbgi_dds_clear_all(void);
 
// =============================================================================
// Retained composition helpers
// =============================================================================
 
BGI_API const char *BGI_CALL wxbgi_dds_translate(const char *id, float dx, float dy, float dz);
 
BGI_API const char *BGI_CALL wxbgi_dds_rotate_x_deg(const char *id, float angleDeg);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_y_deg(const char *id, float angleDeg);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_z_deg(const char *id, float angleDeg);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_x_rad(const char *id, float angleRad);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_y_rad(const char *id, float angleRad);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_z_rad(const char *id, float angleRad);
 
BGI_API const char *BGI_CALL wxbgi_dds_rotate_axis_deg(const char *id,
                                                        float axisX, float axisY, float axisZ,
                                                        float angleDeg);
BGI_API const char *BGI_CALL wxbgi_dds_rotate_axis_rad(const char *id,
                                                        float axisX, float axisY, float axisZ,
                                                        float angleRad);
 
BGI_API const char *BGI_CALL wxbgi_dds_scale_uniform(const char *id, float factor);
BGI_API const char *BGI_CALL wxbgi_dds_scale_xyz(const char *id, float sx, float sy, float sz);
 
BGI_API const char *BGI_CALL wxbgi_dds_skew(const char *id,
                                             float xy, float xz,
                                             float yx, float yz,
                                             float zx, float zy);
 
BGI_API const char *BGI_CALL wxbgi_dds_union(int count, const char *const *ids);
 
BGI_API const char *BGI_CALL wxbgi_dds_intersection(int count, const char *const *ids);
 
BGI_API const char *BGI_CALL wxbgi_dds_difference(int count, const char *const *ids);
 
BGI_API int BGI_CALL wxbgi_dds_get_child_count(const char *id);
 
BGI_API const char *BGI_CALL wxbgi_dds_get_child_at(const char *id, int index);
 
// =============================================================================
// Serialization — JSON (DDJ) and YAML (DDY)
// =============================================================================
 
BGI_API const char *BGI_CALL wxbgi_dds_to_json(void);
 
BGI_API const char *BGI_CALL wxbgi_dds_to_yaml(void);
 
BGI_API int BGI_CALL wxbgi_dds_from_json(const char *jsonString);
 
BGI_API int BGI_CALL wxbgi_dds_from_yaml(const char *yamlString);
 
BGI_API int BGI_CALL wxbgi_dds_save_json(const char *filePath);
 
BGI_API int BGI_CALL wxbgi_dds_load_json(const char *filePath);
 
BGI_API int BGI_CALL wxbgi_dds_save_yaml(const char *filePath);
 
BGI_API int BGI_CALL wxbgi_dds_load_yaml(const char *filePath);
 
// =============================================================================
// DDS-based rendering  (Phase D — placeholder declaration)
// =============================================================================
 
BGI_API void BGI_CALL wxbgi_render_dds(const char *camName);
 
// =============================================================================
// GL rendering mode control
// =============================================================================
 
BGI_API void BGI_CALL wxbgi_set_legacy_gl_render(int enable);
 
BGI_API void BGI_CALL wxbgi_gl_pass_destroy(void);
 
// =============================================================================
// GL Phong lighting API
// =============================================================================
 
BGI_API void BGI_CALL wxbgi_solid_set_light_dir(float x, float y, float z);
 
BGI_API void BGI_CALL wxbgi_solid_set_light_space(int worldSpace);
 
BGI_API void BGI_CALL wxbgi_solid_set_fill_light(float x, float y, float z, float strength);
 
BGI_API void BGI_CALL wxbgi_solid_set_ambient(float a);
 
BGI_API void BGI_CALL wxbgi_solid_set_diffuse(float d);
 
BGI_API void BGI_CALL wxbgi_solid_set_specular(float s, float shininess);
 
// =============================================================================
// Multi-Scene (CHDOP) Management
// =============================================================================
//
// The library maintains a registry of named DDS scene graphs. A "default"
// scene always exists and cannot be destroyed.  Immediate-mode draw calls
// (circle, box, wxbgi_world_line, etc.) always append to the *active* scene.
// Each camera renders its *assigned* scene (see wxbgi_cam_set_scene).
//
// Typical usage:
//   wxbgi_dds_scene_create("secondary");         // create a second scene
//   wxbgi_dds_scene_set_active("secondary");     // route draws to it
//   wxbgi_world_box(0,0,0, 5,5,5);              // appends to "secondary"
//   wxbgi_dds_scene_set_active("default");       // switch back
//   wxbgi_cam_set_scene("cam_side", "secondary");// cam_side renders "secondary"
//   wxbgi_render_dds("cam_main");               // renders "default" scene
//   wxbgi_render_dds("cam_side");               // renders "secondary" scene
 
BGI_API int BGI_CALL wxbgi_dds_scene_create(const char *name);
 
BGI_API void BGI_CALL wxbgi_dds_scene_destroy(const char *name);
 
BGI_API void BGI_CALL wxbgi_dds_scene_set_active(const char *name);
 
BGI_API const char *BGI_CALL wxbgi_dds_scene_get_active(void);
 
BGI_API int BGI_CALL wxbgi_dds_scene_exists(const char *name);
 
BGI_API void BGI_CALL wxbgi_dds_scene_clear(const char *name);
 
BGI_API void BGI_CALL wxbgi_cam_set_scene(const char *camName, const char *sceneName);
 
BGI_API const char *BGI_CALL wxbgi_cam_get_scene(const char *camName);
 
#ifdef __cplusplus
} // extern "C"
#endif