HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_SolverHair.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018
3  * Side Effects Software Inc. All rights reserved.
4  *
5  * Redistribution and use of Houdini Development Kit samples in source and
6  * binary forms, with or without modification, are permitted provided that the
7  * following conditions are met:
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. The name of Side Effects Software may not be used to endorse or
11  * promote products derived from this software without specific prior
12  * written permission.
13  *
14  * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
15  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
17  * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
19  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
20  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
21  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
22  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  *----------------------------------------------------------------------------
26  */
27 
28 /*
29  * The simplest network to see something working with this...
30  *
31  * RBD Object EmptyObject
32  * \ |
33  * \ HairSolver
34  * \ |
35  * \__ Gravity
36  * \ /
37  * Merge
38  *
39  * The gravity node should be set to have a non-zero X velocity.
40  * The HairSolver node should have the name of the rbd object
41  * (default rbdobject1) as its Source Object.
42  */
43 
44 
45 #ifndef __SIM_SolverHair_h__
46 #define __SIM_SolverHair_h__
47 
48 #include <SIM/SIM_SingleSolver.h>
49 #include <SIM/SIM_OptionsUser.h>
50 #include <SIM/SIM_Utils.h>
51 
52 #define SIM_NAME_SOURCEOBJECTS "sourceobjects"
53 
54 class SIM_ObjectArray;
55 class SIM_GeometryCopy;
56 
57 namespace HDK_Sample {
58 
59 // This class implemented a computational fluid dynamics solver.
61  public SIM_OptionsUser
62 {
63 protected:
64  explicit SIM_SolverHair(const SIM_DataFactory *factory);
65  virtual ~SIM_SolverHair();
66 
68  SIM_Object &object,
69  SIM_ObjectArray &feedbacktoobjects,
70  const SIM_Time &timestep,
71  bool newobject);
72 
73  // These virtual functions can be overridden to create new hair
74  // solvers that are based on this solver.
75  virtual void createHairFromSource(SIM_GeometryCopy &hairgeo,
76  const SIM_ObjectArray &srcobjs) const;
77  virtual void solveHair(SIM_GeometryCopy &hairgeo,
78  const SIM_ObjectArray &srcobjs,
79  const SIM_Object &object,
80  const SIM_Time &timestep) const;
81 
82 private:
83  static const SIM_DopDescription *getSolverHairDopDescription();
84 
85  DECLARE_STANDARD_GETCASTTOTYPE();
86  DECLARE_DATAFACTORY(SIM_SolverHair,
88  "Hair Solver",
89  getSolverHairDopDescription());
90 };
91 
92 } // End HDK_Sample namespace
93 
94 #endif
95 
virtual void createHairFromSource(SIM_GeometryCopy &hairgeo, const SIM_ObjectArray &srcobjs) const
virtual void solveHair(SIM_GeometryCopy &hairgeo, const SIM_ObjectArray &srcobjs, const SIM_Object &object, const SIM_Time &timestep) const
SIM_SolverHair(const SIM_DataFactory *factory)
Holds pointers to a number of SIM_Object objects.
virtual SIM_Result solveSingleObjectSubclass(SIM_Engine &engine, SIM_Object &object, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep, bool newobject)
This implements a SIM_Geometry that copies the source geometry.