tfCBody.h File Reference

#include <tf_port_c.h>
#include <tfC_io.h>

Include dependency graph for tfCBody.h:

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

Go to the source code of this file.

Data Structures
struct	tfVertexSolverBodyTypeSpec
	Body type definition in Tissue Forge C. More...
struct	tfVertexSolverBodyHandleHandle
	Handle to a models::vertex::BodyHandle instance. More...
struct	tfVertexSolverBodyTypeHandle
	Handle to a models::vertex::BodyType instance. More...

Functions
struct tfVertexSolverBodyTypeSpec	tfVertexSolverBodyTypeSpec_init ()
	Get a default definition.
HRESULT	tfVertexSolverBodyHandle_init (struct tfVertexSolverBodyHandleHandle *handle, int id)
	Initialize an instance.
HRESULT	tfVertexSolverBodyHandle_fromString (struct tfVertexSolverBodyHandleHandle *handle, const char *s)
	Create an instance from a JSON string representation.
HRESULT	tfVertexSolverBodyHandle_destroy (struct tfVertexSolverBodyHandleHandle *handle)
	Destroy an instance.
HRESULT	tfVertexSolverBodyHandle_getId (struct tfVertexSolverBodyHandleHandle *handle, int *objId)
	Get the object id.
HRESULT	tfVertexSolverBodyHandle_definedByVertex (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v, bool *result)
	Test whether a body is defined by a vertex.
HRESULT	tfVertexSolverBodyHandle_definedBySurface (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle *s, bool *result)
	Test whether a body is defined by a surface.
HRESULT	tfVertexSolverBodyHandle_objType (struct tfVertexSolverBodyHandleHandle *handle, unsigned int *label)
	Get the mesh object type.
HRESULT	tfVertexSolverBodyHandle_destroyBody (struct tfVertexSolverBodyHandleHandle *handle)
	Destroy the body.
HRESULT	tfVertexSolverBodyHandle_destroyBodies (struct tfVertexSolverBodyHandleHandle **handles, unsigned int numObjs)
	Destroy instances.
HRESULT	tfVertexSolverBodyHandle_destroyBodyC (struct tfVertexSolverBodyHandleHandle *handle)
	Destroy the body.
HRESULT	tfVertexSolverBodyHandle_validate (struct tfVertexSolverBodyHandleHandle *handle, bool *result)
	Validate the body.
HRESULT	tfVertexSolverBodyHandle_positionChanged (struct tfVertexSolverBodyHandleHandle *handle)
	Update internal data due to a change in position.
HRESULT	tfVertexSolverBodyHandle_str (struct tfVertexSolverBodyHandleHandle *handle, char **str, unsigned int *numChars)
	Get a summary string.
HRESULT	tfVertexSolverBodyHandle_toString (struct tfVertexSolverBodyHandleHandle *handle, char **str, unsigned int *numChars)
	Get a JSON string representation.
HRESULT	tfVertexSolverBodyHandle_add (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle *s)
	Add a surface.
HRESULT	tfVertexSolverBodyHandle_remove (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle *s)
	Remove a surface.
HRESULT	tfVertexSolverBodyHandle_replace (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle *toInsert, struct tfVertexSolverSurfaceHandleHandle *toRemove)
	Replace a surface a surface.
HRESULT	tfVertexSolverBodyHandle_getType (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyTypeHandle *btype)
	Get the body type.
HRESULT	tfVertexSolverBodyHandle_become (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyTypeHandle *btype)
	Become a different type.
HRESULT	tfVertexSolverBodyHandle_getSurfaces (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle **objs, int *numObjs)
	Get the surfaces that define the body.
HRESULT	tfVertexSolverBodyHandle_getVertices (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverVertexHandleHandle **objs, int *numObjs)
	Get the vertices that define the body.
HRESULT	tfVertexSolverBodyHandle_findVertex (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *dir, struct tfVertexSolverVertexHandleHandle *v)
	Find a vertex that defines this body.
HRESULT	tfVertexSolverBodyHandle_findSurface (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *dir, struct tfVertexSolverSurfaceHandleHandle *s)
	Find a surface that defines this body.
HRESULT	tfVertexSolverBodyHandle_connectedBodies (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyHandleHandle **objs, int *numObjs)
	Get the connected bodies.
