#include "tf_port_c.h"

Include dependency graph for tfC_io.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	tfIoMetaDataHandle

struct	tfIoFIOStorageKeysHandle

struct	tfIoIOElementHandle
	Handle to a io::IOElement instance. More...

struct	tfIoThreeDFRenderDataHandle
	Handle to a io::ThreeDFRenderData instance. More...

struct	tfIoThreeDFVertexDataHandle
	Handle to a io::ThreeDFVertexData instance. More...

struct	tfIoThreeDFEdgeDataHandle
	Handle to a io::ThreeDFEdgeData instance. More...

struct	tfIoThreeDFFaceDataHandle
	Handle to a io::ThreeDFFaceData instance. More...

struct	tfIoThreeDFMeshDataHandle
	Handle to a io::ThreeDFMeshData instance. More...

struct	tfIoThreeDFStructureHandle
	Handle to a io::ThreeDFStructure instance. More...

struct	tfIoFIOModuleHandle
	Handle to a io::FIOModule instance. More...

Typedefs
typedef HRESULT(*	tfIoFIOModuleToFileFcn) (struct tfIoMetaDataHandle, struct tfIoIOElementHandle *)

typedef HRESULT(*	tfIoFIOModuleFromFileFcn) (struct tfIoMetaDataHandle, struct tfIoIOElementHandle)

Functions
HRESULT	tfIoMetaData_init (struct tfIoMetaDataHandle *handle)
	Initialize an instance.

HRESULT	tfIoFIOStorageKeys_init (struct tfIoFIOStorageKeysHandle *handle)
	Initialize an instance.

HRESULT	tfIoFIOStorageKeys_destroy (struct tfIoFIOStorageKeysHandle *handle)
	Destroy an instance.

HRESULT	tfIoIOElement_init (struct tfIoIOElementHandle *handle)
	Initialize an empty instance.

HRESULT	tfIoIOElement_destroy (struct tfIoIOElementHandle *handle)
	Destroy an instance.

HRESULT	tfIoIOElement_getType (struct tfIoIOElementHandle handle, char type, unsigned int numChars)
	Get the instance value type.

HRESULT	tfIoIOElement_setType (struct tfIoIOElementHandle handle, const char type)
	Set the instance value type.

HRESULT	tfIoIOElement_getValue (struct tfIoIOElementHandle handle, char value, unsigned int numChars)
	Get the instance value.

HRESULT	tfIoIOElement_setValue (struct tfIoIOElementHandle handle, const char value)
	Set the instance value.

HRESULT	tfIoIOElement_hasParent (struct tfIoIOElementHandle handle, bool hasParent)
	Test whether an instance has a parent element.

HRESULT	tfIoIOElement_getParent (struct tfIoIOElementHandle handle, struct tfIoIOElementHandle parent)
	Get an instance parent.

HRESULT	tfIoIOElement_setParent (struct tfIoIOElementHandle handle, struct tfIoIOElementHandle parent)
	Set an instance parent.

HRESULT	tfIoIOElement_getNumChildren (struct tfIoIOElementHandle handle, unsigned int numChildren)
	Get the number of child elements.

HRESULT	tfIoIOElement_getKeys (struct tfIoIOElementHandle handle, char **keys)
	Get the child element keys.

HRESULT	tfIoIOElement_getChild (struct tfIoIOElementHandle handle, const char key, struct tfIoIOElementHandle *child)
	Get a child.

HRESULT	tfIoIOElement_setChild (struct tfIoIOElementHandle handle, const char key, struct tfIoIOElementHandle *child)
	Set a child.

HRESULT	tfIoThreeDFRenderData_init (struct tfIoThreeDFRenderDataHandle *handle)
	Initialize an instance.

