tfCCluster.h File Reference

#include "tf_port_c.h"
#include "tfCParticle.h"

Include dependency graph for tfCCluster.h:

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

Go to the source code of this file.

Data Structures
struct	tfClusterTypeSpec
	Cluster type definition in Tissue Forge C. More...
struct	tfClusterParticleHandleHandle
	Handle to a ClusterParticleHandle instance. More...
struct	tfClusterParticleTypeHandle
	Handle to a ClusterParticleType instance. More...

Functions
struct tfClusterTypeSpec	tfClusterTypeSpec_init ()
	Get a default definition.
HRESULT	tfClusterParticleHandle_init (struct tfClusterParticleHandleHandle *handle, int id)
	Initialize an instance.
HRESULT	tfClusterParticleHandle_destroy (struct tfClusterParticleHandleHandle *handle)
	Destroy an instance.
HRESULT	tfClusterParticleHandle_createParticle (struct tfClusterParticleHandleHandle *handle, struct tfParticleTypeHandle *partTypeHandle, int *pid, tfFloatP_t **position, tfFloatP_t **velocity)
	Constituent particle constructor.
HRESULT	tfClusterParticleHandle_createParticleS (struct tfClusterParticleHandleHandle *handle, struct tfParticleTypeHandle *partTypeHandle, int *pid, const char *str)
	Constituent particle constructor.
HRESULT	tfClusterParticleHandle_hasPartId (struct tfClusterParticleHandleHandle *handle, int pid, bool *result)
	Test whether the cluster has an id.
HRESULT	tfClusterParticleHandle_hasPart (struct tfClusterParticleHandleHandle *handle, struct tfParticleHandleHandle *part, bool *result)
	Test whether the cluster has a particle.
HRESULT	tfClusterParticleHandle_splitAxis (struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t *axis, tfFloatP_t time)
	Split the cluster along an axis.
HRESULT	tfClusterParticleHandle_splitRand (struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t time)
	Split the cluster randomly.
HRESULT	tfClusterParticleHandle_split (struct tfClusterParticleHandleHandle *handle, int *cid, tfFloatP_t time, tfFloatP_t *normal, tfFloatP_t *point)
	Split the cluster along a point and normal.
HRESULT	tfClusterParticleHandle_getNumParts (struct tfClusterParticleHandleHandle *handle, int *numParts)
	Get the number of particles that are a member of this cluster.
HRESULT	tfClusterParticleHandle_getParts (struct tfClusterParticleHandleHandle *handle, struct tfParticleListHandle *parts)
	Get the particles that are a member of this cluster.
HRESULT	tfClusterParticleHandle_getParticle (struct tfClusterParticleHandleHandle *handle, int i, struct tfParticleHandleHandle *parthandle)
	Get the i'th particle that's a member of this cluster.
HRESULT	tfClusterParticleHandle_str (struct tfClusterParticleHandleHandle *handle, char **str, unsigned int *numChars)
	Get a summary string of the cluster.
HRESULT	tfClusterParticleHandle_getRadiusOfGyration (struct tfClusterParticleHandleHandle *handle, tfFloatP_t *radiusOfGyration)
	Get the radius of gyration.
HRESULT	tfClusterParticleHandle_getCenterOfMass (struct tfClusterParticleHandleHandle *handle, tfFloatP_t **com)
	Get the center of mass.
HRESULT	tfClusterParticleHandle_getCentroid (struct tfClusterParticleHandleHandle *handle, tfFloatP_t **cent)
	Get the centroid.
HRESULT	tfClusterParticleHandle_getMomentOfInertia (struct tfClusterParticleHandleHandle *handle, tfFloatP_t **moi)
	Get the moment of inertia.
HRESULT	tfClusterParticleType_init (struct tfClusterParticleTypeHandle *handle)
	Initialize an instance.
HRESULT	tfClusterParticleType_initD (struct tfClusterParticleTypeHandle *handle, struct tfClusterTypeSpec pdef)
	Initialize an instance from a definition.
HRESULT	tfClusterParticleType_addType (struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *phandle)
	Add a particle type to the types of a cluster.
HRESULT	tfClusterParticleType_str (struct tfClusterParticleTypeHandle *handle, char **str, unsigned int *numChars)
	Get a summary string of the type.
HRESULT	tfClusterParticleType_hasType (struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *phandle, bool *hasType)
	Tests where this cluster has a particle type.
HRESULT	tfClusterParticleType_hasTypeId (struct tfClusterParticleTypeHandle *handle, int pid, bool *result)
	Test whether the type has a type id.
HRESULT	tfClusterParticleType_hasTypeML (struct tfClusterParticleTypeHandle *handle, struct tfParticleTypeHandle *ptype, bool *result)
	Test whether the type has a type.
HRESULT	tfClusterParticleType_hasPart (struct tfClusterParticleTypeHandle *handle, struct tfParticleHandleHandle *part, bool *result)
	Test whether the type has a particle.
HRESULT	tfClusterParticleType_registerType (struct tfClusterParticleTypeHandle *handle)
	Registers a type with the engine.