HRESULT	tfVertexSolverBodyHandle_adjacentBodies (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyHandleHandle **objs, int *numObjs)
	Get the adjacent bodies.
HRESULT	tfVertexSolverBodyHandle_neighborSurfaces (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverSurfaceHandleHandle *s, struct tfVertexSolverSurfaceHandleHandle **objs, int *numObjs)
	Get the neighboring surfaces of a surface on this body.
HRESULT	tfVertexSolverBodyHandle_getDensity (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *result)
	Get the mass density.
HRESULT	tfVertexSolverBodyHandle_setDensity (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t density)
	Set the mass density.
HRESULT	tfVertexSolverBodyHandle_getCentroid (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t **result)
	Get the centroid.
HRESULT	tfVertexSolverBodyHandle_getVelocity (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t **result)
	Get the velocity, calculated as the velocity of the centroid.
HRESULT	tfVertexSolverBodyHandle_getArea (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *result)
	Get the surface area.
HRESULT	tfVertexSolverBodyHandle_getVolume (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *result)
	Get the volume.
HRESULT	tfVertexSolverBodyHandle_getMass (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *result)
	Get the mass.
HRESULT	tfVertexSolverBodyHandle_getVertexArea (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v, tfFloatP_t *result)
	Get the surface area contribution of a vertex to this body.
HRESULT	tfVertexSolverBodyHandle_getVertexVolume (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v, tfFloatP_t *result)
	Get the volume contribution of a vertex to this body.
HRESULT	tfVertexSolverBodyHandle_getVertexMass (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverVertexHandleHandle *v, tfFloatP_t *result)
	Get the mass contribution of a vertex to this body.
HRESULT	tfVertexSolverBodyHandle_findInterface (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyHandleHandle *b, struct tfVertexSolverSurfaceHandleHandle **objs, int *numObjs)
	Get the surfaces that define the interface between this body and another body.
HRESULT	tfVertexSolverBodyHandle_contactArea (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyHandleHandle *other, tfFloatP_t *result)
	Get the contacting surface area of this body with another body.
HRESULT	tfVertexSolverBodyHandle_sharedVertices (struct tfVertexSolverBodyHandleHandle *handle, struct tfVertexSolverBodyHandleHandle *other, struct tfVertexSolverVertexHandleHandle **objs, int *numObjs)
	Get the vertices that define both this body and another body.
HRESULT	tfVertexSolverBodyHandle_isOutside (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *pos, bool *result)
	Test whether a point is outside. Test is performed using the nearest surface.
HRESULT	tfVertexSolverBodyHandle_split (struct tfVertexSolverBodyHandleHandle *handle, tfFloatP_t *cp_pos, tfFloatP_t *cp_norm, struct tfVertexSolverSurfaceTypeHandle *stype, struct tfVertexSolverBodyHandleHandle *newObj)
	Split into two bodies. The split is defined by a cut plane.
HRESULT	tfVertexSolverBodyType_init (struct tfVertexSolverBodyTypeHandle *handle)
	Initialize a new instance.
HRESULT	tfVertexSolverBodyType_initD (struct tfVertexSolverBodyTypeHandle *handle, struct tfVertexSolverBodyTypeSpec bdef)
	Initialize an instance from a definition.
HRESULT	tfVertexSolverBodyType_fromString (struct tfVertexSolverBodyTypeHandle *handle, const char *s)
	Create an instance from a JSON string representation.
HRESULT	tfVertexSolverBodyType_objType (struct tfVertexSolverBodyTypeHandle *handle, unsigned int *label)
	Get the mesh object type.
HRESULT	tfVertexSolverBodyType_str (struct tfVertexSolverBodyTypeHandle *handle, char **str, unsigned int *numChars)
	Get a summary string.
HRESULT	tfVertexSolverBodyType_toString (struct tfVertexSolverBodyTypeHandle *handle, char **str, unsigned int *numChars)
	Get a JSON string representation.
HRESULT	tfVertexSolverBodyType_registerType (struct tfVertexSolverBodyTypeHandle *handle)
	Registers a type with the engine.
HRESULT	tfVertexSolverBodyType_isRegistered (struct tfVertexSolverBodyTypeHandle *handle, bool *result)
	Tests whether this type is registered.
