HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_RelationshipSource.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  */
7 
8 #ifndef __SIM_RelationshipSource_h__
9 #define __SIM_RelationshipSource_h__
10 
11 #include "SIM_API.h"
12 #include "SIM_RelationshipData.h"
13 
14 /// This class defines a source relationship between objects. Source
15 /// relationships are useful for solvers that generate some physical
16 /// entity as part of the solve process. An example of this would be
17 /// the fluid solver which may use another DOP object as a fluid source
18 /// to generate new fluid. Another example is the HDK sample Snow
19 /// solver or Hair solver which generate snow and hair using a source
20 /// object.
22 {
23 protected:
24  explicit SIM_RelationshipSource(const SIM_DataFactory *factory);
25  virtual ~SIM_RelationshipSource();
26 
27 private:
28  static const SIM_DopDescription *getSourceDopDescription();
29 
33  "Source Relationship",
34  getSourceDopDescription());
35 };
36 
37 #endif
38 
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
#define DECLARE_DATAFACTORY(DataClass, SuperClass, Description, DopParms)
Definition: SIM_DataUtils.h:58
#define SIM_API
Definition: SIM_API.h:10