Tissue Forge C++ 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
tfIO.h
Go to the documentation of this file.
1/*******************************************************************************
2 * This file is part of Tissue Forge.
3 * Copyright (c) 2022-2024 T.J. Sego
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published
7 * by the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 ******************************************************************************/
19
25#ifndef _SOURCE_IO_TFIO_H_
26#define _SOURCE_IO_TFIO_H_
27
28#include <TissueForge_private.h>
29
30#include "tfThreeDFStructure.h"
31
32
33namespace TissueForge::io {
34
35
47 CPPAPI_FUNC(ThreeDFStructure*) fromFile3DF(const std::string &filePath);
48
57 CPPAPI_FUNC(HRESULT) toFile3DF(const std::string &format, const std::string &filePath, const unsigned int &pRefinements=0);
58
65 CPPAPI_FUNC(HRESULT) toFile(const std::string &saveFilePath);
66
72 CPPAPI_FUNC(std::string) toString();
73
84 CPPAPI_FUNC(int) mapImportParticleId(const unsigned int &pId);
85
96 CPPAPI_FUNC(int) mapImportParticleTypeId(const unsigned int &pId);
97
98
99};
100
101#endif // _SOURCE_IO_TFIO_H_
Tissue Forge I/O.
Definition tfThreeDFAngleMeshGenerator.h:28
HRESULT toFile(const T &dataElement, const MetaData &metaData, IOElement &fileElement)
Convert an object to an intermediate I/O object.
std::string toString()
Return a simulation state as a JSON string.
HRESULT toFile3DF(const std::string &format, const std::string &filePath, const unsigned int &pRefinements=0)
Export engine state to a 3D format file.
ThreeDFStructure * fromFile3DF(const std::string &filePath)
Tissue Forge import/export interface.
int mapImportParticleId(const unsigned int &pId)
Get the id of a particle according to import data that corresponds to a particle id of current data.
int mapImportParticleTypeId(const unsigned int &pId)
Get the id of a particle type according to import data that corresponds to a particle type id of curr...
Container for relevant data found in a 3D data file.
Definition tfThreeDFStructure.h:61
int32_t HRESULT
Definition tf_port.h:255