HRESULT	tfVertexSolverBodyType_getInstances (struct tfVertexSolverBodyTypeHandle *handle, struct tfVertexSolverBodyHandleHandle **objs, int *numObjs)
	Get a list of instances that belong to this type.
HRESULT	tfVertexSolverBodyType_getInstanceIds (struct tfVertexSolverBodyTypeHandle *handle, int **ids, int *numObjs)
	Get a list of instances ids that belong to this type.
HRESULT	tfVertexSolverBodyType_getName (struct tfVertexSolverBodyTypeHandle *handle, char **str, unsigned int *numChars)
	Name of this body type.
HRESULT	tfVertexSolverBodyType_setName (struct tfVertexSolverBodyTypeHandle *handle, const char *name)
	Set the name of this body type.
HRESULT	tfVertexSolverBodyType_getDensity (struct tfVertexSolverBodyTypeHandle *handle, tfFloatP_t *result)
	Get the mass density.
HRESULT	tfVertexSolverBodyType_setDensity (struct tfVertexSolverBodyTypeHandle *handle, tfFloatP_t density)
	Set the mass density.
HRESULT	tfVertexSolverBodyType_createBodyS (struct tfVertexSolverBodyTypeHandle *handle, struct tfVertexSolverSurfaceHandleHandle **surfaces, unsigned int numSurfaces, struct tfVertexSolverBodyHandleHandle *newObj)
	Construct a body of this type from a set of surfaces.
HRESULT	tfVertexSolverBodyType_createBodyIO (struct tfVertexSolverBodyTypeHandle *handle, struct tfIoThreeDFMeshDataHandle *ioMesh, struct tfVertexSolverSurfaceTypeHandle *stype, struct tfVertexSolverBodyHandleHandle *newObj)
	Construct a body of this type from a mesh.
HRESULT	tfVertexSolverBodyType_extend (struct tfVertexSolverBodyTypeHandle *handle, struct tfVertexSolverSurfaceHandleHandle *base, tfFloatP_t *pos, struct tfVertexSolverBodyHandleHandle *newObj)
	Create a body from a surface in the mesh and a position.
HRESULT	tfVertexSolverBodyType_extrude (struct tfVertexSolverBodyTypeHandle *handle, struct tfVertexSolverSurfaceHandleHandle *base, tfFloatP_t normLen, struct tfVertexSolverBodyHandleHandle *newObj)
	Create a body from a surface in a mesh by extruding along the outward-facing normal of the surface.
HRESULT	tfVertexSolverCreateBodyBySurfaces (struct tfVertexSolverSurfaceHandleHandle **surfaces, unsigned int numSurfaces, struct tfVertexSolverBodyHandleHandle *newObj)
	Construct a body from a set of surfaces.
HRESULT	tfVertexSolverCreateBodyByIOData (struct tfIoThreeDFMeshDataHandle *ioMesh, struct tfVertexSolverBodyHandleHandle *newObj)
	Construct a body from a mesh.
HRESULT	tfVertexSolverFindBodyTypeFromName (const char *name, struct tfVertexSolverBodyTypeHandle *btype)
	Get a registered type by name.
HRESULT	tfVertexSolverBindBodyTypeAdhesion (struct tfVertexSolverBodyTypeHandle **btypes, struct tfVertexSolverBodyTypeSpec *bdefs, unsigned int numTypes)
	Bind adhesion for all types with matching specification.

Function Documentation

tfVertexSolverBindBodyTypeAdhesion()

HRESULT tfVertexSolverBindBodyTypeAdhesion	(	struct tfVertexSolverBodyTypeHandle **	btypes,
		struct tfVertexSolverBodyTypeSpec *	bdefs,
		unsigned int	numTypes )

Bind adhesion for all types with matching specification.

Parameters

btypes	body types to bind
bdefs	body type definitions
numTypes	number of types

tfVertexSolverBodyHandle_add()

HRESULT tfVertexSolverBodyHandle_add	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	s )

Add a surface.

Parameters

handle	populated handle
s	surface to add

tfVertexSolverBodyHandle_adjacentBodies()

HRESULT tfVertexSolverBodyHandle_adjacentBodies	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyHandleHandle **	objs,
		int *	numObjs )

Get the adjacent bodies.

A body is adjacent if it shares a surface.

Parameters

handle	populated handle
objs	adjacent bodies
numObjs	number of adjacent bodies