HRESULT	tfIoThreeDFRenderData_destroy (struct tfIoThreeDFRenderDataHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFRenderData_getColor (struct tfIoThreeDFRenderDataHandle handle, tfFloatP_t *color)
	Get the color.

HRESULT	tfIoThreeDFRenderData_setColor (struct tfIoThreeDFRenderDataHandle handle, tfFloatP_t color)
	Set the color.

HRESULT	tfIoThreeDFVertexData_init (struct tfIoThreeDFVertexDataHandle handle, tfFloatP_t position)
	Initialize an instance.

HRESULT	tfIoThreeDFVertexData_destroy (struct tfIoThreeDFVertexDataHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFVertexData_hasStructure (struct tfIoThreeDFVertexDataHandle handle, bool hasStructure)
	Test whether an instance has a parent structure.

HRESULT	tfIoThreeDFVertexData_getStructure (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Get the parent structure.

HRESULT	tfIoThreeDFVertexData_setStructure (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Set the parent structure.

HRESULT	tfIoThreeDFVertexData_getPosition (struct tfIoThreeDFVertexDataHandle handle, tfFloatP_t *position)
	Get the global position.

HRESULT	tfIoThreeDFVertexData_setPosition (struct tfIoThreeDFVertexDataHandle handle, tfFloatP_t position)
	Set the global position.

HRESULT	tfIoThreeDFVertexData_getId (struct tfIoThreeDFVertexDataHandle handle, int value)
	Get the ID, if any. Unique to its structure and type. -1 if not set.

HRESULT	tfIoThreeDFVertexData_setId (struct tfIoThreeDFVertexDataHandle *handle, unsigned int value)
	Set the ID.

HRESULT	tfIoThreeDFVertexData_getEdges (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Get all parent edges.

HRESULT	tfIoThreeDFVertexData_setEdges (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Set all parent edges.

HRESULT	tfIoThreeDFVertexData_getFaces (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Get all parent faces.

HRESULT	tfIoThreeDFVertexData_getMeshes (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFMeshDataHandle meshes, unsigned int numMeshes)
	Get all parent meshes.

HRESULT	tfIoThreeDFVertexData_getNumEdges (struct tfIoThreeDFVertexDataHandle handle, unsigned int value)
	Get the number of parent edges.

HRESULT	tfIoThreeDFVertexData_getNumFaces (struct tfIoThreeDFVertexDataHandle handle, unsigned int value)
	Get the number of parent faces.

HRESULT	tfIoThreeDFVertexData_getNumMeshes (struct tfIoThreeDFVertexDataHandle handle, unsigned int value)
	Get the number of parent meshes.

HRESULT	tfIoThreeDFVertexData_inEdge (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFEdgeDataHandle edge, bool *isIn)
	Test whether in an edge.

HRESULT	tfIoThreeDFVertexData_inFace (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFFaceDataHandle face, bool *isIn)
	Test whether in a face.

HRESULT	tfIoThreeDFVertexData_inMesh (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFMeshDataHandle mesh, bool *isIn)
	Test whether in a mesh.

HRESULT	tfIoThreeDFVertexData_inStructure (struct tfIoThreeDFVertexDataHandle handle, struct tfIoThreeDFStructureHandle structure, bool *isIn)
	Test whether in a structure.

HRESULT	tfIoThreeDFEdgeData_init (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFVertexDataHandle va, struct tfIoThreeDFVertexDataHandle *vb)
	Initialize an instance.

HRESULT	tfIoThreeDFEdgeData_destroy (struct tfIoThreeDFEdgeDataHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFEdgeData_hasStructure (struct tfIoThreeDFEdgeDataHandle handle, bool hasStructure)
	Test whether an instance has a parent structure.

HRESULT	tfIoThreeDFEdgeData_getStructure (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Get the parent structure.

HRESULT	tfIoThreeDFEdgeData_setStructure (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Set the parent structure.

HRESULT	tfIoThreeDFEdgeData_getId (struct tfIoThreeDFEdgeDataHandle handle, int value)
	Get the ID, if any. Unique to its structure and type. -1 if not set.

HRESULT	tfIoThreeDFEdgeData_setId (struct tfIoThreeDFEdgeDataHandle *handle, unsigned int value)
	Set the ID.

HRESULT	tfIoThreeDFEdgeData_getVertices (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFVertexDataHandle va, struct tfIoThreeDFVertexDataHandle *vb)
	Get all child vertices.

HRESULT	tfIoThreeDFEdgeData_setVertices (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFVertexDataHandle va, struct tfIoThreeDFVertexDataHandle *vb)
	Set all child vertices.

HRESULT	tfIoThreeDFEdgeData_getFaces (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Get all parent faces.

HRESULT	tfIoThreeDFEdgeData_setFaces (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Set all parent faces.

HRESULT	tfIoThreeDFEdgeData_getMeshes (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFMeshDataHandle meshes, unsigned int numMeshes)
	Get all parent meshes.

HRESULT	tfIoThreeDFEdgeData_getNumFaces (struct tfIoThreeDFEdgeDataHandle handle, unsigned int value)
	Get the number of parent faces.

HRESULT	tfIoThreeDFEdgeData_getNumMeshes (struct tfIoThreeDFEdgeDataHandle handle, unsigned int value)
	Get the number of parent meshes.

HRESULT	tfIoThreeDFEdgeData_hasVertex (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFVertexDataHandle vertex, bool *isIn)
	Test whether has a vertex.

HRESULT	tfIoThreeDFEdgeData_inFace (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFFaceDataHandle face, bool *isIn)
	Test whether in a face.

HRESULT	tfIoThreeDFEdgeData_inMesh (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFMeshDataHandle mesh, bool *isIn)
	Test whether in a mesh.

HRESULT	tfIoThreeDFEdgeData_inStructure (struct tfIoThreeDFEdgeDataHandle handle, struct tfIoThreeDFStructureHandle structure, bool *isIn)
	Test whether in a structure.

HRESULT	tfIoThreeDFFaceData_init (struct tfIoThreeDFFaceDataHandle *handle)
	Initialize an instance.

HRESULT	tfIoThreeDFFaceData_destroy (struct tfIoThreeDFFaceDataHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFFaceData_hasStructure (struct tfIoThreeDFFaceDataHandle handle, bool hasStructure)
	Test whether an instance has a parent structure.

HRESULT	tfIoThreeDFFaceData_getStructure (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Get the parent structure.

HRESULT	tfIoThreeDFFaceData_setStructure (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Set the parent structure.

HRESULT	tfIoThreeDFFaceData_getId (struct tfIoThreeDFFaceDataHandle handle, int value)
	Get the ID, if any. Unique to its structure and type. -1 if not set.

HRESULT	tfIoThreeDFFaceData_setId (struct tfIoThreeDFFaceDataHandle *handle, unsigned int value)
	Set the ID.

HRESULT	tfIoThreeDFFaceData_getVertices (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFVertexDataHandle vertices, unsigned int numVertices)
	Get all child vertices.

HRESULT	tfIoThreeDFFaceData_getNumVertices (struct tfIoThreeDFFaceDataHandle handle, unsigned int value)
	Get the number of child vertices.

HRESULT	tfIoThreeDFFaceData_getEdges (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Get all child edges.

HRESULT	tfIoThreeDFFaceData_setEdges (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Set all child edges.

HRESULT	tfIoThreeDFFaceData_getNumEdges (struct tfIoThreeDFFaceDataHandle handle, unsigned int value)
	Get the number of child edges.

HRESULT	tfIoThreeDFFaceData_getMeshes (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFMeshDataHandle meshes, unsigned int numMeshes)
	Get all parent meshes.

HRESULT	tfIoThreeDFFaceData_setMeshes (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFMeshDataHandle meshes, unsigned int numMeshes)
	Set all parent meshes.

HRESULT	tfIoThreeDFFaceData_getNumMeshes (struct tfIoThreeDFFaceDataHandle handle, unsigned int value)
	Get the number of parent meshes.

HRESULT	tfIoThreeDFFaceData_hasVertex (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFVertexDataHandle vertex, bool *isIn)
	Test whether has a vertex.

HRESULT	tfIoThreeDFFaceData_hasEdge (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFEdgeDataHandle edge, bool *isIn)
	Test whether has an edge.

HRESULT	tfIoThreeDFFaceData_inMesh (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFMeshDataHandle mesh, bool *isIn)
	Test whether in a mesh.

HRESULT	tfIoThreeDFFaceData_inStructure (struct tfIoThreeDFFaceDataHandle handle, struct tfIoThreeDFStructureHandle structure, bool *isIn)
	Test whether in a structure.

HRESULT	tfIoThreeDFFaceData_getNormal (struct tfIoThreeDFFaceDataHandle handle, tfFloatP_t *normal)
	Get the face normal vector.

HRESULT	tfIoThreeDFFaceData_setNormal (struct tfIoThreeDFFaceDataHandle handle, tfFloatP_t normal)
	Set the face normal vector.

HRESULT	tfIoThreeDFMeshData_init (struct tfIoThreeDFMeshDataHandle *handle)
	Initialize an instance.

HRESULT	tfIoThreeDFMeshData_destroy (struct tfIoThreeDFMeshDataHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFMeshData_hasStructure (struct tfIoThreeDFMeshDataHandle handle, bool hasStructure)
	Test whether an instance has a parent structure.

HRESULT	tfIoThreeDFMeshData_getStructure (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Get the parent structure.

HRESULT	tfIoThreeDFMeshData_setStructure (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFStructureHandle structure)
	Set the parent structure.

HRESULT	tfIoThreeDFMeshData_getId (struct tfIoThreeDFMeshDataHandle handle, int value)
	Get the ID, if any. Unique to its structure and type. -1 if not set.

HRESULT	tfIoThreeDFMeshData_setId (struct tfIoThreeDFMeshDataHandle *handle, unsigned int value)
	Set the ID.

HRESULT	tfIoThreeDFMeshData_getVertices (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFVertexDataHandle vertices, unsigned int numVertices)
	Get all child vertices.

HRESULT	tfIoThreeDFMeshData_getNumVertices (struct tfIoThreeDFMeshDataHandle handle, unsigned int value)
	Get the number of child vertices.

HRESULT	tfIoThreeDFMeshData_getEdges (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Get all child edges.

HRESULT	tfIoThreeDFMeshData_getNumEdges (struct tfIoThreeDFMeshDataHandle handle, unsigned int value)
	Get the number of child edges.

HRESULT	tfIoThreeDFMeshData_getFaces (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Get all child faces.

HRESULT	tfIoThreeDFMeshData_setFaces (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Get all child faces.

HRESULT	tfIoThreeDFMeshData_getNumFaces (struct tfIoThreeDFMeshDataHandle handle, unsigned int value)
	Get the number of child faces.

HRESULT	tfIoThreeDFMeshData_hasVertex (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFVertexDataHandle vertex, bool *isIn)
	Test whether has a vertex.

HRESULT	tfIoThreeDFMeshData_hasEdge (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFEdgeDataHandle edge, bool *isIn)
	Test whether has an edge.

HRESULT	tfIoThreeDFMeshData_hasFace (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFFaceDataHandle face, bool *isIn)
	Test whether has a face.

HRESULT	tfIoThreeDFMeshData_inStructure (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFStructureHandle structure, bool *isIn)
	Test whether in a structure.

HRESULT	tfIoThreeDFMeshData_getName (struct tfIoThreeDFMeshDataHandle handle, char name, unsigned int numChars)
	Get the mesh name.

HRESULT	tfIoThreeDFMeshData_setName (struct tfIoThreeDFMeshDataHandle handle, const char name)
	Set the mesh name.

HRESULT	tfIoThreeDFMeshData_hasRenderData (struct tfIoThreeDFMeshDataHandle handle, bool hasData)
	Test whether has render data.

HRESULT	tfIoThreeDFMeshData_getRenderData (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFRenderDataHandle renderData)
	Get render data.

HRESULT	tfIoThreeDFMeshData_setRenderData (struct tfIoThreeDFMeshDataHandle handle, struct tfIoThreeDFRenderDataHandle renderData)
	Set render data.

HRESULT	tfIoThreeDFMeshData_getCentroid (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t *centroid)
	Get the centroid of the mesh.

HRESULT	tfIoThreeDFMeshData_translate (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t displacement)
	Translate the mesh by a displacement.

HRESULT	tfIoThreeDFMeshData_translateTo (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t position)
	Translate the mesh to a position.

HRESULT	tfIoThreeDFMeshData_rotateAt (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t rotMat, tfFloatP_t *rotPt)
	Rotate the mesh about a point.

HRESULT	tfIoThreeDFMeshData_rotate (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t rotMat)
	Rotate the mesh about its centroid.

HRESULT	tfIoThreeDFMeshData_scaleFrom (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t scales, tfFloatP_t *scalePt)
	Scale the mesh about a point.

HRESULT	tfIoThreeDFMeshData_scaleFromS (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t scale, tfFloatP_t scalePt)
	Scale the mesh uniformly about a point.

HRESULT	tfIoThreeDFMeshData_scale (struct tfIoThreeDFMeshDataHandle handle, tfFloatP_t scales)
	Scale the structure about its centroid.

HRESULT	tfIoThreeDFMeshData_scaleS (struct tfIoThreeDFMeshDataHandle *handle, tfFloatP_t scale)
	Scale the structure uniformly about its centroid.

HRESULT	tfIoThreeDFStructure_init (struct tfIoThreeDFStructureHandle *handle)
	Initialize an instance.

HRESULT	tfIoThreeDFStructure_destroy (struct tfIoThreeDFStructureHandle *handle)
	Destroy an instance.

HRESULT	tfIoThreeDFStructure_getRadiusDef (struct tfIoThreeDFStructureHandle handle, tfFloatP_t vRadiusDef)
	Get the default radius applied to vertices when generating meshes from point clouds.

HRESULT	tfIoThreeDFStructure_setRadiusDef (struct tfIoThreeDFStructureHandle *handle, tfFloatP_t vRadiusDef)
	Set the default radius applied to vertices when generating meshes from point clouds.

HRESULT	tfIoThreeDFStructure_fromFile (struct tfIoThreeDFStructureHandle handle, const char filePath)
	Load from file.

HRESULT	tfIoThreeDFStructure_toFile (struct tfIoThreeDFStructureHandle handle, const char format, const char *filePath)
	Write to file.

HRESULT	tfIoThreeDFStructure_flush (struct tfIoThreeDFStructureHandle *handle)
	Flush stucture. All scheduled processes are executed.

HRESULT	tfIoThreeDFStructure_extend (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFStructureHandle s)
	Extend a structure.

HRESULT	tfIoThreeDFStructure_clear (struct tfIoThreeDFStructureHandle *handle)
	Clear all data of the structure.

HRESULT	tfIoThreeDFStructure_getVertices (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFVertexDataHandle vertices, unsigned int numVertices)
	Get all constituent vertices.

HRESULT	tfIoThreeDFStructure_getEdges (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFEdgeDataHandle edges, unsigned int numEdges)
	Get all constituent edges.

HRESULT	tfIoThreeDFStructure_getFaces (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFFaceDataHandle faces, unsigned int numFaces)
	Get all constituent faces.

HRESULT	tfIoThreeDFStructure_getMeshes (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFMeshDataHandle meshes, unsigned int numMeshes)
	Get all constituent meshes.

HRESULT	tfIoThreeDFStructure_getNumVertices (struct tfIoThreeDFStructureHandle handle, unsigned int value)
	Get the number of constituent vertices.

HRESULT	tfIoThreeDFStructure_getNumEdges (struct tfIoThreeDFStructureHandle handle, unsigned int value)
	Get the number of constituent edges.

HRESULT	tfIoThreeDFStructure_getNumFaces (struct tfIoThreeDFStructureHandle handle, unsigned int value)
	Get the number of constituent faces.

HRESULT	tfIoThreeDFStructure_getNumMeshes (struct tfIoThreeDFStructureHandle handle, unsigned int value)
	Get the number of constituent meshes.

HRESULT	tfIoThreeDFStructure_hasVertex (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFVertexDataHandle vertex, bool *isIn)
	Test whether a vertex is a constituent.

HRESULT	tfIoThreeDFStructure_hasEdge (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFEdgeDataHandle edge, bool *isIn)
	Test whether an edge is a constituent.

HRESULT	tfIoThreeDFStructure_hasFace (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFFaceDataHandle face, bool *isIn)
	Test whether a face is a constituent.

HRESULT	tfIoThreeDFStructure_hasMesh (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFMeshDataHandle mesh, bool *isIn)
	Test whether a mesh is a constituent.

HRESULT	tfIoThreeDFStructure_addVertex (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFVertexDataHandle vertex)
	Add a vertex.

HRESULT	tfIoThreeDFStructure_addEdge (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFEdgeDataHandle edge)
	Add an edge and all constituent data.

HRESULT	tfIoThreeDFStructure_addFace (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFFaceDataHandle face)
	Add a face and all constituent data.

HRESULT	tfIoThreeDFStructure_addMesh (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFMeshDataHandle mesh)
	Add a mesh and all constituent data.

HRESULT	tfIoThreeDFStructure_removeVertex (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFVertexDataHandle vertex)
	Remove a vertex.

HRESULT	tfIoThreeDFStructure_removeEdge (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFEdgeDataHandle edge)
	Remove a edge and all constituent data.

HRESULT	tfIoThreeDFStructure_removeFace (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFFaceDataHandle face)
	Remove a face and all constituent data.

HRESULT	tfIoThreeDFStructure_removeMesh (struct tfIoThreeDFStructureHandle handle, struct tfIoThreeDFMeshDataHandle mesh)
	Remove a mesh and all constituent data.

HRESULT	tfIoThreeDFStructure_getCentroid (struct tfIoThreeDFStructureHandle handle, tfFloatP_t *centroid)
	Get the centroid of the structure.

HRESULT	tfIoThreeDFStructure_translate (struct tfIoThreeDFStructureHandle handle, tfFloatP_t displacement)
	Translate the structure by a displacement.

HRESULT	tfIoThreeDFStructure_translateTo (struct tfIoThreeDFStructureHandle handle, tfFloatP_t position)
	Translate the structure to a position.

HRESULT	tfIoThreeDFStructure_rotateAt (struct tfIoThreeDFStructureHandle handle, tfFloatP_t rotMat, tfFloatP_t *rotPt)
	Rotate the structure about a point.

HRESULT	tfIoThreeDFStructure_rotate (struct tfIoThreeDFStructureHandle handle, tfFloatP_t rotMat)
	Rotate the structure about its centroid.

HRESULT	tfIoThreeDFStructure_scaleFrom (struct tfIoThreeDFStructureHandle handle, tfFloatP_t scales, tfFloatP_t *scalePt)
	Scale the structure about a point.

HRESULT	tfIoThreeDFStructure_scaleFromS (struct tfIoThreeDFStructureHandle handle, tfFloatP_t scale, tfFloatP_t scalePt)
	Scale the structure uniformly about a point.

HRESULT	tfIoThreeDFStructure_scale (struct tfIoThreeDFStructureHandle handle, tfFloatP_t scales)
	Scale the structure about its centroid.

HRESULT	tfIoThreeDFStructure_scaleS (struct tfIoThreeDFStructureHandle *handle, tfFloatP_t scale)
	Scale the structure uniformly about its centroid.

HRESULT	tfIoFIOModule_init (struct tfIoFIOModuleHandle handle, const char moduleName, tfIoFIOModuleToFileFcn toFile, tfIoFIOModuleFromFileFcn fromFile)
	Initialize an instance.

HRESULT	tfIoFIOModule_destroy (struct tfIoFIOModuleHandle *handle)
	Destroy an instance.

HRESULT	tfIoFIOModule_registerIOModule (struct tfIoFIOModuleHandle *handle)
	Register a module for I/O events.

HRESULT	tfIoFIOModule_load (struct tfIoFIOModuleHandle *handle)
	User-facing function to load module data from main import.

HRESULT	tfIoFIO_getIORootElement (struct tfIoIOElementHandle *handle)
	Get or generate root element from current simulation state.

HRESULT	tfIoFIO_releaseIORootElement ()
	Release current root element.

HRESULT	tfIoFIO_hasImport (bool *value)
	Test whether imported data is available.

HRESULT	tfIo_mapImportParticleId (unsigned int pid, unsigned int *mapId)
	Map a particle id from currently imported file data to the created particle on import.

HRESULT	tfIo_mapImportParticleTypeId (unsigned int ptid, unsigned int *mapId)
	Map a particle type id from currently imported file data to the created particle type on import.

HRESULT	tfIo_fromFile3DF (const char filePath, struct tfIoThreeDFStructureHandle strt)
	Load a 3D format file.

HRESULT	tfIo_toFile3DF (const char format, const char filePath, unsigned int pRefinements)
	Export engine state to a 3D format file.

HRESULT	tfIo_toFile (const char *saveFilePath)
	Save a simulation to file.

HRESULT	tfIo_toString (char *str, unsigned int numChars)
	Return a simulation state as a JSON string.

Function Documentation

◆ tfIo_fromFile3DF()

HRESULT tfIo_fromFile3DF	(	const char *	filePath,
		struct tfIoThreeDFStructureHandle *	strt )

Load a 3D format file.

Parameters

filePath	path of file
strt	3D format data container

Returns: S_OK on success

◆ tfIo_mapImportParticleId()

HRESULT tfIo_mapImportParticleId	(	unsigned int	pid,
		unsigned int *	mapId )

Map a particle id from currently imported file data to the created particle on import.

Parameters

pid	particle id according to import file
mapId	particle id according to simulation state

Returns: S_OK on success

◆ tfIo_mapImportParticleTypeId()

HRESULT tfIo_mapImportParticleTypeId	(	unsigned int	ptid,
		unsigned int *	mapId )

Map a particle type id from currently imported file data to the created particle type on import.

Parameters

ptid	particle type id according to import file
mapId	particle type id according to simulation state

Returns: S_OK on success

◆ tfIo_toFile()

HRESULT tfIo_toFile ( const char * saveFilePath )

Save a simulation to file.

Parameters

saveFilePath absolute path to file

Returns: S_OK on success

◆ tfIo_toFile3DF()

HRESULT tfIo_toFile3DF	(	const char *	format,
		const char *	filePath,
		unsigned int	pRefinements )

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: S_OK on success

◆ tfIo_toString()

HRESULT tfIo_toString	(	char **	str,
		unsigned int *	numChars )

Return a simulation state as a JSON string.

Parameters

str	string representation
numChars	number of characters of string representation

Returns: S_OK on success

◆ tfIoFIO_getIORootElement()

HRESULT tfIoFIO_getIORootElement ( struct tfIoIOElementHandle * handle )

Get or generate root element from current simulation state.

Parameters

handle root element

Returns: S_OK on success

◆ tfIoFIO_hasImport()

HRESULT tfIoFIO_hasImport ( bool * value )

Test whether imported data is available.

Parameters

value true when imported data is available

Returns: S_OK on success

◆ tfIoFIO_releaseIORootElement()

HRESULT tfIoFIO_releaseIORootElement ( )

Release current root element.

Returns: S_OK on success

◆ tfIoFIOModule_destroy()

HRESULT tfIoFIOModule_destroy ( struct tfIoFIOModuleHandle * handle )

Destroy an instance.

Parameters

handle

Returns: S_OK on success

◆ tfIoFIOModule_init()

HRESULT tfIoFIOModule_init	(	struct tfIoFIOModuleHandle *	handle,
		const char *	moduleName,
		tfIoFIOModuleToFileFcn	toFile,
		tfIoFIOModuleFromFileFcn	fromFile )

Initialize an instance.

Parameters

handle	handle to populate
moduleName	name of module
toFile	callback to export module data
fromFile	callback to import module data

Returns: S_OK on success

◆ tfIoFIOModule_load()

HRESULT tfIoFIOModule_load ( struct tfIoFIOModuleHandle * handle )

User-facing function to load module data from main import.

Must only be called after main import.

◆ tfIoFIOStorageKeys_destroy()

HRESULT tfIoFIOStorageKeys_destroy ( struct tfIoFIOStorageKeysHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoFIOStorageKeys_init()

HRESULT tfIoFIOStorageKeys_init ( struct tfIoFIOStorageKeysHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoIOElement_destroy()

HRESULT tfIoIOElement_destroy ( struct tfIoIOElementHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoIOElement_getChild()

HRESULT tfIoIOElement_getChild	(	struct tfIoIOElementHandle *	handle,
		const char *	key,
		struct tfIoIOElementHandle *	child )

Get a child.

Parameters

handle	populated handle
key	child key
child	child element

Returns: S_OK on success

◆ tfIoIOElement_getKeys()

HRESULT tfIoIOElement_getKeys	(	struct tfIoIOElementHandle *	handle,
		char ***	keys )

Get the child element keys.

Parameters

handle	populated handle
keys	child element keys

Returns: S_OK on success

◆ tfIoIOElement_getNumChildren()

HRESULT tfIoIOElement_getNumChildren	(	struct tfIoIOElementHandle *	handle,
		unsigned int *	numChildren )

Get the number of child elements.

Parameters

handle	populated handle
numChildren	number of child elements

Returns: S_OK on success

◆ tfIoIOElement_getParent()

HRESULT tfIoIOElement_getParent	(	struct tfIoIOElementHandle *	handle,
		struct tfIoIOElementHandle *	parent )

Get an instance parent.

Parameters

handle	populated handle
parent	instance parent

Returns: S_OK on success

◆ tfIoIOElement_getType()

HRESULT tfIoIOElement_getType	(	struct tfIoIOElementHandle *	handle,
		char **	type,
		unsigned int *	numChars )

Get the instance value type.

Parameters

handle	populated handle
type	value type
numChars	number of characters

Returns: S_OK on success

◆ tfIoIOElement_getValue()

HRESULT tfIoIOElement_getValue	(	struct tfIoIOElementHandle *	handle,
		char **	value,
		unsigned int *	numChars )

Get the instance value.

Parameters

handle	populated handle
value	value string
numChars	number of characters

Returns: S_OK on success

◆ tfIoIOElement_hasParent()

HRESULT tfIoIOElement_hasParent	(	struct tfIoIOElementHandle *	handle,
		bool *	hasParent )

Test whether an instance has a parent element.

Parameters

handle	populated handle
hasParent	true when instance has a parent element

Returns: S_OK on success

◆ tfIoIOElement_init()

HRESULT tfIoIOElement_init ( struct tfIoIOElementHandle * handle )

Initialize an empty instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoIOElement_setChild()

HRESULT tfIoIOElement_setChild	(	struct tfIoIOElementHandle *	handle,
		const char *	key,
		struct tfIoIOElementHandle *	child )

Set a child.

Parameters

handle	populated handle
key	child key
child	child element

Returns: S_OK on success

◆ tfIoIOElement_setParent()

HRESULT tfIoIOElement_setParent	(	struct tfIoIOElementHandle *	handle,
		struct tfIoIOElementHandle *	parent )

Set an instance parent.

Parameters

handle	populated handle
parent	instance parent

Returns: S_OK on success

◆ tfIoIOElement_setType()

HRESULT tfIoIOElement_setType	(	struct tfIoIOElementHandle *	handle,
		const char *	type )

Set the instance value type.

Parameters

handle	populated handle
type	value type

Returns: S_OK on success

◆ tfIoIOElement_setValue()

HRESULT tfIoIOElement_setValue	(	struct tfIoIOElementHandle *	handle,
		const char *	value )

Set the instance value.

Parameters

handle	populated handle
value	value string

Returns: S_OK on success

◆ tfIoMetaData_init()

HRESULT tfIoMetaData_init ( struct tfIoMetaDataHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_destroy()

HRESULT tfIoThreeDFEdgeData_destroy ( struct tfIoThreeDFEdgeDataHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getFaces()

HRESULT tfIoThreeDFEdgeData_getFaces	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle **	faces,
		unsigned int *	numFaces )

Get all parent faces.

Parameters

handle	populated handle
faces	parent faces
numFaces	number of faces

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getId()

HRESULT tfIoThreeDFEdgeData_getId	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		int *	value )

Get the ID, if any. Unique to its structure and type. -1 if not set.

Parameters

handle	populated handle
value	ID, if any; otherwise -1

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getMeshes()

HRESULT tfIoThreeDFEdgeData_getMeshes	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle **	meshes,
		unsigned int *	numMeshes )

Get all parent meshes.

Parameters

handle	populated handle
meshes	parent meshes
numMeshes	number of meshes

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getNumFaces()

HRESULT tfIoThreeDFEdgeData_getNumFaces	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		unsigned int *	value )

Get the number of parent faces.

Parameters

handle	populated handle
value	number of parent faces

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getNumMeshes()

HRESULT tfIoThreeDFEdgeData_getNumMeshes	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		unsigned int *	value )

Get the number of parent meshes.

Parameters

handle	populated handle
value	number of parent meshes

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getStructure()

HRESULT tfIoThreeDFEdgeData_getStructure	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Get the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_getVertices()

HRESULT tfIoThreeDFEdgeData_getVertices	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	va,
		struct tfIoThreeDFVertexDataHandle *	vb )

Get all child vertices.

Parameters

handle	populated handle
va	first vertex
vb	second vertex

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_hasStructure()

HRESULT tfIoThreeDFEdgeData_hasStructure	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		bool *	hasStructure )

Test whether an instance has a parent structure.

Parameters

handle	populated handle
hasStructure	flag signifying whether an instance has a parent structure

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_hasVertex()

HRESULT tfIoThreeDFEdgeData_hasVertex	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex,
		bool *	isIn )

Test whether has a vertex.

Parameters

handle	populated handle
vertex	vertex to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_inFace()

HRESULT tfIoThreeDFEdgeData_inFace	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face,
		bool *	isIn )

Test whether in a face.

Parameters

handle	populated handle
face	face to test
isIn	flag signifying whether in a face

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_init()

HRESULT tfIoThreeDFEdgeData_init	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	va,
		struct tfIoThreeDFVertexDataHandle *	vb )

Initialize an instance.

Parameters

handle	handle to populate
va	first vertex
vb	second vertex

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_inMesh()

HRESULT tfIoThreeDFEdgeData_inMesh	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh,
		bool *	isIn )

Test whether in a mesh.

Parameters

handle	populated handle
mesh	mesh to test
isIn	flag signifying whether in a mesh

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_inStructure()

HRESULT tfIoThreeDFEdgeData_inStructure	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure,
		bool *	isIn )

Test whether in a structure.

Parameters

handle	populated handle
structure	structure to test
isIn	flag signifying whether in a structure

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_setFaces()

HRESULT tfIoThreeDFEdgeData_setFaces	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	faces,
		unsigned int	numFaces )

Set all parent faces.

Parameters

handle	populated handle
faces	parent faces
numFaces	number of faces

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_setId()

HRESULT tfIoThreeDFEdgeData_setId	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		unsigned int	value )

Set the ID.

Parameters

handle	populated handle
value	ID

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_setStructure()

HRESULT tfIoThreeDFEdgeData_setStructure	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Set the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFEdgeData_setVertices()

HRESULT tfIoThreeDFEdgeData_setVertices	(	struct tfIoThreeDFEdgeDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	va,
		struct tfIoThreeDFVertexDataHandle *	vb )

Set all child vertices.

Parameters

handle	populated handle
va	first vertex
vb	second vertex

Returns: S_OK on success

◆ tfIoThreeDFFaceData_destroy()

HRESULT tfIoThreeDFFaceData_destroy ( struct tfIoThreeDFFaceDataHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getEdges()

HRESULT tfIoThreeDFFaceData_getEdges	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle **	edges,
		unsigned int *	numEdges )

Get all child edges.

Parameters

handle	populated handle
edges	child edges
numEdges	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getId()

HRESULT tfIoThreeDFFaceData_getId	(	struct tfIoThreeDFFaceDataHandle *	handle,
		int *	value )

Get the ID, if any. Unique to its structure and type. -1 if not set.

Parameters

handle	populated handle
value	ID, if any; otherwise -1

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getMeshes()

HRESULT tfIoThreeDFFaceData_getMeshes	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle **	meshes,
		unsigned int *	numMeshes )

Get all parent meshes.

Parameters

handle	populated handle
meshes	parent meshes
numMeshes	number of meshes

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getNormal()

HRESULT tfIoThreeDFFaceData_getNormal	(	struct tfIoThreeDFFaceDataHandle *	handle,
		tfFloatP_t **	normal )

Get the face normal vector.

Parameters

handle	populated handle
normal	normal vector

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getNumEdges()

HRESULT tfIoThreeDFFaceData_getNumEdges	(	struct tfIoThreeDFFaceDataHandle *	handle,
		unsigned int *	value )

Get the number of child edges.

Parameters

handle	populated handle
value	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getNumMeshes()

HRESULT tfIoThreeDFFaceData_getNumMeshes	(	struct tfIoThreeDFFaceDataHandle *	handle,
		unsigned int *	value )

Get the number of parent meshes.

Parameters

handle	populated handle
value	number of parent meshes

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getNumVertices()

HRESULT tfIoThreeDFFaceData_getNumVertices	(	struct tfIoThreeDFFaceDataHandle *	handle,
		unsigned int *	value )

Get the number of child vertices.

Parameters

handle	populated handle
value	number of child vertices

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getStructure()

HRESULT tfIoThreeDFFaceData_getStructure	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Get the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFFaceData_getVertices()

HRESULT tfIoThreeDFFaceData_getVertices	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle **	vertices,
		unsigned int *	numVertices )

Get all child vertices.

Parameters

handle	populated handle
vertices	child vertices
numVertices	number of vertices

Returns: S_OK on success

◆ tfIoThreeDFFaceData_hasEdge()

HRESULT tfIoThreeDFFaceData_hasEdge	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge,
		bool *	isIn )

Test whether has an edge.

Parameters

handle	populated handle
edge	edge to test
isIn	flag signifying whether has an edge

Returns: S_OK on success

◆ tfIoThreeDFFaceData_hasStructure()

HRESULT tfIoThreeDFFaceData_hasStructure	(	struct tfIoThreeDFFaceDataHandle *	handle,
		bool *	hasStructure )

Test whether an instance has a parent structure.

Parameters

handle	populated handle
hasStructure	flag signifying whether an instance has a parent structure

Returns: S_OK on success

◆ tfIoThreeDFFaceData_hasVertex()

HRESULT tfIoThreeDFFaceData_hasVertex	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex,
		bool *	isIn )

Test whether has a vertex.

Parameters

handle	populated handle
vertex	vertex to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFFaceData_init()

HRESULT tfIoThreeDFFaceData_init ( struct tfIoThreeDFFaceDataHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoThreeDFFaceData_inMesh()

HRESULT tfIoThreeDFFaceData_inMesh	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh,
		bool *	isIn )

Test whether in a mesh.

Parameters

handle	populated handle
mesh	mesh to test
isIn	flag signifying whether in a mesh

Returns: S_OK on success

◆ tfIoThreeDFFaceData_inStructure()

HRESULT tfIoThreeDFFaceData_inStructure	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure,
		bool *	isIn )

Test whether in a structure.

Parameters

handle	populated handle
structure	structure to test
isIn	flag signifying whether in a structure

Returns: S_OK on success

◆ tfIoThreeDFFaceData_setEdges()

HRESULT tfIoThreeDFFaceData_setEdges	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edges,
		unsigned int	numEdges )

Set all child edges.

Parameters

handle	populated handle
edges	child edges
numEdges	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFFaceData_setId()

HRESULT tfIoThreeDFFaceData_setId	(	struct tfIoThreeDFFaceDataHandle *	handle,
		unsigned int	value )

Set the ID.

Parameters

handle	populated handle
value	ID

Returns: S_OK on success

◆ tfIoThreeDFFaceData_setMeshes()

HRESULT tfIoThreeDFFaceData_setMeshes	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	meshes,
		unsigned int	numMeshes )

Set all parent meshes.

Parameters

handle	populated handle
meshes	parent meshes
numMeshes	number of meshes

Returns: S_OK on success

◆ tfIoThreeDFFaceData_setNormal()

HRESULT tfIoThreeDFFaceData_setNormal	(	struct tfIoThreeDFFaceDataHandle *	handle,
		tfFloatP_t *	normal )

Set the face normal vector.

Parameters

handle	populated handle
normal	normal vector

Returns: S_OK on success

◆ tfIoThreeDFFaceData_setStructure()

HRESULT tfIoThreeDFFaceData_setStructure	(	struct tfIoThreeDFFaceDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Set the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFMeshData_destroy()

HRESULT tfIoThreeDFMeshData_destroy ( struct tfIoThreeDFMeshDataHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getCentroid()

HRESULT tfIoThreeDFMeshData_getCentroid	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t **	centroid )

Get the centroid of the mesh.

Parameters

handle	populated handle
centroid	mesh centroid

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getEdges()

HRESULT tfIoThreeDFMeshData_getEdges	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle **	edges,
		unsigned int *	numEdges )

Get all child edges.

Parameters

handle	populated handle
edges	child edges
numEdges	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getFaces()

HRESULT tfIoThreeDFMeshData_getFaces	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle **	faces,
		unsigned int *	numFaces )

Get all child faces.

Parameters

handle	populated handle
faces	child faces
numFaces	number of child faces

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getId()

HRESULT tfIoThreeDFMeshData_getId	(	struct tfIoThreeDFMeshDataHandle *	handle,
		int *	value )

Get the ID, if any. Unique to its structure and type. -1 if not set.

Parameters

handle	populated handle
value	ID, if any; otherwise -1

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getName()

HRESULT tfIoThreeDFMeshData_getName	(	struct tfIoThreeDFMeshDataHandle *	handle,
		char **	name,
		unsigned int *	numChars )

Get the mesh name.

Parameters

handle	populated handle
name	mesh name
numChars	number of characters

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getNumEdges()

HRESULT tfIoThreeDFMeshData_getNumEdges	(	struct tfIoThreeDFMeshDataHandle *	handle,
		unsigned int *	value )

Get the number of child edges.

Parameters

handle	populated handle
value	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getNumFaces()

HRESULT tfIoThreeDFMeshData_getNumFaces	(	struct tfIoThreeDFMeshDataHandle *	handle,
		unsigned int *	value )

Get the number of child faces.

Parameters

handle	populated handle
value	number of child faces

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getNumVertices()

HRESULT tfIoThreeDFMeshData_getNumVertices	(	struct tfIoThreeDFMeshDataHandle *	handle,
		unsigned int *	value )

Get the number of child vertices.

Parameters

handle	populated handle
value	number of child vertices

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getRenderData()

HRESULT tfIoThreeDFMeshData_getRenderData	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFRenderDataHandle *	renderData )

Get render data.

Parameters

handle	populated handle
renderData	render data

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getStructure()

HRESULT tfIoThreeDFMeshData_getStructure	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Get the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFMeshData_getVertices()

HRESULT tfIoThreeDFMeshData_getVertices	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle **	vertices,
		unsigned int *	numVertices )

Get all child vertices.

Parameters

handle	populated handle
vertices	child vertices
numVertices	number of vertices

Returns: S_OK on success

◆ tfIoThreeDFMeshData_hasEdge()

HRESULT tfIoThreeDFMeshData_hasEdge	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge,
		bool *	isIn )

Test whether has an edge.

Parameters

handle	populated handle
edge	edge to test
isIn	flag signifying whether has an edge

Returns: S_OK on success

◆ tfIoThreeDFMeshData_hasFace()

HRESULT tfIoThreeDFMeshData_hasFace	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face,
		bool *	isIn )

Test whether has a face.

Parameters

handle	populated handle
face	face to test
isIn	flag signifying whether has a face

Returns: S_OK on success

◆ tfIoThreeDFMeshData_hasRenderData()

HRESULT tfIoThreeDFMeshData_hasRenderData	(	struct tfIoThreeDFMeshDataHandle *	handle,
		bool *	hasData )

Test whether has render data.

Parameters

handle	populated handle
hasData	flag signifying whether has render data

Returns: S_OK on success

◆ tfIoThreeDFMeshData_hasStructure()

HRESULT tfIoThreeDFMeshData_hasStructure	(	struct tfIoThreeDFMeshDataHandle *	handle,
		bool *	hasStructure )

Test whether an instance has a parent structure.

Parameters

handle	populated handle
hasStructure	flag signifying whether an instance has a parent structure

Returns: S_OK on success

◆ tfIoThreeDFMeshData_hasVertex()

HRESULT tfIoThreeDFMeshData_hasVertex	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex,
		bool *	isIn )

