TissueForge::io Namespace Reference

Tissue Forge I/O. More...

Classes
struct	_IOElementT
	Intermediate I/O class for reading/writing Tissue Forge objects to/from file/string. More...
struct	FIO
	Tissue Forge data import/export interface. More...
struct	FIOImportSummary
	Tissue Forge data import summary. More...
struct	FIOModule
	Interface for Tissue Forge peripheral module I/O (e.g., models) More...
struct	IOElement
	Container for _IOElement. More...
struct	MetaData
	Tissue Forge meta data. More...
struct	ThreeDFAngleMeshGenerator
struct	ThreeDFBondMeshGenerator
struct	ThreeDFComponentContainer
struct	ThreeDFDihedralMeshGenerator
struct	ThreeDFEdgeData
	3D data file edge data More...
struct	ThreeDFFaceData
	3D data file face data More...
struct	ThreeDFIO
struct	ThreeDFMeshData
	3D data file mesh data More...
struct	ThreeDFMeshGenerator
struct	ThreeDFPCloudMeshGenerator
struct	ThreeDFRenderData
struct	ThreeDFStructure
	Container for relevant data found in a 3D data file. More...
struct	ThreeDFVertexData
	3D data file vertex data More...

Typedefs
using	_IOElement = _IOElementT<struct IOElement>
using	IOChildMap = std::unordered_map<std::string, struct IOElement>

Functions
HRESULT	generateBallMesh (ThreeDFMeshData *mesh, std::vector< ThreeDFFaceData * > *faces, std::vector< ThreeDFEdgeData * > *edges, std::vector< ThreeDFVertexData * > *vertices, std::vector< FVector3 > *normals, const FloatP_t &radius=1.0, const FVector3 &offset={0.f, 0.f, 0.f}, const unsigned int &numDivs=0)
	Adds elements of a ball at a point to a mesh.
HRESULT	generateCylinderMesh (ThreeDFMeshData *mesh, std::vector< ThreeDFFaceData * > *faces, std::vector< ThreeDFEdgeData * > *edges, std::vector< ThreeDFVertexData * > *vertices, std::vector< FVector3 > *normals, const FloatP_t &radius=1.0, const FVector3 &startPt={0.f, 0.f, 0.f}, const FVector3 &endPt={1.f, 1.f, 1.f}, const unsigned int &numDivs=0)
template<typename T>
HRESULT	toFile (const T &dataElement, const MetaData &metaData, IOElement &fileElement)
	Convert an object to an intermediate I/O object.
template<typename T>
HRESULT	toFile (T *dataElement, const MetaData &metaData, IOElement &fileElement)
	Convert an object to an intermediate I/O object.
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, T *dataElement)
	Instantiate an object from an intermediate I/O object.
template<>
HRESULT	toFile (const MetaData &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, MetaData *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TVector2< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TVector2< T > *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TVector3< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TVector3< T > *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TVector4< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TVector4< T > *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TMatrix3< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TMatrix3< T > *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TMatrix4< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TMatrix4< T > *dataElement)
template<typename T>
HRESULT	toFile (const TissueForge::types::TQuaternion< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::types::TQuaternion< T > *dataElement)
template<>
HRESULT	toFile (const char &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, char *dataElement)
template<>
HRESULT	toFile (const signed char &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, signed char *dataElement)
template<>
HRESULT	toFile (const unsigned char &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, unsigned char *dataElement)
template<>
HRESULT	toFile (const short &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, short *dataElement)
template<>
HRESULT	toFile (const unsigned short &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, unsigned short *dataElement)
template<>
HRESULT	toFile (const int &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, int *dataElement)
template<>
HRESULT	toFile (const unsigned int &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, unsigned int *dataElement)
template<>
HRESULT	toFile (const bool &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, bool *dataElement)
template<>
HRESULT	toFile (const long &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, long *dataElement)
template<>
HRESULT	toFile (const unsigned long &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, unsigned long *dataElement)
template<>
HRESULT	toFile (const long long &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, long long *dataElement)
template<>
HRESULT	toFile (const unsigned long long &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, unsigned long long *dataElement)
template<>
HRESULT	toFile (const float &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, float *dataElement)
template<>
HRESULT	toFile (const double &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, double *dataElement)
template<>
HRESULT	toFile (const std::string &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::string *dataElement)
template<typename T>
HRESULT	toFile (const std::set< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::set< T > *dataElement)
template<typename T>
HRESULT	toFile (const std::unordered_set< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::unordered_set< T > *dataElement)
template<typename T>
HRESULT	toFile (const std::vector< T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	toFile (std::vector< T * > dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::vector< T > *dataElement)
template<typename S, typename T>
HRESULT	toFile (const std::map< S, T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename S, typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::map< S, T > *dataElement)
template<typename S, typename T>
HRESULT	toFile (const std::unordered_map< S, T > &dataElement, const MetaData &metaData, IOElement &fileElement)
template<typename S, typename T>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::unordered_map< S, T > *dataElement)
std::string	toStr (IOElement &fileElement, const MetaData &metaData)
	Generate a JSON string representation of an intermediate I/O object.