tfVertexSolverBodyHandle_become()

HRESULT tfVertexSolverBodyHandle_become	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyTypeHandle *	btype )

Become a different type.

Parameters

handle	populated handle
btype	type to become

tfVertexSolverBodyHandle_connectedBodies()

HRESULT tfVertexSolverBodyHandle_connectedBodies	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyHandleHandle **	objs,
		int *	numObjs )

Get the connected bodies.

A body is connected if it shares a surface.

Parameters

handle	populated handle
objs	connected bodies
numObjs	number of connected bodies

tfVertexSolverBodyHandle_contactArea()

HRESULT tfVertexSolverBodyHandle_contactArea	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyHandleHandle *	other,
		tfFloatP_t *	result )

Get the contacting surface area of this body with another body.

Parameters

handle	populated handle
other	another body
result	contacting surface area

tfVertexSolverBodyHandle_definedBySurface()

HRESULT tfVertexSolverBodyHandle_definedBySurface	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	s,
		bool *	result )

Test whether a body is defined by a surface.

Parameters

handle	populated handle
s	surface
result	result of the test

tfVertexSolverBodyHandle_definedByVertex()

HRESULT tfVertexSolverBodyHandle_definedByVertex	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverVertexHandleHandle *	v,
		bool *	result )

Test whether a body is defined by a vertex.

Parameters

handle	populated handle
v	vertex
result	result of the test

tfVertexSolverBodyHandle_destroy()

HRESULT tfVertexSolverBodyHandle_destroy

(

struct tfVertexSolverBodyHandleHandle *

handle

)

Destroy an instance.

Parameters

handle

populated handle

tfVertexSolverBodyHandle_destroyBodies()

HRESULT tfVertexSolverBodyHandle_destroyBodies	(	struct tfVertexSolverBodyHandleHandle **	handles,
		unsigned int	numObjs )

Destroy instances.

Parameters

handles	populated handles
numObjs	number of objects to destroy

tfVertexSolverBodyHandle_destroyBody()

HRESULT tfVertexSolverBodyHandle_destroyBody

(

struct tfVertexSolverBodyHandleHandle *

handle

)

Destroy the body.

Parameters

handle

populated handle

tfVertexSolverBodyHandle_destroyBodyC()

HRESULT tfVertexSolverBodyHandle_destroyBodyC

(

struct tfVertexSolverBodyHandleHandle *

handle

)

Destroy the body.

Any resulting surfaces without a body are also destroyed.

Parameters

handle

populated handle

tfVertexSolverBodyHandle_findInterface()

HRESULT tfVertexSolverBodyHandle_findInterface	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyHandleHandle *	b,
		struct tfVertexSolverSurfaceHandleHandle **	objs,
		int *	numObjs )

Get the surfaces that define the interface between this body and another body.

Parameters

handle	populated handle
b	a body
objs	interface surfaces
numObjs	number of interface surfaces

tfVertexSolverBodyHandle_findSurface()

HRESULT tfVertexSolverBodyHandle_findSurface	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	dir,
		struct tfVertexSolverSurfaceHandleHandle *	s )

Find a surface that defines this body.

Parameters

handle	populated handle
dir	direction to look with respect to the centroid
s	surface

tfVertexSolverBodyHandle_findVertex()

HRESULT tfVertexSolverBodyHandle_findVertex	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	dir,
		struct tfVertexSolverVertexHandleHandle *	v )

Find a vertex that defines this body.

Parameters

handle	populated handle
dir	direction to look with respect to the centroid
v	vertex

tfVertexSolverBodyHandle_fromString()

HRESULT tfVertexSolverBodyHandle_fromString	(	struct tfVertexSolverBodyHandleHandle *	handle,
		const char *	s )

Create an instance from a JSON string representation.

Parameters

handle	handle to populate
s	JSON string

tfVertexSolverBodyHandle_getArea()

HRESULT tfVertexSolverBodyHandle_getArea	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	result )

Get the surface area.

Parameters

handle	populated handle
result	surface area

tfVertexSolverBodyHandle_getCentroid()

HRESULT tfVertexSolverBodyHandle_getCentroid	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t **	result )

Get the centroid.

Parameters

handle	populated handle
result	centroid

tfVertexSolverBodyHandle_getDensity()