Test whether has a vertex.

Parameters

handle	populated handle
vertex	vertex to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFMeshData_init()

HRESULT tfIoThreeDFMeshData_init ( struct tfIoThreeDFMeshDataHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoThreeDFMeshData_inStructure()

HRESULT tfIoThreeDFMeshData_inStructure	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure,
		bool *	isIn )

Test whether in a structure.

Parameters

handle	populated handle
structure	structure to test
isIn	flag signifying whether in a structure

Returns: S_OK on success

◆ tfIoThreeDFMeshData_rotate()

HRESULT tfIoThreeDFMeshData_rotate	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	rotMat )

Rotate the mesh about its centroid.

Parameters

handle	populated handle
rotMat	rotation matrix

Returns: S_OK on success

◆ tfIoThreeDFMeshData_rotateAt()

HRESULT tfIoThreeDFMeshData_rotateAt	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	rotMat,
		tfFloatP_t *	rotPt )

Rotate the mesh about a point.

Parameters

handle	populated handle
rotMat	rotation matrix
rotPt	rotation point

Returns: S_OK on success

◆ tfIoThreeDFMeshData_scale()

HRESULT tfIoThreeDFMeshData_scale	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	scales )

Scale the structure about its centroid.

Parameters

handle	populated handle
scales	scale components