HRESULT	tfClusterParticleType_createParticle (struct tfClusterParticleTypeHandle *handle, int *pid, tfFloatP_t *position, tfFloatP_t *velocity)
	Cluster particle constructor.
HRESULT	tfClusterParticleType_FindFromName (struct tfClusterParticleTypeHandle *handle, const char *name)
	Get a registered cluster type by type name.
HRESULT	tfClusterParticleType_getFromId (struct tfClusterParticleTypeHandle *handle, unsigned int pid)
	Get a registered cluster type by id.

Function Documentation

tfClusterParticleHandle_createParticle()

HRESULT tfClusterParticleHandle_createParticle	(	struct tfClusterParticleHandleHandle *	handle,
		struct tfParticleTypeHandle *	partTypeHandle,
		int *	pid,
		tfFloatP_t **	position,
		tfFloatP_t **	velocity )

Constituent particle constructor.

The created particle will belong to this cluster.

Automatically updates when running on a CUDA device.

Parameters

handle	populated handle
partTypeHandle	type of particle to create
pid	id of created particle
position	pointer to 3-element array, or NULL for a random position
velocity	pointer to 3-element array, or NULL for a random velocity

Returns

S_OK on success

tfClusterParticleHandle_createParticleS()

HRESULT tfClusterParticleHandle_createParticleS	(	struct tfClusterParticleHandleHandle *	handle,
		struct tfParticleTypeHandle *	partTypeHandle,
		int *	pid,
		const char *	str )

Constituent particle constructor.

The created particle will belong to this cluster.

Automatically updates when running on a CUDA device.

Parameters

handle	populated handle
partTypeHandle	type of particle to create
pid	id of created particle
str	JSON string defining a particle

Returns

S_OK on success

tfClusterParticleHandle_destroy()

HRESULT tfClusterParticleHandle_destroy

(

struct tfClusterParticleHandleHandle *

handle

)

Destroy an instance.

Parameters

handle

populated handle

Returns

S_OK on success

tfClusterParticleHandle_getCenterOfMass()

HRESULT tfClusterParticleHandle_getCenterOfMass	(	struct tfClusterParticleHandleHandle *	handle,
		tfFloatP_t **	com )

Get the center of mass.

Returns

S_OK on success

tfClusterParticleHandle_getCentroid()

HRESULT tfClusterParticleHandle_getCentroid	(	struct tfClusterParticleHandleHandle *	handle,
		tfFloatP_t **	cent )

Get the centroid.

Returns

S_OK on success

tfClusterParticleHandle_getMomentOfInertia()

HRESULT tfClusterParticleHandle_getMomentOfInertia	(	struct tfClusterParticleHandleHandle *	handle,
		tfFloatP_t **	moi )

Get the moment of inertia.

Returns

S_OK on success

tfClusterParticleHandle_getNumParts()

HRESULT tfClusterParticleHandle_getNumParts	(	struct tfClusterParticleHandleHandle *	handle,
		int *	numParts )

Get the number of particles that are a member of this cluster.

Parameters

handle	populated handle
numParts	number of particles

Returns

S_OK on success

tfClusterParticleHandle_getParticle()

HRESULT tfClusterParticleHandle_getParticle	(	struct tfClusterParticleHandleHandle *	handle,
		int	i,
		struct tfParticleHandleHandle *	parthandle )

Get the i'th particle that's a member of this cluster.

Parameters

handle	populated handle
i	index of particle to get
parthandle	particle handle to populate

Returns

S_OK on success

tfClusterParticleHandle_getParts()

HRESULT tfClusterParticleHandle_getParts	(	struct tfClusterParticleHandleHandle *	handle,
		struct tfParticleListHandle *	parts )

Get the particles that are a member of this cluster.

Parameters

handle	populated handle
parts	particles

Returns

S_OK on success

tfClusterParticleHandle_getRadiusOfGyration()

HRESULT tfClusterParticleHandle_getRadiusOfGyration	(	struct tfClusterParticleHandleHandle *	handle,
		tfFloatP_t *	radiusOfGyration )

Get the radius of gyration.

Returns

S_OK on success

tfClusterParticleHandle_hasPart()

HRESULT tfClusterParticleHandle_hasPart	(	struct tfClusterParticleHandleHandle *	handle,
		struct tfParticleHandleHandle *	part,
		bool *	result )

Test whether the cluster has a particle.

Parameters

handle	populated handle
part	particle to test
result	result of test

Returns

S_OK on success

tfClusterParticleHandle_hasPartId()

HRESULT tfClusterParticleHandle_hasPartId	(	struct tfClusterParticleHandleHandle *	handle,
		int	pid,
		bool *	result )

Test whether the cluster has an id.

Parameters

handle	populated handle
pid	particle id to test
result	result of test

Returns

S_OK on success

tfClusterParticleHandle_init()

HRESULT tfClusterParticleHandle_init	(	struct tfClusterParticleHandleHandle *	handle,
		int	id )

Initialize an instance.

Parameters

handle	handle to populate
id	particle id

Returns