HRESULT tfVertexSolverBodyHandle_getDensity	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	result )

Get the mass density.

Parameters

handle	populated handle
result	mass density

tfVertexSolverBodyHandle_getId()

HRESULT tfVertexSolverBodyHandle_getId	(	struct tfVertexSolverBodyHandleHandle *	handle,
		int *	objId )

Get the object id.

Parameters

handle	populated handle
objId	object id

tfVertexSolverBodyHandle_getMass()

HRESULT tfVertexSolverBodyHandle_getMass	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	result )

Get the mass.

Parameters

handle	populated handle
result	mass

tfVertexSolverBodyHandle_getSurfaces()

HRESULT tfVertexSolverBodyHandle_getSurfaces	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle **	objs,
		int *	numObjs )

Get the surfaces that define the body.

Parameters

handle	populated handle
objs	surfaces
numObjs	number of surface

tfVertexSolverBodyHandle_getType()

HRESULT tfVertexSolverBodyHandle_getType	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyTypeHandle *	btype )

Get the body type.

Parameters

handle	populated handle
btype	body type

tfVertexSolverBodyHandle_getVelocity()

HRESULT tfVertexSolverBodyHandle_getVelocity	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t **	result )

Get the velocity, calculated as the velocity of the centroid.

Parameters

handle	populated handle
result	velocity

tfVertexSolverBodyHandle_getVertexArea()

HRESULT tfVertexSolverBodyHandle_getVertexArea	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverVertexHandleHandle *	v,
		tfFloatP_t *	result )

Get the surface area contribution of a vertex to this body.

Parameters

handle	populated handle
v	a vertex
result	surface area contribution

tfVertexSolverBodyHandle_getVertexMass()

HRESULT tfVertexSolverBodyHandle_getVertexMass	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverVertexHandleHandle *	v,
		tfFloatP_t *	result )

Get the mass contribution of a vertex to this body.

Parameters

handle	populated handle
v	a vertex
result	mass contribution

tfVertexSolverBodyHandle_getVertexVolume()

HRESULT tfVertexSolverBodyHandle_getVertexVolume	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverVertexHandleHandle *	v,
		tfFloatP_t *	result )

Get the volume contribution of a vertex to this body.

Parameters

handle	populated handle
v	a vertex
result	volume contribution

tfVertexSolverBodyHandle_getVertices()

HRESULT tfVertexSolverBodyHandle_getVertices	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverVertexHandleHandle **	objs,
		int *	numObjs )

Get the vertices that define the body.

Parameters

handle	populated handle
objs	vertices
numObjs	number of vertices

tfVertexSolverBodyHandle_getVolume()

HRESULT tfVertexSolverBodyHandle_getVolume	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	result )

Get the volume.

Parameters

handle	populated handle
result	volume

tfVertexSolverBodyHandle_init()

HRESULT tfVertexSolverBodyHandle_init	(	struct tfVertexSolverBodyHandleHandle *	handle,
		int	id )

Initialize an instance.

Parameters

handle	handle to populate
id	object id

tfVertexSolverBodyHandle_isOutside()

HRESULT tfVertexSolverBodyHandle_isOutside	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	pos,
		bool *	result )

Test whether a point is outside. Test is performed using the nearest surface.

Parameters

handle	populated handle
pos	position
result	result of the test

tfVertexSolverBodyHandle_neighborSurfaces()

HRESULT tfVertexSolverBodyHandle_neighborSurfaces	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	s,
		struct tfVertexSolverSurfaceHandleHandle **	objs,
		int *	numObjs )

Get the neighboring surfaces of a surface on this body.

Two surfaces are a neighbor on this body if they define the body and share a vertex

Parameters

handle	populated handle
s	a surface
objs	neighboring surfaces
numObjs	number of neighboring surfaces

tfVertexSolverBodyHandle_objType()

HRESULT tfVertexSolverBodyHandle_objType	(	struct tfVertexSolverBodyHandleHandle *	handle,
		unsigned int *	label )

Get the mesh object type.

Parameters

handle	populated handle
label	object type label

tfVertexSolverBodyHandle_positionChanged()

HRESULT tfVertexSolverBodyHandle_positionChanged

(

struct tfVertexSolverBodyHandleHandle *

handle

)

Update internal data due to a change in position.

Parameters

handle

populated handle

