SIM_SingleSolver Class Reference

#include <SIM_SingleSolver.h>

Inheritance diagram for SIM_SingleSolver:

SIM_Solver SIM_Data HDK_Sample::SIM_SolverHair HDK_Sample::SIM_SolverSNOW SIM_SolverCopy SIM_SolverPop SIM_SolverSop SIM_SolverStatic

List of all members.

Public Member Functions

SIM_Result solveSingleObject (SIM_Engine &engine, SIM_Object &object, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep, bool newobject)

Protected Member Functions

 SIM_SingleSolver (const SIM_DataFactory *factory)
 Basic SIM_SingleSolver constructor.
virtual ~SIM_SingleSolver ()
 Basic SIM_SingleSolver destructor.
virtual SIM_Result solveObjectsSubclass (SIM_Engine &engine, SIM_ObjectArray &objects, SIM_ObjectArray &newobjects, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep)
 Override this method to call solveSingleObject().
virtual SIM_Result solveSingleObjectSubclass (SIM_Engine &engine, SIM_Object &object, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep, bool newobject)=0


Detailed Description

This class is a specialized version of SIM_Solver for solvers that handle all objects in mutual affector relationships independently. This class implements the solveObjectsSubclass() and initializeObjectsSubclass() functions by calling the new virtuals solveSingleObjectSubclass() and initializeSingleObjectSubclass() for each object.
Examples:

SIM/SIM_SolverHair.h, and SIM/SIM_SolverSNOW.h.

Definition at line 28 of file SIM_SingleSolver.h.


Constructor & Destructor Documentation

SIM_SingleSolver::SIM_SingleSolver ( const SIM_DataFactory factory  )  [explicit, protected]

Basic SIM_SingleSolver constructor.

virtual SIM_SingleSolver::~SIM_SingleSolver (  )  [protected, virtual]

Basic SIM_SingleSolver destructor.


Member Function Documentation

virtual SIM_Result SIM_SingleSolver::solveObjectsSubclass ( SIM_Engine engine,
SIM_ObjectArray objects,
SIM_ObjectArray newobjects,
SIM_ObjectArray feedbacktoobjects,
const SIM_Time timestep 
) [protected, virtual]

Override this method to call solveSingleObject().

Implements SIM_Solver.

SIM_Result SIM_SingleSolver::solveSingleObject ( SIM_Engine engine,
SIM_Object object,
SIM_ObjectArray feedbacktoobjects,
const SIM_Time timestep,
bool  newobject 
)

Solve for the given object. This function is called for each timestep after the one where the objects are first created. This function calls solveObjectSubclass to perform the real work.

virtual SIM_Result SIM_SingleSolver::solveSingleObjectSubclass ( SIM_Engine engine,
SIM_Object object,
SIM_ObjectArray feedbacktoobjects,
const SIM_Time timestep,
bool  newobject 
) [protected, pure virtual]


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

Generated on Fri May 25 00:10:41 2012 for HDK by  doxygen 1.5.9