std::string	toStr (IOElement &fileElement)
	Generate a JSON string representation of an intermediate I/O object.
IOElement	fromStr (const std::string &str, const MetaData &metaData)
	Generate an intermediate I/O object from a JSON string.
IOElement	fromStr (const std::string &str)
	Generate an intermediate I/O object from a JSON string.
template<typename T>
std::string	toString (const T &dataElement, const MetaData &metaData)
	Generate a JSON string representation of an object.
template<typename T>
std::string	toString (const T &dataElement)
	Generate a JSON string representation of an object.
template<typename T>
T	fromString (const std::string &str, const MetaData &metaData)
	Generate an object from a JSON string.
template<typename T>
T	fromString (const std::string &str)
	Generate an object from a JSON string.
ThreeDFStructure *	fromFile3DF (const std::string &filePath)
	Tissue Forge import/export interface.
HRESULT	toFile3DF (const std::string &format, const std::string &filePath, const unsigned int &pRefinements=0)
	Export engine state to a 3D format file.
HRESULT	toFile (const std::string &saveFilePath)
	Save a simulation to file.
std::string	toString ()
	Return a simulation state as a JSON string.
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 current data.
template<>
HRESULT	toFile (const py::CustomForcePy &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, py::CustomForcePy *dataElement)
template<>
HRESULT	toFile (const Angle &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Angle *dataElement)
template<>
HRESULT	toFile (const Bond &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Bond *dataElement)
template<>
HRESULT	toFile (const BoundaryCondition &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, BoundaryCondition *dataElement)
template<>
HRESULT	toFile (const BoundaryConditions &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, BoundaryConditions *dataElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, BoundaryConditionsArgsContainer *dataElement)
template<>
HRESULT	toFile (const Dihedral &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Dihedral *dataElement)
template<>
HRESULT	toFile (const TypeIdPair &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TypeIdPair *dataElement)
template<>
HRESULT	toFile (const Flux &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Flux *dataElement)
template<>
HRESULT	toFile (const Fluxes &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Fluxes *dataElement)
template<>
HRESULT	toFile (const FORCE_TYPE &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, FORCE_TYPE *dataElement)
template<>
HRESULT	toFile (const CustomForce &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, CustomForce *dataElement)
template<>
HRESULT	toFile (const ForceSum &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, ForceSum *dataElement)
template<>
HRESULT	toFile (const Berendsen &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Berendsen *dataElement)
template<>
HRESULT	toFile (const Gaussian &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Gaussian *dataElement)
template<>
HRESULT	toFile (const Friction &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Friction *dataElement)
template<>
HRESULT	toFile (Force *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Force **dataElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, std::vector< Force * > *dataElement)
template<>
HRESULT	toFile (const Particle &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Particle *dataElement)
template<>
HRESULT	toFile (const ParticleType &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, ParticleType *dataElement)
template<>
HRESULT	toFile (const ParticleList &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, ParticleList *dataElement)
template<>
HRESULT	toFile (const ParticleTypeList &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, ParticleTypeList *dataElement)
template<>
HRESULT	toFile (Potential *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Potential **dataElement)
HRESULT	toFile (DPDPotential *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, DPDPotential **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::Vertex *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::Vertex **dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::VertexHandle &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::VertexHandle *dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::Surface *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::Surface **dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::SurfaceHandle &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::SurfaceHandle *dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::SurfaceType &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::SurfaceType **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::Body *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::Body **dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::BodyHandle &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::BodyHandle *dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::BodyType &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::BodyType **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::Mesh *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::Mesh *dataElement)
template<>
HRESULT	toFile (const TissueForge::models::vertex::MeshQuality &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::MeshQuality *dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::MeshObjActor *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::MeshObjActor **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::Adhesion *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::Adhesion **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::BodyForce *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::BodyForce **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::ConvexPolygonConstraint *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::ConvexPolygonConstraint **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::EdgeTension *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::EdgeTension **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::FlatSurfaceConstraint *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::FlatSurfaceConstraint **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::NormalStress *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::NormalStress **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::PerimeterConstraint *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::PerimeterConstraint **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::SurfaceAreaConstraint *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::SurfaceAreaConstraint **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::SurfaceTraction *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::SurfaceTraction **dataElement)
template<>
HRESULT	toFile (TissueForge::models::vertex::VolumeConstraint *dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::models::vertex::VolumeConstraint **dataElement)
template<>
HRESULT	toFile (const rendering::ColorMapper &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, rendering::ColorMapper *dataElement)
template<>
HRESULT	toFile (const rendering::Style &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, rendering::Style *dataElement)
template<>
HRESULT	toFile (const TissueForge::state::Species &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::state::Species *dataElement)
template<>
HRESULT	toFile (const TissueForge::state::SpeciesList &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::state::SpeciesList *dataElement)
template<>
HRESULT	toFile (const TissueForge::state::StateVector &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, TissueForge::state::StateVector **dataElement)
template<>
HRESULT	toFile (const Simulator &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Simulator::Config *dataElement)
template<>
HRESULT	toFile (const Universe &dataElement, const MetaData &metaData, IOElement &fileElement)
template<>
HRESULT	fromFile (const IOElement &fileElement, const MetaData &metaData, Universe *dataElement)

