tf_system.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_TF_SYSTEM_H_
#define _SOURCE_TF_SYSTEM_H_
 
#include "TissueForge_private.h"
#include "tf_util.h"
#include "tfLogger.h"
#include "rendering/tfGlInfo.h"
#include "rendering/tfEglInfo.h"
#include "rendering/tfUniverseRenderer.h"
#include "rendering/tfArrowRenderer.h"
 
 
namespace TissueForge::system {
 
 
    CPPAPI_FUNC(void) printPerformanceCounters();
 
    HRESULT LoggerCallbackImpl(LogEvent, std::ostream *);
 
    CPPAPI_FUNC(std::tuple<char*, size_t>) imageData();

    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) contextHasCurrent();
    CPPAPI_FUNC(HRESULT) contextMakeCurrent();
    CPPAPI_FUNC(HRESULT) contextRelease();

    CPPAPI_FUNC(bool) cameraIsLagging();

    CPPAPI_FUNC(HRESULT) cameraEnableLagging();

    CPPAPI_FUNC(HRESULT) cameraDisableLagging();

    CPPAPI_FUNC(HRESULT) cameraToggleLagging();

    CPPAPI_FUNC(float) cameraGetLagging();

    CPPAPI_FUNC(HRESULT) cameraSetLagging(const float &lagging);

    CPPAPI_FUNC(HRESULT) cameraMoveTo(const FVector3 &eye, const FVector3 &center, const FVector3 &up);

    CPPAPI_FUNC(HRESULT) cameraMoveTo(const FVector3 &center, const FQuaternion &rotation, const float &zoom);

    CPPAPI_FUNC(HRESULT) cameraViewBottom();

    CPPAPI_FUNC(HRESULT) cameraViewTop();

    CPPAPI_FUNC(HRESULT) cameraViewLeft();

    CPPAPI_FUNC(HRESULT) cameraViewRight();

    CPPAPI_FUNC(HRESULT) cameraViewBack();

    CPPAPI_FUNC(HRESULT) cameraViewFront();

    CPPAPI_FUNC(HRESULT) cameraReset();
 
    /* Rotate the camera from the previous (screen) mouse position to the
    current (screen) position */
    CPPAPI_FUNC(HRESULT) cameraRotateMouse(const iVector2 &mousePos);
 
    /* Translate the camera from the previous (screen) mouse position to
    the current (screen) mouse position */
    CPPAPI_FUNC(HRESULT) cameraTranslateMouse(const iVector2 &mousePos);

    CPPAPI_FUNC(HRESULT) cameraTranslateDown();

    CPPAPI_FUNC(HRESULT) cameraTranslateUp();

    CPPAPI_FUNC(HRESULT) cameraTranslateRight();

    CPPAPI_FUNC(HRESULT) cameraTranslateLeft();

    CPPAPI_FUNC(HRESULT) cameraTranslateForward();

    CPPAPI_FUNC(HRESULT) cameraTranslateBackward();

    CPPAPI_FUNC(HRESULT) cameraRotateDown();

    CPPAPI_FUNC(HRESULT) cameraRotateUp();

    CPPAPI_FUNC(HRESULT) cameraRotateLeft();

    CPPAPI_FUNC(HRESULT) cameraRotateRight();

    CPPAPI_FUNC(HRESULT) cameraRollLeft();

    CPPAPI_FUNC(HRESULT) cameraRollRight();

    CPPAPI_FUNC(HRESULT) cameraZoomIn();

    CPPAPI_FUNC(HRESULT) cameraZoomOut();
 
    /* Rotate the camera from the previous (screen) mouse position to the
    current (screen) position */
    CPPAPI_FUNC(HRESULT) cameraInitMouse(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) cameraTranslateBy(const FVector2 &trans);

    CPPAPI_FUNC(HRESULT) cameraZoomBy(const float &delta);

    CPPAPI_FUNC(HRESULT) cameraZoomTo(const float &distance);

    CPPAPI_FUNC(HRESULT) cameraRotateToAxis(const FVector3 &axis, const float &distance);

    CPPAPI_FUNC(HRESULT) cameraRotateToEulerAngle(const FVector3 &angles);

    CPPAPI_FUNC(HRESULT) cameraRotateByEulerAngle(const FVector3 &angles);

    CPPAPI_FUNC(FVector3) cameraCenter();

    CPPAPI_FUNC(FQuaternion) cameraRotation();

    CPPAPI_FUNC(float) cameraZoom();
    
    CPPAPI_FUNC(struct rendering::UniverseRenderer*) getRenderer();

    CPPAPI_FUNC(const bool) getRendering3DBonds();

    CPPAPI_FUNC(void) setRendering3DBonds(const bool &_flag);

    CPPAPI_FUNC(void) toggleRendering3DBonds();

    CPPAPI_FUNC(const bool) getRendering3DAngles();

    CPPAPI_FUNC(void) setRendering3DAngles(const bool &_flag);

    CPPAPI_FUNC(void) toggleRendering3DAngles();

    CPPAPI_FUNC(const bool) getRendering3DDihedrals();

    CPPAPI_FUNC(void) setRendering3DDihedrals(const bool &_flag);

    CPPAPI_FUNC(void) toggleRendering3DDihedrals();

    CPPAPI_FUNC(void) setRendering3DAll(const bool &_flag);

    CPPAPI_FUNC(void) toggleRendering3DAll();

    CPPAPI_FUNC(const FloatP_t) getLineWidth();

    CPPAPI_FUNC(HRESULT) setLineWidth(const FloatP_t &lineWidth);

    CPPAPI_FUNC(const FloatP_t) getLineWidthMin();

    CPPAPI_FUNC(const FloatP_t) getLineWidthMax();

    CPPAPI_FUNC(FVector3) getAmbientColor();

    CPPAPI_FUNC(HRESULT) setAmbientColor(const FVector3 &color);

    CPPAPI_FUNC(HRESULT) setAmbientColor(const FVector3 &color, const unsigned int &srFlag);

    CPPAPI_FUNC(FVector3) getDiffuseColor();

    CPPAPI_FUNC(HRESULT) setDiffuseColor(const FVector3 &color);

    CPPAPI_FUNC(HRESULT) setDiffuseColor(const FVector3 &color, const unsigned int &srFlag);

    CPPAPI_FUNC(FVector3) getSpecularColor();

    CPPAPI_FUNC(HRESULT) setSpecularColor(const FVector3 &color);

    CPPAPI_FUNC(HRESULT) setSpecularColor(const FVector3 &color, const unsigned int &srFlag);

    CPPAPI_FUNC(float) getShininess();

    CPPAPI_FUNC(HRESULT) setShininess(const float &shininess);

    CPPAPI_FUNC(HRESULT) setShininess(const float &shininess, const unsigned int &srFlag);

    CPPAPI_FUNC(FVector3) getGridColor();

    CPPAPI_FUNC(HRESULT) setGridColor(const FVector3 &color);

    CPPAPI_FUNC(FVector3) getSceneBoxColor();

    CPPAPI_FUNC(HRESULT) setSceneBoxColor(const FVector3 &color);

    CPPAPI_FUNC(FVector3) getLightDirection();

    CPPAPI_FUNC(HRESULT) setLightDirection(const FVector3& lightDir);

    CPPAPI_FUNC(HRESULT) setLightDirection(const FVector3& lightDir, const unsigned int &srFlag);

    CPPAPI_FUNC(FVector3) getLightColor();

    CPPAPI_FUNC(HRESULT) setLightColor(const FVector3 &color);

    CPPAPI_FUNC(HRESULT) setLightColor(const FVector3 &color, const unsigned int &srFlag);

    CPPAPI_FUNC(FVector3) getBackgroundColor();

    CPPAPI_FUNC(HRESULT) setBackgroundColor(const FVector3 &color);

    CPPAPI_FUNC(bool) decorated();

    CPPAPI_FUNC(HRESULT) decorateScene(const bool &decorate);

    CPPAPI_FUNC(bool) showingDiscretization();

    CPPAPI_FUNC(HRESULT) showDiscretization(const bool &show);

    CPPAPI_FUNC(FVector3) getDiscretizationColor();

    CPPAPI_FUNC(HRESULT) setDiscretizationColor(const FVector3 &color);
 
    /* Update screen size after the window has been resized */
    CPPAPI_FUNC(HRESULT) viewReshape(const iVector2 &windowSize);
 
    CPPAPI_FUNC(std::string) performanceCounters();

    CPPAPI_FUNC(std::unordered_map<std::string, bool>) cpu_info();

    CPPAPI_FUNC(std::list<std::string>) compile_flags();

    CPPAPI_FUNC(std::unordered_map<std::string, std::string>) gl_info();

    CPPAPI_FUNC(std::string) egl_info();

    CPPAPI_FUNC(std::vector<std::string>) colorMapperNames();

    CPPAPI_FUNC(int) addRenderArrow(rendering::ArrowData *arrow);

    CPPAPI_FUNC(std::pair<int, rendering::ArrowData*>) addRenderArrow(
        const FVector3 &position, 
        const FVector3 &components, 
        const rendering::Style &style, 
        const float &scale=1.0
    );

    CPPAPI_FUNC(HRESULT) removeRenderArrow(const int &arrowId);

    CPPAPI_FUNC(rendering::ArrowData*) getRenderArrow(const int &arrowId);
 
};
 
#endif // _SOURCE_TF_SYSTEM_H_