HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
SIM_EachDataCallback Class Referenceabstract

#include <SIM_Data.h>

+ Inheritance diagram for SIM_EachDataCallback:

Public Member Functions

 SIM_EachDataCallback ()
 
virtual ~SIM_EachDataCallback ()
 
virtual bool callbackNeedsName () const
 
virtual void callbackConst (const SIM_Data *data, const char *name)=0
 
virtual void callback (SIM_Data *data, const char *name)
 

Detailed Description

This class defines the callback object that is passed to SIM_Data::forEachSubData() and SIM_Data::forEachConstSubData().

Examples:
SIM/SIM_SolverHair.C.

Definition at line 55 of file SIM_Data.h.

Constructor & Destructor Documentation

SIM_EachDataCallback::SIM_EachDataCallback ( )
inline

Definition at line 58 of file SIM_Data.h.

virtual SIM_EachDataCallback::~SIM_EachDataCallback ( )
inlinevirtual

Definition at line 60 of file SIM_Data.h.

Member Function Documentation

virtual void SIM_EachDataCallback::callback ( SIM_Data *  data,
const char *  name 
)
inlinevirtual

This is the callback function that is called for each data found by SIM_Data::forEachSubData(). The default implementation calls the version for const SIM_Data pointers. The name parameter is the relative path to the data item from the starting data item for the search (the startfrom parameter to SIM_Data::forEachSubData()).

Definition at line 80 of file SIM_Data.h.

virtual void SIM_EachDataCallback::callbackConst ( const SIM_Data *  data,
const char *  name 
)
pure virtual

This is the callback function that is called for each data found by SIM_Data::forEachConstSubData(). The name parameter is the relative path to the data item from the starting data item for the search (the startfrom parameter to SIM_Data::forEachConstSubData()).

Implemented in HDK_Sample::SIM_HairForceCallback.

virtual bool SIM_EachDataCallback::callbackNeedsName ( ) const
inlinevirtual

If your callback functions require the names of the data, override this function to return true. Otherwise the name parameter to the callback functions will always be null. Sending the name information to the callback introduces a small performance penalty.

Definition at line 67 of file SIM_Data.h.

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