fca539b840203a8c874fa451498291114855749a
[blender-staging.git] / intern / elbeem / intern / ntl_geometryobject.h
1 /** \file elbeem/intern/ntl_geometryobject.h
2  *  \ingroup elbeem
3  */
4 /******************************************************************************
5  *
6  * El'Beem - Free Surface Fluid Simulation with the Lattice Boltzmann Method
7  * Copyright 2003-2006 Nils Thuerey
8  *
9  * a geometry object
10  * all other geometry objects are derived from this one
11  *
12  *****************************************************************************/
13 #ifndef NTL_GEOMETRYOBJECT_H
14 #define NTL_GEOMETRYOBJECT_H
15
16 #include "ntl_geometryclass.h"
17 #include "ntl_lighting.h"
18 #include "ntl_ray.h"
19 class ntlRenderGlobals;
20 class ntlTriangle;
21
22 #define DUMP_FULLGEOMETRY 1
23 #define DUMP_PARTIAL      2
24
25 #define VOLUMEINIT_VOLUME 1
26 #define VOLUMEINIT_SHELL  2
27 #define VOLUMEINIT_BOTH   (VOLUMEINIT_SHELL|VOLUMEINIT_VOLUME)
28
29 class ntlGeometryObject : public ntlGeometryClass
30 {
31
32         public:
33                 //! Default constructor
34                 ntlGeometryObject();
35                 //! Default destructor
36                 virtual ~ntlGeometryObject();
37
38                 //! Return type id
39                 virtual int getTypeId() { return GEOCLASSTID_OBJECT; }
40
41                 /*! Init attributes etc. of this object */
42                 virtual void initialize(ntlRenderGlobals *glob);
43
44                 /*! Get the triangles from this object */
45                 virtual void getTriangles(double t, vector<ntlTriangle> *triangles, 
46                                 vector<ntlVec3Gfx> *vertices, 
47                                 vector<ntlVec3Gfx> *normals, int objectId ) = 0;
48                 
49                 /*! notify object that dump is in progress (e.g. for particles) */
50                 virtual void notifyOfDump(int dumptype, int frameNr,char *frameNrStr,string outfilename, double simtime);
51
52                 /*! Search the material for this object from the material list */
53                 void searchMaterial(vector<ntlMaterial *> *mat);
54
55                 /* Acces methods */
56                 /*! Set the property of this object */
57                 inline void setMaterial(ntlMaterial *p) { mpMaterial = p; }
58                 /*! Get the surface property of this object */
59                 inline ntlMaterial *getMaterial( void ) { return mpMaterial; }
60                 /*! Set the object property name */
61                 inline void setMaterialName(string set) { mMaterialName = set; }
62                 /*! Get the object property name */
63                 inline string getMaterialName( void ) { return mMaterialName; }
64
65                 /*! Sets the receive shadows attribute */
66                 inline void setReceiveShadows(int set) { mReceiveShadows=set; }
67                 /*! Returns the receive shadows attribute */
68                 inline int getReceiveShadows() const { return mReceiveShadows; }
69
70                 /*! Sets the cast shadows attribute */
71                 inline void setCastShadows(int set) { mCastShadows=set; }
72                 /*! Returns the cast shadows attribute */
73                 inline int getCastShadows() const { return mCastShadows; }
74
75                 /*! Returns the geo init typ */
76                 inline void setGeoInitType(int set) { mGeoInitType=set; }
77                 /*! Returns the geo init typ */
78                 inline int getGeoInitType() const { return mGeoInitType; }
79
80                 /*! Set/get the intersect init flag */
81                 inline bool getGeoInitIntersect() const { return mGeoInitIntersect; }
82                 inline void setGeoInitIntersect(bool set) { mGeoInitIntersect=set; }
83
84                 /*! Set/get the part slip value*/
85                 inline float getGeoPartSlipValue() const { return mGeoPartSlipValue; }
86                 inline void setGeoPartSlipValue(float set) { mGeoPartSlipValue=set; }
87
88                 /*! Set/get the impact corr factor channel */
89                 inline float getGeoImpactFactor(double t) { return mcGeoImpactFactor.get(t); }
90                 inline void setGeoImpactFactor(float set) { mcGeoImpactFactor = AnimChannel<float>(set); }
91
92                 /*! Set/get the part slip value*/
93                 inline int getVolumeInit() const { return mVolumeInit; }
94                 inline void setVolumeInit(int set) { mVolumeInit=set; }
95
96                 /*! Set/get the cast initial veocity attribute */
97                 void setInitialVelocity(ntlVec3Gfx set);
98                 ntlVec3Gfx getInitialVelocity(double t);
99
100                 /*! Set/get the local inivel coords flag */
101                 inline bool getLocalCoordInivel() const { return mLocalCoordInivel; }
102                 inline void setLocalCoordInivel(bool set) { mLocalCoordInivel=set; }
103                 
104                 /****************************************/
105                 /* fluid control features */
106                 /****************************************/
107                 /*! Set/get the particle control set attract force strength */
108                 inline float getCpsTimeStart() const { return mCpsTimeStart; }
109                 inline void setCpsTimeStart(float set) { mCpsTimeStart=set; }
110                 
111                 /*! Set/get the particle control set attract force strength */
112                 inline float getCpsTimeEnd() const { return mCpsTimeEnd; }
113                 inline void setCpsTimeEnd(float set) { mCpsTimeEnd=set; }
114                 
115                 /*! Set/get the particle control set quality */
116                 inline float getCpsQuality() const { return mCpsQuality; }
117                 inline void setCpsQuality(float set) { mCpsQuality=set; }
118                 
119                 inline AnimChannel<float> getCpsAttrFStr() const { return mcAttrFStr; }
120                 inline AnimChannel<float> getCpsAttrFRad() const { return mcAttrFRad; }
121                 inline AnimChannel<float> getCpsVelFStr() const { return mcVelFStr; }
122                 inline AnimChannel<float> getCpsVelFRad() const { return mcVelFRad; }
123                 
124                 /****************************************/
125                 
126                 /*! Init channels from float arrays (for elbeem API) */
127                 void initChannels(
128                                 int nTrans, float *trans, int nRot, float *rot, int nScale, float *scale,
129                                 int nAct, float *act, int nIvel, float *ivel,
130                                 int nAttrFStr, float *attrFStr,
131                                 int nAttrFRad, float *attrFRad,
132                                 int nVelFStr, float *velFStr,
133                                 int nVelFRad, float *velFRad
134                                 );
135
136                 /*! is the object animated? */
137                 inline bool getIsAnimated() const { return mIsAnimated; }
138                 /*! init object anim flag */
139                 bool checkIsAnimated();
140                 /*! is the mesh animated? */
141                 virtual bool getMeshAnimated();
142                 /*! init triangle divisions */
143                 virtual void calcTriangleDivs(vector<ntlVec3Gfx> &verts, vector<ntlTriangle> &tris, gfxReal fsTri);
144
145                 /*! apply object translation at time t*/
146                 void applyTransformation(double t, vector<ntlVec3Gfx> *verts, vector<ntlVec3Gfx> *norms, int vstart, int vend, int forceTrafo);
147
148                 /*! Prepare points for moving objects */
149                 void initMovingPoints(double time, gfxReal featureSize);
150                 /*! Prepare points for animated objects */
151                 void initMovingPointsAnim(
152                  double srctime, vector<ntlVec3Gfx> &srcpoints,
153                  double dsttime, vector<ntlVec3Gfx> &dstpoints,
154                  vector<ntlVec3Gfx> *dstnormals,
155                  gfxReal featureSize, ntlVec3Gfx geostart, ntlVec3Gfx geoend );
156                 /*! Prepare points for moving objects (copy into ret) */
157                 void getMovingPoints(vector<ntlVec3Gfx> &ret, vector<ntlVec3Gfx> *norms = NULL);
158                 /*! Calculate max. velocity on object from t1 to t2 */
159                 ntlVec3Gfx calculateMaxVel(double t1, double t2);
160                 /*! get translation at time t*/
161                 ntlVec3Gfx getTranslation(double t);
162                 /*! get active flag time t*/
163                 float getGeoActive(double t);
164
165                 /*! add triangle to scene and init flags */
166                 //  helper function for getTriangles
167                 void sceneAddTriangle(
168                                 ntlVec3Gfx  p1,ntlVec3Gfx  p2,ntlVec3Gfx  p3,
169                                 ntlVec3Gfx pn1,ntlVec3Gfx pn2,ntlVec3Gfx pn3,
170                                 ntlVec3Gfx trin, bool smooth,
171                                 vector<ntlTriangle> *triangles,
172                                 vector<ntlVec3Gfx>  *vertices,
173                                 vector<ntlVec3Gfx>  *vertNormals);
174                 void sceneAddTriangleNoVert(int *trips,
175                                 ntlVec3Gfx trin, bool smooth,
176                                 vector<ntlTriangle> *triangles);
177
178         protected:
179
180                 /* initialized for scene? */
181                 bool mIsInitialized; 
182
183                 /*! Point to a property object describing the surface of this object */
184                 ntlMaterial *mpMaterial;
185
186                 /*! Name of the surcace property */
187                 string mMaterialName;
188
189                 /*! Cast shadows on/off */
190                 int mCastShadows;
191                 /*! REceive shadows on/off */
192                 int mReceiveShadows;
193
194                 /* fluid init data */
195                 /*! fluid object type (fluid, obstacle, accelerator etc.) */
196                 int mGeoInitType;
197                 /*! initial velocity for fluid objects */
198                 ntlVec3Gfx mInitialVelocity;
199                 AnimChannel<ntlVec3Gfx> mcInitialVelocity;
200                 /*! use object local inflow? */
201                 bool mLocalCoordInivel;
202                 /*! perform more accurate intersecting geo init for this object? */
203                 bool mGeoInitIntersect;
204                 /*! part slip bc value */
205                 float mGeoPartSlipValue;
206                 /*! obstacle impact correction factor */
207                 AnimChannel<float> mcGeoImpactFactor;
208                 /*! only init as thin object, dont fill? */
209                 int mVolumeInit;
210
211                 /*! initial offset for rot/scale */
212                 ntlVec3Gfx mInitialPos;
213                 /*! animated channels for postition, rotation and scale */
214                 AnimChannel<ntlVec3Gfx> mcTrans, mcRot, mcScale;
215                 /*! easy check for animation */
216                 bool mIsAnimated;
217                 
218                 /*! moving point/normal storage */
219                 vector<ntlVec3Gfx> mMovPoints;
220                 vector<ntlVec3Gfx> mMovNormals;
221                 /*! cached points for non moving objects/timeslots */
222                 bool mHaveCachedMov;
223                 vector<ntlVec3Gfx> mCachedMovPoints;
224                 vector<ntlVec3Gfx> mCachedMovNormals;
225                 /*! precomputed triangle divisions */
226                 vector<int> mTriangleDivs1,mTriangleDivs2,mTriangleDivs3;
227                 /*! inited? */
228                 float mMovPntsInited;
229                 /*! point with max. distance from center */
230                 int mMaxMovPnt;
231
232                 /*! animated channels for in/outflow on/off */
233                 AnimChannel<float> mcGeoActive;
234                 
235                 /* fluid control settings */
236                 float mCpsTimeStart;
237                 float mCpsTimeEnd;
238                 float mCpsQuality;
239                 AnimChannel<float> mcAttrFStr, mcAttrFRad, mcVelFStr, mcVelFRad;
240
241         public:
242
243 };
244
245 #endif
246