TissueForge::SubEngine Struct Reference

A SubEngine is a singleton object that injects dynamics into the Tissue Forge engine. It does not necessarily integrate any object in time, but can also simply add to the dynamics of existing Tissue Forge objects. Tissue Forge supports an arbitrary number of subengines with multi-threading and GPU support. More...

#include <tfSubEngine.h>

Inheritance diagram for TissueForge::SubEngine:

Public Member Functions
HRESULT	registerEngine ()
	Register with the Tissue Forge engine.
virtual HRESULT	preStepStart ()
	First call before forces are calculated for a step.
virtual HRESULT	preStepJoin ()
	Last call before forces are calculated for a step.
virtual HRESULT	postStepStart ()
	First call after forces are calculated, and before events are executed, for a step.
virtual HRESULT	postStepJoin ()
	Last call after forces are calculated, and before events are executed, for a step.
virtual HRESULT	finalize ()
	Called during termination of a simulation, just before shutdown of Tissue Forge engine.

Public Attributes
const char *	name

Detailed Description

A SubEngine is a singleton object that injects dynamics into the Tissue Forge engine. It does not necessarily integrate any object in time, but can also simply add to the dynamics of existing Tissue Forge objects. Tissue Forge supports an arbitrary number of subengines with multi-threading and GPU support.

Member Function Documentation

finalize()

virtual HRESULT TissueForge::SubEngine::finalize ( )

inlinevirtual

Called during termination of a simulation, just before shutdown of Tissue Forge engine.

Returns

HRESULT

postStepJoin()

virtual HRESULT TissueForge::SubEngine::postStepJoin ( )

inlinevirtual

Last call after forces are calculated, and before events are executed, for a step.

Returns

HRESULT

Reimplemented in TissueForge::models::vertex::MeshSolver.

postStepStart()

virtual HRESULT TissueForge::SubEngine::postStepStart ( )

inlinevirtual

First call after forces are calculated, and before events are executed, for a step.

Returns

HRESULT

Reimplemented in TissueForge::models::vertex::MeshSolver.

preStepJoin()

virtual HRESULT TissueForge::SubEngine::preStepJoin ( )

inlinevirtual

Last call before forces are calculated for a step.

Returns

HRESULT

Reimplemented in TissueForge::models::vertex::MeshSolver.

preStepStart()

virtual HRESULT TissueForge::SubEngine::preStepStart ( )

inlinevirtual

First call before forces are calculated for a step.

Returns

HRESULT

Reimplemented in TissueForge::models::vertex::MeshSolver.

registerEngine()

HRESULT TissueForge::SubEngine::registerEngine

(

)

Register with the Tissue Forge engine.

Returns

HRESULT

Member Data Documentation

name

const char* TissueForge::SubEngine::name

Unique name of the engine. No two registered engines can have the same name.

---

The documentation for this struct was generated from the following file:

• source/mdcore/src/tfSubEngine.h