tf_systemPy.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/
 
#ifndef _SOURCE_LANGS_PY_TF_SYSTEMPY_H_
#define _SOURCE_LANGS_PY_TF_SYSTEMPY_H_
 
#include "tf_py.h"
 
#include <rendering/tfUniverseRenderer.h>
#include <rendering/tfArrowRenderer.h>
 
#include <list>
#include <unordered_map>
 
 
namespace TissueForge::py {
 
 
   CPPAPI_FUNC(void) print_performance_counters();
 
   CPPAPI_FUNC(HRESULT) screenshot(const std::string &filePath);
 
   CPPAPI_FUNC(HRESULT) screenshot(const std::string &filePath, const bool &decorate, const FVector3 &bgcolor);
 
    CPPAPI_FUNC(bool) camera_is_lagging();
 
    CPPAPI_FUNC(HRESULT) camera_enable_lagging();
 
    CPPAPI_FUNC(HRESULT) camera_disable_lagging();
 
    CPPAPI_FUNC(HRESULT) camera_toggle_lagging();
 
    CPPAPI_FUNC(float) camera_get_lagging();
 
    CPPAPI_FUNC(HRESULT) camera_set_lagging(const float &lagging);
 
   CPPAPI_FUNC(bool) context_has_current();
   CPPAPI_FUNC(HRESULT) context_make_current();
   CPPAPI_FUNC(HRESULT) context_release();
 
   CPPAPI_FUNC(HRESULT) camera_move_to(const FVector3 &eye, const FVector3 &center, const FVector3 &up);
 
   CPPAPI_FUNC(HRESULT) camera_move_to(const FVector3 &center, const FQuaternion &rotation, const float &zoom);
 
   CPPAPI_FUNC(HRESULT) camera_view_bottom();
 
   CPPAPI_FUNC(HRESULT) camera_view_top();
 
   CPPAPI_FUNC(HRESULT) camera_view_left();
 
   CPPAPI_FUNC(HRESULT) camera_view_right();
 
   CPPAPI_FUNC(HRESULT) camera_view_back();
 
   CPPAPI_FUNC(HRESULT) camera_view_front();
 
   CPPAPI_FUNC(HRESULT) camera_reset();
 
   /* Rotate the camera from the previous (screen) mouse position to the
   current (screen) position */
   CPPAPI_FUNC(HRESULT) camera_rotate_mouse(const iVector2 &mousePos);
 
   /* Translate the camera from the previous (screen) mouse position to
   the current (screen) mouse position */
   CPPAPI_FUNC(HRESULT) camera_translate_mouse(const iVector2 &mousePos);
 
   CPPAPI_FUNC(HRESULT) camera_translate_down();
 
   CPPAPI_FUNC(HRESULT) camera_translate_up();
 
   CPPAPI_FUNC(HRESULT) camera_translate_right();
 
   CPPAPI_FUNC(HRESULT) camera_translate_left();
 
   CPPAPI_FUNC(HRESULT) camera_translate_forward();
 
   CPPAPI_FUNC(HRESULT) camera_translate_backward();
 
   CPPAPI_FUNC(HRESULT) camera_rotate_down();
 
   CPPAPI_FUNC(HRESULT) camera_rotate_up();
 
   CPPAPI_FUNC(HRESULT) camera_rotate_left();
 
   CPPAPI_FUNC(HRESULT) camera_rotate_right();
 
   CPPAPI_FUNC(HRESULT) camera_roll_left();
 
   CPPAPI_FUNC(HRESULT) camera_roll_right();
 
   CPPAPI_FUNC(HRESULT) camera_zoom_in();
 
   CPPAPI_FUNC(HRESULT) camera_zoom_out();
 
   /* Rotate the camera from the previous (screen) mouse position to the
   current (screen) position */
   CPPAPI_FUNC(HRESULT) camera_init_mouse(const iVector2 &mousePos);
 
   /* Translate the camera by the delta amount of (NDC) mouse position.
   Note that NDC position must be in [-1, -1] to [1, 1]. */
   CPPAPI_FUNC(HRESULT) camera_translate_by(const FVector2 &trans);
 
   CPPAPI_FUNC(HRESULT) camera_zoom_by(const float &delta);
 
   CPPAPI_FUNC(HRESULT) camera_zoom_to(const float &distance);
 
   CPPAPI_FUNC(HRESULT) camera_rotate_to_axis(const FVector3 &axis, const float &distance);
 
   CPPAPI_FUNC(HRESULT) camera_rotate_to_euler_angle(const FVector3 &angles);
 
   CPPAPI_FUNC(HRESULT) camera_rotate_by_euler_angle(const FVector3 &angles);
 
   CPPAPI_FUNC(FVector3) camera_center();
 
   CPPAPI_FUNC(FQuaternion) camera_rotation();
 
   CPPAPI_FUNC(float) camera_zoom();
 
   CPPAPI_FUNC(struct rendering::UniverseRenderer*) get_renderer();
 
   CPPAPI_FUNC(const bool) get_rendering_3d_bonds();
 
   CPPAPI_FUNC(void) set_rendering_3d_bonds(const bool &_flag);
 
   CPPAPI_FUNC(void) toggle_rendering_3d_bonds();
 
   CPPAPI_FUNC(const bool) get_rendering_3d_angles();
 
   CPPAPI_FUNC(void) set_rendering_3d_angles(const bool &_flag);
 