tfVertexSolverBodyHandle_remove()

HRESULT tfVertexSolverBodyHandle_remove	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	s )

Remove a surface.

Parameters

handle	populated handle
s	surface to remove

tfVertexSolverBodyHandle_replace()

HRESULT tfVertexSolverBodyHandle_replace	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	toInsert,
		struct tfVertexSolverSurfaceHandleHandle *	toRemove )

Replace a surface a surface.

Parameters

handle	populated handle
toInsert	surface to insert
toRemove	surface to remove

tfVertexSolverBodyHandle_setDensity()

HRESULT tfVertexSolverBodyHandle_setDensity	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t	density )

Set the mass density.

Parameters

handle	populated handle
density	mass density

tfVertexSolverBodyHandle_sharedVertices()

HRESULT tfVertexSolverBodyHandle_sharedVertices	(	struct tfVertexSolverBodyHandleHandle *	handle,
		struct tfVertexSolverBodyHandleHandle *	other,
		struct tfVertexSolverVertexHandleHandle **	objs,
		int *	numObjs )

Get the vertices that define both this body and another body.

Parameters

handle	populated handle
other	a body
objs	shared vertices
numObjs	number of shared vertices

tfVertexSolverBodyHandle_split()

HRESULT tfVertexSolverBodyHandle_split	(	struct tfVertexSolverBodyHandleHandle *	handle,
		tfFloatP_t *	cp_pos,
		tfFloatP_t *	cp_norm,
		struct tfVertexSolverSurfaceTypeHandle *	stype,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Split into two bodies. The split is defined by a cut plane.

Parameters

handle	populated handle
cp_pos	position on the cut plane
cp_norm	cut plane normal
stype	type of newly created surface. taken from connected surfaces if specified as 0
newObj	newly created object

tfVertexSolverBodyHandle_str()

HRESULT tfVertexSolverBodyHandle_str	(	struct tfVertexSolverBodyHandleHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a summary string.

Parameters

handle	populated handle
str	summary string
numChars	number of chars

tfVertexSolverBodyHandle_toString()

HRESULT tfVertexSolverBodyHandle_toString	(	struct tfVertexSolverBodyHandleHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	JSON string
numChars	number of chars

tfVertexSolverBodyHandle_validate()

HRESULT tfVertexSolverBodyHandle_validate	(	struct tfVertexSolverBodyHandleHandle *	handle,
		bool *	result )

Validate the body.

Parameters

handle	populated handle
result	result of validation

tfVertexSolverBodyType_createBodyIO()

HRESULT tfVertexSolverBodyType_createBodyIO	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfIoThreeDFMeshDataHandle *	ioMesh,
		struct tfVertexSolverSurfaceTypeHandle *	stype,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Construct a body of this type from a mesh.

Parameters

handle	populated handle
ioMesh	mesh
stype	type of newly created surfaces
newObj	newly created object

tfVertexSolverBodyType_createBodyS()

HRESULT tfVertexSolverBodyType_createBodyS	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle **	surfaces,
		unsigned int	numSurfaces,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Construct a body of this type from a set of surfaces.

Parameters

handle	populated handle
surfaces	set of surfaces
numSurfaces	number of surfaces
newObj	newly created object

tfVertexSolverBodyType_extend()

HRESULT tfVertexSolverBodyType_extend	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	base,
		tfFloatP_t *	pos,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Create a body from a surface in the mesh and a position.

Parameters

handle	populated handle
base	base surface
pos	position
newObj	newly created object

tfVertexSolverBodyType_extrude()

HRESULT tfVertexSolverBodyType_extrude	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfVertexSolverSurfaceHandleHandle *	base,
		tfFloatP_t	normLen,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Create a body from a surface in a mesh by extruding along the outward-facing normal of the surface.

Parameters

handle	populated handle
base	base surface
normLen	length along normal direction by which to extrude
newObj	newly created object

tfVertexSolverBodyType_fromString()

HRESULT tfVertexSolverBodyType_fromString	(	struct tfVertexSolverBodyTypeHandle *	handle,
		const char *	s )

Create an instance from a JSON string representation.

Parameters

handle	handle to populate
s	JSON string

tfVertexSolverBodyType_getDensity()

HRESULT tfVertexSolverBodyType_getDensity	(	struct tfVertexSolverBodyTypeHandle *	handle,
		tfFloatP_t *	result )

Get the mass density.

Parameters

handle	populated handle
result	mass density

tfVertexSolverBodyType_getInstanceIds()

HRESULT tfVertexSolverBodyType_getInstanceIds	(	struct tfVertexSolverBodyTypeHandle *	handle,
		int **	ids,
		int *	numObjs )

Get a list of instances ids that belong to this type.

Parameters

handle	populated handle
ids	list of instances ids
numObjs	number of instances ids

tfVertexSolverBodyType_getInstances()

HRESULT tfVertexSolverBodyType_getInstances	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfVertexSolverBodyHandleHandle **	objs,
		int *	numObjs )

Get a list of instances that belong to this type.

Parameters

handle	populated handle
objs	list of instances
numObjs	number of instances

tfVertexSolverBodyType_getName()

HRESULT tfVertexSolverBodyType_getName	(	struct tfVertexSolverBodyTypeHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Name of this body type.

Parameters

handle	populated handle
str	name
numChars	number of chars

tfVertexSolverBodyType_init()

HRESULT tfVertexSolverBodyType_init

(

struct tfVertexSolverBodyTypeHandle *

handle

)

Initialize a new instance.

Parameters

handle

handle to populate

tfVertexSolverBodyType_initD()

HRESULT tfVertexSolverBodyType_initD	(	struct tfVertexSolverBodyTypeHandle *	handle,
		struct tfVertexSolverBodyTypeSpec	bdef )

Initialize an instance from a definition.

Parameters

handle	handle to populate
bdef	type definition

tfVertexSolverBodyType_isRegistered()

HRESULT tfVertexSolverBodyType_isRegistered	(	struct tfVertexSolverBodyTypeHandle *	handle,
		bool *	result )

Tests whether this type is registered.

Parameters

result

result of the test

tfVertexSolverBodyType_objType()

HRESULT tfVertexSolverBodyType_objType	(	struct tfVertexSolverBodyTypeHandle *	handle,
		unsigned int *	label )

Get the mesh object type.

Parameters

handle	populated handle
label	object type label

tfVertexSolverBodyType_registerType()

HRESULT tfVertexSolverBodyType_registerType

(

struct tfVertexSolverBodyTypeHandle *

handle

)

Registers a type with the engine.

Note that this occurs automatically, unless noReg==true in constructor.

Parameters

handle

populated handle

tfVertexSolverBodyType_setDensity()

HRESULT tfVertexSolverBodyType_setDensity	(	struct tfVertexSolverBodyTypeHandle *	handle,
		tfFloatP_t	density )

Set the mass density.

Parameters

handle	populated handle
density	mass density

tfVertexSolverBodyType_setName()

HRESULT tfVertexSolverBodyType_setName	(	struct tfVertexSolverBodyTypeHandle *	handle,
		const char *	name )

Set the name of this body type.

Parameters

handle	populated handle
name	name

tfVertexSolverBodyType_str()

HRESULT tfVertexSolverBodyType_str	(	struct tfVertexSolverBodyTypeHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a summary string.

Parameters

handle	populated handle
str	summary string
numChars	number of chars

tfVertexSolverBodyType_toString()

HRESULT tfVertexSolverBodyType_toString	(	struct tfVertexSolverBodyTypeHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	JSON string
numChars	number of chars

tfVertexSolverCreateBodyByIOData()

HRESULT tfVertexSolverCreateBodyByIOData	(	struct tfIoThreeDFMeshDataHandle *	ioMesh,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Construct a body from a mesh.

Parameters

ioMesh	mesh
newObj	newly created object

tfVertexSolverCreateBodyBySurfaces()

HRESULT tfVertexSolverCreateBodyBySurfaces	(	struct tfVertexSolverSurfaceHandleHandle **	surfaces,
		unsigned int	numSurfaces,
		struct tfVertexSolverBodyHandleHandle *	newObj )

Construct a body from a set of surfaces.

Parameters

surfaces	set of surfaces
numSurfaces	number of surfaces
newObj	newly created object

tfVertexSolverFindBodyTypeFromName()

HRESULT tfVertexSolverFindBodyTypeFromName	(	const char *	name,
		struct tfVertexSolverBodyTypeHandle *	btype )

Get a registered type by name.

Parameters

name	type name
btype	type