Returns: S_OK on success

◆ tfIoThreeDFMeshData_scaleFrom()

HRESULT tfIoThreeDFMeshData_scaleFrom	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	scales,
		tfFloatP_t *	scalePt )

Scale the mesh about a point.

Parameters

handle	populated handle
scales	scale coefficients
scalePt	scale point

Returns: S_OK on success

◆ tfIoThreeDFMeshData_scaleFromS()

HRESULT tfIoThreeDFMeshData_scaleFromS	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t	scale,
		tfFloatP_t *	scalePt )

Scale the mesh uniformly about a point.

Parameters

handle	populated handle
scale	scale coefficient
scalePt	scale point

Returns: S_OK on success

◆ tfIoThreeDFMeshData_scaleS()

HRESULT tfIoThreeDFMeshData_scaleS	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t	scale )

Scale the structure uniformly about its centroid.

Parameters

handle	populated handle
scale	scale coefficient

Returns: S_OK on success

◆ tfIoThreeDFMeshData_setFaces()

HRESULT tfIoThreeDFMeshData_setFaces	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	faces,
		unsigned int	numFaces )

Get all child faces.

Parameters

handle	populated handle
faces	child faces
numFaces	number of child faces

Returns: S_OK on success

◆ tfIoThreeDFMeshData_setId()