   CPPAPI_FUNC(void) toggle_rendering_3d_angles();
 
   CPPAPI_FUNC(const bool) get_rendering_3d_dihedrals();
 
   CPPAPI_FUNC(void) set_rendering_3d_dihedrals(const bool &_flag);
 
   CPPAPI_FUNC(void) toggle_rendering_3d_dihedrals();
 
   CPPAPI_FUNC(void) set_rendering_3d_all(const bool &_flag);
 
   CPPAPI_FUNC(void) toggle_rendering_3d_all();
 
   CPPAPI_FUNC(FloatP_t) get_line_width();
 
   CPPAPI_FUNC(HRESULT) set_line_width(const FloatP_t &lineWidth);
 
   CPPAPI_FUNC(FloatP_t) get_line_width_min();
 
   CPPAPI_FUNC(FloatP_t) get_line_width_max();
 
   CPPAPI_FUNC(FVector3) get_ambient_color();
 
   CPPAPI_FUNC(HRESULT) set_ambient_color(const FVector3 &color);
 
   CPPAPI_FUNC(HRESULT) set_ambient_color(const FVector3 &color, const unsigned int &srFlag);
 
   CPPAPI_FUNC(FVector3) get_diffuse_color();
 
   CPPAPI_FUNC(HRESULT) set_diffuse_color(const FVector3 &color);
 
   CPPAPI_FUNC(HRESULT) set_diffuse_color(const FVector3 &color, const unsigned int &srFlag);
 
   CPPAPI_FUNC(FVector3) get_specular_color();
 
   CPPAPI_FUNC(HRESULT) set_specular_color(const FVector3 &color);
 
   CPPAPI_FUNC(HRESULT) set_specular_color(const FVector3 &color, const unsigned int &srFlag);
 
   CPPAPI_FUNC(float) get_shininess();
 
   CPPAPI_FUNC(HRESULT) set_shininess(const float &shininess);
 
   CPPAPI_FUNC(HRESULT) set_shininess(const float &shininess, const unsigned int &srFlag);
 
   CPPAPI_FUNC(FVector3) get_grid_color();
 
   CPPAPI_FUNC(HRESULT) set_grid_color(const FVector3 &color);
 
   CPPAPI_FUNC(FVector3) get_scene_box_color();
 
   CPPAPI_FUNC(HRESULT) set_scene_box_color(const FVector3 &color);
 
   CPPAPI_FUNC(FVector3) get_light_direction();
 
   CPPAPI_FUNC(HRESULT) set_light_direction(const FVector3& lightDir);
 
   CPPAPI_FUNC(HRESULT) set_light_direction(const FVector3& lightDir, const unsigned int &srFlag);
 
   CPPAPI_FUNC(FVector3) get_light_color();
 
   CPPAPI_FUNC(HRESULT) set_light_color(const FVector3 &color);
 
   CPPAPI_FUNC(HRESULT) set_light_color(const FVector3 &color, const unsigned int &srFlag);
 
   CPPAPI_FUNC(FVector3) get_background_color();
 
   CPPAPI_FUNC(HRESULT) set_background_color(const FVector3 &color);
 
   CPPAPI_FUNC(bool) decorated();
 
   CPPAPI_FUNC(HRESULT) decorate_scene(const bool &decorate);
 
   CPPAPI_FUNC(bool) showing_discretization();
 
   CPPAPI_FUNC(HRESULT) show_discretization(const bool &show);
 
   CPPAPI_FUNC(FVector3) get_discretizationColor();
 
   CPPAPI_FUNC(HRESULT) set_discretizationColor(const FVector3 &color);
 
   /* Update screen size after the window has been resized */
   CPPAPI_FUNC(HRESULT) view_reshape(const iVector2 &windowSize);
 
   CPPAPI_FUNC(std::string) performance_counters();
   
   CPPAPI_FUNC(std::unordered_map<std::string, bool>) cpu_info();
 
   CPPAPI_FUNC(std::unordered_map<std::string, bool>) compile_flags();
 
   CPPAPI_FUNC(std::unordered_map<std::string, std::string>) gl_info();
 
   CPPAPI_FUNC(std::string) egl_info();
 
   CPPAPI_FUNC(PyObject*) image_data();
 
   CPPAPI_FUNC(bool) is_terminal_interactive();
 
   CPPAPI_FUNC(bool) is_jupyter_notebook();
 
   CPPAPI_FUNC(PyObject*) jwidget_init(PyObject *args, PyObject *kwargs);
   CPPAPI_FUNC(PyObject*) jwidget_run(PyObject *args, PyObject *kwargs);
 
   CPPAPI_FUNC(std::vector<std::string>) color_mapper_names();
 
   CPPAPI_FUNC(int) add_render_arrow(rendering::ArrowData *arrow);
 
   CPPAPI_FUNC(std::pair<int, rendering::ArrowData*>) add_render_arrow(
      const FVector3 &position, 
      const FVector3 &components, 
      const rendering::Style &style, 
      const float &scale=1.0
   );
 
   CPPAPI_FUNC(HRESULT) remove_render_arrow(const int &arrowId);
 
   CPPAPI_FUNC(rendering::ArrowData*) get_render_arrow(const int &arrowId);
 
};
 
#endif // _SOURCE_LANGS_PY_TF_SYSTEMPY_H_