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