HRESULT tfIoThreeDFMeshData_setId	(	struct tfIoThreeDFMeshDataHandle *	handle,
		unsigned int	value )

Set the ID.

Parameters

handle	populated handle
value	ID

Returns: S_OK on success

◆ tfIoThreeDFMeshData_setName()

HRESULT tfIoThreeDFMeshData_setName	(	struct tfIoThreeDFMeshDataHandle *	handle,
		const char *	name )

Set the mesh name.

Parameters

handle	populated handle
name	mesh name

Returns: S_OK on success

◆ tfIoThreeDFMeshData_setRenderData()

HRESULT tfIoThreeDFMeshData_setRenderData	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFRenderDataHandle *	renderData )

Set render data.

Parameters

handle	populated handle
renderData	render data

Returns: S_OK on success

◆ tfIoThreeDFMeshData_setStructure()

HRESULT tfIoThreeDFMeshData_setStructure	(	struct tfIoThreeDFMeshDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Set the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFMeshData_translate()

HRESULT tfIoThreeDFMeshData_translate	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	displacement )

Translate the mesh by a displacement.

Parameters

handle	populated handle
displacement	translation displacement

Returns: S_OK on success

◆ tfIoThreeDFMeshData_translateTo()

HRESULT tfIoThreeDFMeshData_translateTo	(	struct tfIoThreeDFMeshDataHandle *	handle,
		tfFloatP_t *	position )