Detailed Description

Tissue Forge I/O.

Function Documentation

fromFile() [1/4]

template<typename T>

HRESULT TissueForge::io::fromFile	(	const IOElement &	fileElement,
		const MetaData &	metaData,
		T *	dataElement )

Instantiate an object from an intermediate I/O object.

Template Parameters

T	type of object to instantiate

Parameters

fileElement	source I/O object
metaData	meta data of exporting installation
dataElement	resulting object

Returns

HRESULT

fromFile() [2/4]

template<>

HRESULT TissueForge::io::fromFile	(	const IOElement &	fileElement,
		const MetaData &	metaData,
		TissueForge::models::vertex::Body **	dataElement )

Does not assemble mesh child connectivity

fromFile() [3/4]

template<>

HRESULT TissueForge::io::fromFile	(	const IOElement &	fileElement,
		const MetaData &	metaData,
		TissueForge::models::vertex::Surface **	dataElement )

Does not assemble mesh child connectivity

fromFile() [4/4]

template<>

HRESULT TissueForge::io::fromFile	(	const IOElement &	fileElement,
		const MetaData &	metaData,
		TissueForge::models::vertex::Vertex **	dataElement )

Does not assemble mesh child connectivity

fromFile3DF()

ThreeDFStructure * TissueForge::io::fromFile3DF

(

const std::string &

filePath

)

Tissue Forge import/export interface.

Load a 3D format file

Parameters

filePath

path of file

Returns

ThreeDFStructure* 3D format data container

fromStr() [1/2]

IOElement TissueForge::io::fromStr

(

const std::string &

str

)

Generate an intermediate I/O object from a JSON string.

Installation during string export is target installation.

Parameters

str	JSON string

Returns

IOElement

fromStr() [2/2]

IOElement TissueForge::io::fromStr	(	const std::string &	str,
		const MetaData &	metaData )

Generate an intermediate I/O object from a JSON string.

Parameters

str	JSON string
metaData	meta data of target installation

Returns

IOElement

fromString() [1/2]

template<typename T>

T TissueForge::io::fromString

(

const std::string &

str

)

Generate an object from a JSON string.

Current installation is target installation.

Template Parameters

T	type of object

Parameters

str	JSON string

Returns

T

fromString() [2/2]

template<typename T>