S_OK on success

tfClusterParticleHandle_split()

HRESULT tfClusterParticleHandle_split	(	struct tfClusterParticleHandleHandle *	handle,
		int *	cid,
		tfFloatP_t	time,
		tfFloatP_t *	normal,
		tfFloatP_t *	point )

Split the cluster along a point and normal.

Parameters

handle	populated handle
cid	id of created cluster
time	time at which to implement the split; currently not supported
normal	3-component normal vector of cleavage plane
point	3-component point on cleavage plane

Returns

S_OK on success

tfClusterParticleHandle_splitAxis()

HRESULT tfClusterParticleHandle_splitAxis	(	struct tfClusterParticleHandleHandle *	handle,
		int *	cid,
		tfFloatP_t *	axis,
		tfFloatP_t	time )

Split the cluster along an axis.

Parameters

handle	populated handle
cid	id of created cluster
axis	3-component allocated axis of split
time	time at which to implement the split; currently not supported

Returns

S_OK on success

tfClusterParticleHandle_splitRand()

HRESULT tfClusterParticleHandle_splitRand	(	struct tfClusterParticleHandleHandle *	handle,
		int *	cid,
		tfFloatP_t	time )

Split the cluster randomly.

Parameters

handle	populated handle
cid	id of created cluster
time	time at which to implement the split; currently not supported

Returns

S_OK on success

tfClusterParticleHandle_str()

HRESULT tfClusterParticleHandle_str	(	struct tfClusterParticleHandleHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a summary string of the cluster.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfClusterParticleType_addType()

HRESULT tfClusterParticleType_addType	(	struct tfClusterParticleTypeHandle *	handle,
		struct tfParticleTypeHandle *	phandle )

Add a particle type to the types of a cluster.

Parameters

handle	populated handle
phandle	handle to add

Returns

S_OK on success

tfClusterParticleType_createParticle()

HRESULT tfClusterParticleType_createParticle	(	struct tfClusterParticleTypeHandle *	handle,
		int *	pid,
		tfFloatP_t *	position,
		tfFloatP_t *	velocity )

Cluster particle constructor.

Parameters

handle	populated handle
pid	id of created particle
position	pointer to 3-element array, or NULL for a random position
velocity	pointer to 3-element array, or NULL for a random velocity

Returns

S_OK on success

tfClusterParticleType_FindFromName()

HRESULT tfClusterParticleType_FindFromName	(	struct tfClusterParticleTypeHandle *	handle,
		const char *	name )

Get a registered cluster type by type name.

Parameters

handle	handle to populate
name	name of cluster type

Returns

S_OK on success

tfClusterParticleType_getFromId()

HRESULT tfClusterParticleType_getFromId	(	struct tfClusterParticleTypeHandle *	handle,
		unsigned int	pid )

Get a registered cluster type by id.

Parameters

handle	handle to populate
pid	id of type

Returns

S_OK on success

tfClusterParticleType_hasPart()

HRESULT tfClusterParticleType_hasPart	(	struct tfClusterParticleTypeHandle *	handle,
		struct tfParticleHandleHandle *	part,
		bool *	result )

Test whether the type has a particle.

Parameters

handle	populated handle
part	particle to test
result	result of test

Returns

S_OK on success

tfClusterParticleType_hasType()

HRESULT tfClusterParticleType_hasType	(	struct tfClusterParticleTypeHandle *	handle,
		struct tfParticleTypeHandle *	phandle,
		bool *	hasType )

Tests where this cluster has a particle type.

Only tests for immediate ownership and ignores multi-level clusters.

Returns

S_OK on success

tfClusterParticleType_hasTypeId()

HRESULT tfClusterParticleType_hasTypeId	(	struct tfClusterParticleTypeHandle *	handle,
		int	pid,
		bool *	result )

Test whether the type has a type id.

Parameters

handle	populated handle
pid	id to test
result	result of test

Returns

S_OK on success

tfClusterParticleType_hasTypeML()

HRESULT tfClusterParticleType_hasTypeML	(	struct tfClusterParticleTypeHandle *	handle,
		struct tfParticleTypeHandle *	ptype,
		bool *	result )

Test whether the type has a type.

Parameters

handle	populated handle
ptype	type to test
result	result of test

Returns

S_OK on success

tfClusterParticleType_init()

HRESULT tfClusterParticleType_init

(

struct tfClusterParticleTypeHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfClusterParticleType_initD()

HRESULT tfClusterParticleType_initD	(	struct tfClusterParticleTypeHandle *	handle,
		struct tfClusterTypeSpec	pdef )

Initialize an instance from a definition.

Parameters

handle	handle to populate
pdef	definition

Returns

S_OK on success

tfClusterParticleType_registerType()

HRESULT tfClusterParticleType_registerType

(

struct tfClusterParticleTypeHandle *

handle

)

Registers a type with the engine.

Also registers all unregistered constituent types.

Returns

S_OK on success

tfClusterParticleType_str()

HRESULT tfClusterParticleType_str	(	struct tfClusterParticleTypeHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a summary string of the type.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success