Translate the mesh to a position.

Parameters

handle	populated handle
position	new position

Returns: S_OK on success

◆ tfIoThreeDFRenderData_destroy()

HRESULT tfIoThreeDFRenderData_destroy ( struct tfIoThreeDFRenderDataHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFRenderData_getColor()

HRESULT tfIoThreeDFRenderData_getColor	(	struct tfIoThreeDFRenderDataHandle *	handle,
		tfFloatP_t **	color )

Get the color.

Parameters

handle	populated handle
color	data color

Returns: S_OK on success

◆ tfIoThreeDFRenderData_init()

HRESULT tfIoThreeDFRenderData_init ( struct tfIoThreeDFRenderDataHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoThreeDFRenderData_setColor()

HRESULT tfIoThreeDFRenderData_setColor	(	struct tfIoThreeDFRenderDataHandle *	handle,
		tfFloatP_t *	color )

Set the color.

Parameters

handle	populated handle
color	data color

Returns: S_OK on success

◆ tfIoThreeDFStructure_addEdge()

HRESULT tfIoThreeDFStructure_addEdge	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge )

Add an edge and all constituent data.

Parameters

handle	populated handle
edge	edge to add

Returns: S_OK on success

◆ tfIoThreeDFStructure_addFace()

HRESULT tfIoThreeDFStructure_addFace	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face )

Add a face and all constituent data.

Parameters

handle	populated handle
face	face to add

Returns: S_OK on success

◆ tfIoThreeDFStructure_addMesh()

HRESULT tfIoThreeDFStructure_addMesh	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh )

Add a mesh and all constituent data.

Parameters

handle	populated handle
mesh	mesh to add

Returns: S_OK on success

◆ tfIoThreeDFStructure_addVertex()

HRESULT tfIoThreeDFStructure_addVertex	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex )

Add a vertex.

Parameters

handle	populated handle
vertex	vertex to add

Returns: S_OK on success

◆ tfIoThreeDFStructure_clear()

HRESULT tfIoThreeDFStructure_clear ( struct tfIoThreeDFStructureHandle * handle )

Clear all data of the structure.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFStructure_destroy()

HRESULT tfIoThreeDFStructure_destroy ( struct tfIoThreeDFStructureHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFStructure_extend()

HRESULT tfIoThreeDFStructure_extend	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFStructureHandle *	s )

Extend a structure.

Parameters

handle	populated handle
s	stucture to extend with

Returns: S_OK on success

◆ tfIoThreeDFStructure_flush()

HRESULT tfIoThreeDFStructure_flush ( struct tfIoThreeDFStructureHandle * handle )

Flush stucture. All scheduled processes are executed.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFStructure_fromFile()

HRESULT tfIoThreeDFStructure_fromFile	(	struct tfIoThreeDFStructureHandle *	handle,
		const char *	filePath )

Load from file.

Parameters

handle	populated handle
filePath	file absolute path

Returns: S_OK on success

◆ tfIoThreeDFStructure_getCentroid()

HRESULT tfIoThreeDFStructure_getCentroid	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t **	centroid )

Get the centroid of the structure.

Parameters

handle	populated handle
centroid	structure centroid

Returns: S_OK on success

◆ tfIoThreeDFStructure_getEdges()

HRESULT tfIoThreeDFStructure_getEdges	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle **	edges,
		unsigned int *	numEdges )

Get all constituent edges.

Parameters

