HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_MatrixFieldVisualization.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  * NAME: SIM_MatrixFieldVisualization.h ( SIM Library, C++)
7  *
8  * COMMENTS:
9  * This simple procedure allows for intersection with signed
10  * distance functions.
11  */
12 
13 #ifndef __SIM_MatrixFieldVisualization_H__
14 #define __SIM_MatrixFieldVisualization_H__
15 
16 #include "SIM_API.h"
17 #include <UT/UT_Vector2.h>
18 #include <UT/UT_Vector3.h>
19 
20 #include "SIM_Names.h"
21 #include "SIM_OptionsUser.h"
22 #include "SIM_DataUtils.h"
23 
24 class UT_IStream;
25 class SIM_Geometry;
26 class SIM_MatrixField;
27 
28 /// This class holds a signed distance function representing a GU_Detail.
30  public SIM_OptionsUser
31 {
32 public:
33  GET_GUIDE_FUNC_B(SIM_NAME_SHOWGUIDE, ShowGuide, true);
35 
36  GET_GUIDE_FUNC_F("guideiso", GuideIso, 0.0);
37  GET_GUIDE_FUNC_B("guideinvert", GuideInvert, false);
38  GET_GUIDE_FUNC_B("guideusebox", GuideUseBox, false);
39  GET_GUIDE_FUNC_B("guideuseboxhash", GuideUseBoxHash, false);
40  GET_GUIDE_FUNC_B("guideusesmoke", GuideUseSmoke, false);
41 
42  GET_GUIDE_FUNC_B("guideuseplane", GuideUsePlane, false);
43  GET_GUIDE_FUNC_I("guideplane", GuidePlane, 0);
44  GET_GUIDE_FUNC_I("guidevismode", GuideVisMode, 0);
45  GET_GUIDE_FUNC_V2("guiderange", GuideRange, (0, 1));
46  GET_GUIDE_FUNC_F("guideplaneval", GuidePlaneVal, 0);
47 
48 protected:
49  explicit SIM_MatrixFieldVisualization(const SIM_DataFactory *factory);
51 
52  /// Overrides to properly implement this class as a SIM_Data.
53  virtual void initializeSubclass();
54 
55  virtual bool getIsAlternateRepresentationSubclass() const;
56  virtual void initAlternateRepresentationSubclass(const SIM_Data &);
57  virtual SIM_Guide *createGuideObjectSubclass() const;
58  virtual void buildGuideGeometrySubclass(const SIM_RootData &root,
59  const SIM_Options &options,
60  const GU_DetailHandle &gdh,
61  UT_DMatrix4 *xform,
62  const SIM_Time &t) const;
63 
64 private:
65  static const SIM_DopDescription *getMatrixFieldVisualizationDopDescription();
66 
67  const SIM_MatrixField *myMatrixField;
68 
70 
72  SIM_Data,
73  "MatrixFieldVisualization",
74  getMatrixFieldVisualizationDopDescription());
75 };
76 
77 #endif
#define SIM_NAME_SHOWGUIDE
Definition: SIM_Names.h:185
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
#define GET_GUIDE_FUNC_I(DataName, FuncName, Default)
virtual bool getIsAlternateRepresentationSubclass() const
#define GET_GUIDE_FUNC_V3(DataName, FuncName, Default)
#define GET_GUIDE_FUNC_F(DataName, FuncName, Default)
virtual void buildGuideGeometrySubclass(const SIM_RootData &root, const SIM_Options &options, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const
#define DECLARE_DATAFACTORY(DataClass, SuperClass, Description, DopParms)
Definition: SIM_DataUtils.h:58
#define GET_GUIDE_FUNC_V2(DataName, FuncName, Default)
This class holds a three dimensional tensor field.
This class holds a signed distance function representing a GU_Detail.
#define SIM_API
Definition: SIM_API.h:10
virtual void initAlternateRepresentationSubclass(const SIM_Data &)
#define SIM_NAME_COLOR
Definition: SIM_Names.h:87
#define GET_GUIDE_FUNC_B(DataName, FuncName, Default)
virtual SIM_Guide * createGuideObjectSubclass() const
virtual void initializeSubclass()