T TissueForge::io::fromString	(	const std::string &	str,
		const MetaData &	metaData )

Generate an object from a JSON string.

Template Parameters

T	type of object

Parameters

str	JSON string
metaData	meta data of target installation

Returns

T

generateBallMesh()

HRESULT TissueForge::io::generateBallMesh	(	ThreeDFMeshData *	mesh,
		std::vector< ThreeDFFaceData * > *	faces,
		std::vector< ThreeDFEdgeData * > *	edges,
		std::vector< ThreeDFVertexData * > *	vertices,
		std::vector< FVector3 > *	normals,
		const FloatP_t &	radius = 1.0,
		const FVector3 &	offset = {0.f, 0.f, 0.f},
		const unsigned int &	numDivs = 0 )

Adds elements of a ball at a point to a mesh.

Parameters

mesh	mesh to append
faces	generated faces
edges	generated edges
vertices	generated vertices
normals	generated normals
radius	radius of ball
offset	location of ball
numDivs	number of refinements

Returns

HRESULT

mapImportParticleId()

int TissueForge::io::mapImportParticleId

(

const unsigned int &

pId

)

Get the id of a particle according to import data that corresponds to a particle id of current data.

Only valid between initialization and the first simulation step, after which the import summary data is purged.

Parameters

pId	id of particle in exported data

Returns

int >=0 if particle is found; -1 otherwise

mapImportParticleTypeId()

int TissueForge::io::mapImportParticleTypeId

(

const unsigned int &

pId

)

Get the id of a particle type according to import data that corresponds to a particle type id of current data.

Only valid between initialization and the first simulation step, after which the import summary data is purged.

Parameters

pId	id of particle type in exported data

Returns

int >=0 if particle type is found; -1 otherwise

toFile() [1/3]

HRESULT TissueForge::io::toFile

(

const std::string &

saveFilePath

)

Save a simulation to file.

Parameters

saveFilePath

absolute path to file

Returns

HRESULT

toFile() [2/3]

template<typename T>

HRESULT TissueForge::io::toFile	(	const T &	dataElement,
		const MetaData &	metaData,
		IOElement &	fileElement )

Convert an object to an intermediate I/O object.

Template Parameters

T	type of object to convert

Parameters

dataElement	object to convert
metaData	meta data of target installation
fileElement	resulting I/O object

Returns

HRESULT

toFile() [3/3]

template<typename T>

HRESULT TissueForge::io::toFile	(	T *	dataElement,
		const MetaData &	metaData,
		IOElement &	fileElement )

Convert an object to an intermediate I/O object.

Template Parameters

T	type of object to convert

Parameters

dataElement	object to convert
metaData	meta data of target installation
fileElement	resulting I/O object

Returns

HRESULT

toFile3DF()

HRESULT TissueForge::io::toFile3DF	(	const std::string &	format,
		const std::string &	filePath,
		const unsigned int &	pRefinements = 0 )

Export engine state to a 3D format file.

Parameters

format	format of file
filePath	path of file
pRefinements	mesh refinements applied when generating meshes

Returns

HRESULT

toStr() [1/2]

std::string TissueForge::io::toStr

(

IOElement &

fileElement

)

Generate a JSON string representation of an intermediate I/O object.

Current installation is target installation.

Parameters

fileElement

object to convert

Returns

std::string

toStr() [2/2]

std::string TissueForge::io::toStr	(	IOElement &	fileElement,
		const MetaData &	metaData )

Generate a JSON string representation of an intermediate I/O object.

Parameters

fileElement	object to convert
metaData	meta data of target installation

Returns

std::string

toString() [1/3]

std::string TissueForge::io::toString

(

)

Return a simulation state as a JSON string.

Returns

std::string

toString() [2/3]

template<typename T>

std::string TissueForge::io::toString

(

const T &

dataElement

)

Generate a JSON string representation of an object.

Current installation is target installation.

Template Parameters

T	type of source object

Parameters

dataElement

source object

Returns

std::string

toString() [3/3]

template<typename T>

std::string TissueForge::io::toString	(	const T &	dataElement,
		const MetaData &	metaData )

Generate a JSON string representation of an object.

Template Parameters

T	type of source object

Parameters

dataElement	source object
metaData	meta data of target installation

Returns

std::string