handle	populated handle
edges	child edges
numEdges	number of child edges

Returns: S_OK on success

◆ tfIoThreeDFStructure_getFaces()

HRESULT tfIoThreeDFStructure_getFaces	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFFaceDataHandle **	faces,
		unsigned int *	numFaces )

Get all constituent faces.

Parameters

handle	populated handle
faces	child faces
numFaces	number of child faces

Returns: S_OK on success

◆ tfIoThreeDFStructure_getMeshes()

HRESULT tfIoThreeDFStructure_getMeshes	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFMeshDataHandle **	meshes,
		unsigned int *	numMeshes )

Get all constituent meshes.

Parameters

handle	populated handle
meshes	child meshes
numMeshes	number of meshes

Returns: S_OK on success

◆ tfIoThreeDFStructure_getNumEdges()

HRESULT tfIoThreeDFStructure_getNumEdges	(	struct tfIoThreeDFStructureHandle *	handle,
		unsigned int *	value )

Get the number of constituent edges.

Parameters

handle	populated handle
value	number of constituent edges

Returns: S_OK on success

◆ tfIoThreeDFStructure_getNumFaces()

HRESULT tfIoThreeDFStructure_getNumFaces	(	struct tfIoThreeDFStructureHandle *	handle,
		unsigned int *	value )

Get the number of constituent faces.

Parameters

handle	populated handle
value	number of constituent faces

Returns: S_OK on success

◆ tfIoThreeDFStructure_getNumMeshes()

HRESULT tfIoThreeDFStructure_getNumMeshes	(	struct tfIoThreeDFStructureHandle *	handle,
		unsigned int *	value )

Get the number of constituent meshes.

Parameters

handle	populated handle
value	number of constituent meshes

◆ tfIoThreeDFStructure_getNumVertices()

HRESULT tfIoThreeDFStructure_getNumVertices	(	struct tfIoThreeDFStructureHandle *	handle,
		unsigned int *	value )

Get the number of constituent vertices.

Parameters

handle	populated handle
value	number of constituent vertices

Returns: S_OK on success

◆ tfIoThreeDFStructure_getRadiusDef()

HRESULT tfIoThreeDFStructure_getRadiusDef	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	vRadiusDef )

Get the default radius applied to vertices when generating meshes from point clouds.

Parameters

handle	populated handle
vRadiusDef	default radius

Returns: S_OK on success

◆ tfIoThreeDFStructure_getVertices()

HRESULT tfIoThreeDFStructure_getVertices	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFVertexDataHandle **	vertices,
		unsigned int *	numVertices )

Get all constituent vertices.

Parameters

handle	populated handle
vertices	child vertices
numVertices	number of vertices

Returns: S_OK on success

◆ tfIoThreeDFStructure_hasEdge()

HRESULT tfIoThreeDFStructure_hasEdge	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge,
		bool *	isIn )

Test whether an edge is a constituent.

Parameters

handle	populated handle
edge	edge to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFStructure_hasFace()

HRESULT tfIoThreeDFStructure_hasFace	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face,
		bool *	isIn )

Test whether a face is a constituent.

Parameters

handle	populated handle
face	face to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFStructure_hasMesh()

HRESULT tfIoThreeDFStructure_hasMesh	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh,
		bool *	isIn )

Test whether a mesh is a constituent.

Parameters

handle	populated handle
mesh	mesh to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFStructure_hasVertex()

HRESULT tfIoThreeDFStructure_hasVertex	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex,
		bool *	isIn )

Test whether a vertex is a constituent.

Parameters

handle	populated handle
vertex	vertex to test
isIn	flag signifying whether has a vertex

Returns: S_OK on success

◆ tfIoThreeDFStructure_init()

HRESULT tfIoThreeDFStructure_init ( struct tfIoThreeDFStructureHandle * handle )

Initialize an instance.

Parameters

handle handle to populate

Returns: S_OK on success

◆ tfIoThreeDFStructure_removeEdge()

HRESULT tfIoThreeDFStructure_removeEdge	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge )

Remove a edge and all constituent data.

Parameters

handle	populated handle
edge	edge to remove

Returns: S_OK on success

◆ tfIoThreeDFStructure_removeFace()

HRESULT tfIoThreeDFStructure_removeFace	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face )

Remove a face and all constituent data.

Parameters

handle	populated handle
face	face to remove

Returns: S_OK on success

◆ tfIoThreeDFStructure_removeMesh()

HRESULT tfIoThreeDFStructure_removeMesh	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh )

Remove a mesh and all constituent data.

Parameters

handle	populated handle
mesh	mesh to remove

Returns: S_OK on success

◆ tfIoThreeDFStructure_removeVertex()

HRESULT tfIoThreeDFStructure_removeVertex	(	struct tfIoThreeDFStructureHandle *	handle,
		struct tfIoThreeDFVertexDataHandle *	vertex )

Remove a vertex.

Parameters

handle	populated handle
vertex	vertex to remove

Returns: S_OK on success

◆ tfIoThreeDFStructure_rotate()

HRESULT tfIoThreeDFStructure_rotate	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	rotMat )

Rotate the structure about its centroid.

Parameters

handle	populated handle
rotMat	rotation matrix

Returns: S_OK on success

◆ tfIoThreeDFStructure_rotateAt()

HRESULT tfIoThreeDFStructure_rotateAt	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	rotMat,
		tfFloatP_t *	rotPt )

Rotate the structure about a point.

Parameters

handle	populated handle
rotMat	rotation matrix
rotPt	rotation point

Returns: S_OK on success

◆ tfIoThreeDFStructure_scale()

HRESULT tfIoThreeDFStructure_scale	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	scales )

Scale the structure about its centroid.

Parameters

handle	populated handle
scales	scale coefficients

Returns: S_OK on success

◆ tfIoThreeDFStructure_scaleFrom()

HRESULT tfIoThreeDFStructure_scaleFrom	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	scales,
		tfFloatP_t *	scalePt )

Scale the structure about a point.

Parameters

handle	populated handle
scales	scale coefficients
scalePt	scale point

Returns: S_OK on success

◆ tfIoThreeDFStructure_scaleFromS()

HRESULT tfIoThreeDFStructure_scaleFromS	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t	scale,
		tfFloatP_t *	scalePt )

Scale the structure uniformly about a point.

Parameters

handle	populated handle
scale	scale coefficient
scalePt	scale point

Returns: S_OK on success

◆ tfIoThreeDFStructure_scaleS()

HRESULT tfIoThreeDFStructure_scaleS	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t	scale )

Scale the structure uniformly about its centroid.

Parameters

handle	populated handle
scale	scale coefficient

Returns: S_OK on success

◆ tfIoThreeDFStructure_setRadiusDef()

HRESULT tfIoThreeDFStructure_setRadiusDef	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t	vRadiusDef )

Set the default radius applied to vertices when generating meshes from point clouds.

Parameters

handle	populated handle
vRadiusDef	default radius

Returns: S_OK on success

◆ tfIoThreeDFStructure_toFile()

HRESULT tfIoThreeDFStructure_toFile	(	struct tfIoThreeDFStructureHandle *	handle,
		const char *	format,
		const char *	filePath )

Write to file.

Parameters

handle	populated handle
format	output format of file
filePath	file absolute path

Returns: S_OK on success

◆ tfIoThreeDFStructure_translate()

HRESULT tfIoThreeDFStructure_translate	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	displacement )

Translate the structure by a displacement.

Parameters

handle	populated handle
displacement	translation displacement

Returns: S_OK on success

◆ tfIoThreeDFStructure_translateTo()

HRESULT tfIoThreeDFStructure_translateTo	(	struct tfIoThreeDFStructureHandle *	handle,
		tfFloatP_t *	position )

Translate the structure to a position.

Parameters

handle	populated handle
position	translation displacement

Returns: S_OK on success

◆ tfIoThreeDFVertexData_destroy()

HRESULT tfIoThreeDFVertexData_destroy ( struct tfIoThreeDFVertexDataHandle * handle )

Destroy an instance.

Parameters

handle populated handle

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getEdges()

HRESULT tfIoThreeDFVertexData_getEdges	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle **	edges,
		unsigned int *	numEdges )

Get all parent edges.

Parameters

handle	populated handle
edges	parent edges
numEdges	number of edges

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getFaces()

HRESULT tfIoThreeDFVertexData_getFaces	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle **	faces,
		unsigned int *	numFaces )

Get all parent faces.

Parameters

handle	populated handle
faces	parent faces
numFaces	number of faces

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getId()

HRESULT tfIoThreeDFVertexData_getId	(	struct tfIoThreeDFVertexDataHandle *	handle,
		int *	value )

Get the ID, if any. Unique to its structure and type. -1 if not set.

Parameters

handle	populated handle
value	ID, if any; otherwise -1

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getMeshes()

HRESULT tfIoThreeDFVertexData_getMeshes	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle **	meshes,
		unsigned int *	numMeshes )

Get all parent meshes.

Parameters

handle	populated handle
meshes	parent meshes
numMeshes	number of meshes

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getNumEdges()

HRESULT tfIoThreeDFVertexData_getNumEdges	(	struct tfIoThreeDFVertexDataHandle *	handle,
		unsigned int *	value )

Get the number of parent edges.

Parameters

handle	populated handle
value	number of parent edges

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getNumFaces()

HRESULT tfIoThreeDFVertexData_getNumFaces	(	struct tfIoThreeDFVertexDataHandle *	handle,
		unsigned int *	value )

Get the number of parent faces.

Parameters

handle	populated handle
value	number of parent faces

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getNumMeshes()

HRESULT tfIoThreeDFVertexData_getNumMeshes	(	struct tfIoThreeDFVertexDataHandle *	handle,
		unsigned int *	value )

Get the number of parent meshes.

Parameters

handle	populated handle
value	number of parent meshes

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getPosition()

HRESULT tfIoThreeDFVertexData_getPosition	(	struct tfIoThreeDFVertexDataHandle *	handle,
		tfFloatP_t **	position )

Get the global position.

Parameters

handle	populated handle
position	global position

Returns: S_OK on success

◆ tfIoThreeDFVertexData_getStructure()

HRESULT tfIoThreeDFVertexData_getStructure	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Get the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

◆ tfIoThreeDFVertexData_hasStructure()

HRESULT tfIoThreeDFVertexData_hasStructure	(	struct tfIoThreeDFVertexDataHandle *	handle,
		bool *	hasStructure )

Test whether an instance has a parent structure.

Parameters

handle	populated handle
hasStructure	flag signifying whether an instance has a parent structure

Returns: S_OK on success

◆ tfIoThreeDFVertexData_inEdge()

HRESULT tfIoThreeDFVertexData_inEdge	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edge,
		bool *	isIn )

Test whether in an edge.

Parameters

handle	populated handle
edge	edge to test
isIn	flag signifying whether in an edge

Returns: S_OK on success

◆ tfIoThreeDFVertexData_inFace()

HRESULT tfIoThreeDFVertexData_inFace	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFFaceDataHandle *	face,
		bool *	isIn )

Test whether in a face.

Parameters

handle	populated handle
face	face to test
isIn	flag signifying whether in a face

Returns: S_OK on success

◆ tfIoThreeDFVertexData_init()

HRESULT tfIoThreeDFVertexData_init	(	struct tfIoThreeDFVertexDataHandle *	handle,
		tfFloatP_t *	position )

Initialize an instance.

Parameters

handle	handle to populate
position	global position

Returns: S_OK on success

◆ tfIoThreeDFVertexData_inMesh()

HRESULT tfIoThreeDFVertexData_inMesh	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	mesh,
		bool *	isIn )

Test whether in a mesh.

Parameters

handle	populated handle
mesh	mesh to test
isIn	flag signifying whether in a mesh

Returns: S_OK on success

◆ tfIoThreeDFVertexData_inStructure()

HRESULT tfIoThreeDFVertexData_inStructure	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure,
		bool *	isIn )

Test whether in a structure.

Parameters

handle	populated handle
structure	structure to test
isIn	flag signifying whether in a structure

Returns: S_OK on success

◆ tfIoThreeDFVertexData_setEdges()

HRESULT tfIoThreeDFVertexData_setEdges	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFEdgeDataHandle *	edges,
		unsigned int	numEdges )

Set all parent edges.

Parameters

handle	populated handle
edges	parent edges
numEdges	number of edges

Returns: S_OK on success

◆ tfIoThreeDFVertexData_setId()

HRESULT tfIoThreeDFVertexData_setId	(	struct tfIoThreeDFVertexDataHandle *	handle,
		unsigned int	value )

Set the ID.

Parameters

handle	populated handle
value	ID

Returns: S_OK on success

◆ tfIoThreeDFVertexData_setPosition()

HRESULT tfIoThreeDFVertexData_setPosition	(	struct tfIoThreeDFVertexDataHandle *	handle,
		tfFloatP_t *	position )

Set the global position.

Parameters

handle	populated handle
position	global position

Returns: S_OK on success

◆ tfIoThreeDFVertexData_setStructure()

HRESULT tfIoThreeDFVertexData_setStructure	(	struct tfIoThreeDFVertexDataHandle *	handle,
		struct tfIoThreeDFStructureHandle *	structure )

Set the parent structure.

Parameters

handle	populated handle
structure	parent structure

Returns: S_OK on success

Data Structures

Typedefs

Functions

Function Documentation

◆ tfIo_fromFile3DF()

◆ tfIo_mapImportParticleId()

◆ tfIo_mapImportParticleTypeId()

◆ tfIo_toFile()

◆ tfIo_toFile3DF()

◆ tfIo_toString()

◆ tfIoFIO_getIORootElement()

◆ tfIoFIO_hasImport()

◆ tfIoFIO_releaseIORootElement()

◆ tfIoFIOModule_destroy()

◆ tfIoFIOModule_init()

◆ tfIoFIOModule_load()

◆ tfIoFIOStorageKeys_destroy()

◆ tfIoFIOStorageKeys_init()

◆ tfIoIOElement_destroy()

◆ tfIoIOElement_getChild()

◆ tfIoIOElement_getKeys()

◆ tfIoIOElement_getNumChildren()

◆ tfIoIOElement_getParent()

◆ tfIoIOElement_getType()

◆ tfIoIOElement_getValue()

◆ tfIoIOElement_hasParent()

◆ tfIoIOElement_init()

◆ tfIoIOElement_setChild()

◆ tfIoIOElement_setParent()

◆ tfIoIOElement_setType()

◆ tfIoIOElement_setValue()

◆ tfIoMetaData_init()

◆ tfIoThreeDFEdgeData_destroy()

◆ tfIoThreeDFEdgeData_getFaces()

◆ tfIoThreeDFEdgeData_getId()

◆ tfIoThreeDFEdgeData_getMeshes()

◆ tfIoThreeDFEdgeData_getNumFaces()

◆ tfIoThreeDFEdgeData_getNumMeshes()

◆ tfIoThreeDFEdgeData_getStructure()

◆ tfIoThreeDFEdgeData_getVertices()

◆ tfIoThreeDFEdgeData_hasStructure()

◆ tfIoThreeDFEdgeData_hasVertex()

◆ tfIoThreeDFEdgeData_inFace()

◆ tfIoThreeDFEdgeData_init()

◆ tfIoThreeDFEdgeData_inMesh()

◆ tfIoThreeDFEdgeData_inStructure()

◆ tfIoThreeDFEdgeData_setFaces()

◆ tfIoThreeDFEdgeData_setId()

◆ tfIoThreeDFEdgeData_setStructure()

◆ tfIoThreeDFEdgeData_setVertices()

◆ tfIoThreeDFFaceData_destroy()

◆ tfIoThreeDFFaceData_getEdges()

◆ tfIoThreeDFFaceData_getId()

◆ tfIoThreeDFFaceData_getMeshes()

◆ tfIoThreeDFFaceData_getNormal()

◆ tfIoThreeDFFaceData_getNumEdges()

◆ tfIoThreeDFFaceData_getNumMeshes()

◆ tfIoThreeDFFaceData_getNumVertices()

◆ tfIoThreeDFFaceData_getStructure()

◆ tfIoThreeDFFaceData_getVertices()

◆ tfIoThreeDFFaceData_hasEdge()

◆ tfIoThreeDFFaceData_hasStructure()

◆ tfIoThreeDFFaceData_hasVertex()

◆ tfIoThreeDFFaceData_init()

◆ tfIoThreeDFFaceData_inMesh()

◆ tfIoThreeDFFaceData_inStructure()

◆ tfIoThreeDFFaceData_setEdges()

◆ tfIoThreeDFFaceData_setId()

◆ tfIoThreeDFFaceData_setMeshes()

◆ tfIoThreeDFFaceData_setNormal()

◆ tfIoThreeDFFaceData_setStructure()

◆ tfIoThreeDFMeshData_destroy()

◆ tfIoThreeDFMeshData_getCentroid()

◆ tfIoThreeDFMeshData_getEdges()

◆ tfIoThreeDFMeshData_getFaces()

◆ tfIoThreeDFMeshData_getId()

◆ tfIoThreeDFMeshData_getName()

◆ tfIoThreeDFMeshData_getNumEdges()

◆ tfIoThreeDFMeshData_getNumFaces()

◆ tfIoThreeDFMeshData_getNumVertices()