HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_IndexFieldVisualization.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_IndexFieldVisualization.h ( SIM Library, C++)
7  *
8  * COMMENTS:
9  * This simple procedure allows for intersection with signed
10  * distance functions.
11  */
12 
13 #ifndef __SIM_IndexFieldVisualization_H__
14 #define __SIM_IndexFieldVisualization_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_IndexField;
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  GET_GUIDE_FUNC_I("guideindex", GuideIndex, 0);
36  GET_GUIDE_FUNC_B("guideinvert", GuideInvert, false);
37  GET_GUIDE_FUNC_B("usebox", UseBox, false);
38  GET_GUIDE_FUNC_B("useboxhash", UseBoxHash, false);
39 
40  GET_GUIDE_FUNC_B("guideuseplane", GuideUsePlane, false);
41  GET_GUIDE_FUNC_I("guideplane", GuidePlane, 0);
42  GET_GUIDE_FUNC_I("guidevismode", GuideVisMode, 0);
43  GET_GUIDE_FUNC_V2("guiderange", GuideRange, (0, 1));
44  GET_GUIDE_FUNC_F("guideplaneval", GuidePlaneVal, 0);
45 
46 protected:
47  explicit SIM_IndexFieldVisualization(const SIM_DataFactory *factory);
48  virtual ~SIM_IndexFieldVisualization();
49 
50  /// Overrides to properly implement this class as a SIM_Data.
51  virtual void initializeSubclass();
52 
53  virtual bool getIsAlternateRepresentationSubclass() const;
54  virtual void initAlternateRepresentationSubclass(const SIM_Data &);
55  virtual SIM_Guide *createGuideObjectSubclass() const;
56  virtual void buildGuideGeometrySubclass(const SIM_RootData &root,
57  const SIM_Options &options,
58  const GU_DetailHandle &gdh,
59  UT_DMatrix4 *xform,
60  const SIM_Time &t) const;
61 
62 private:
63  static const SIM_DopDescription *getIndexFieldVisualizationDopDescription();
64 
65  const SIM_IndexField *myIndexField;
66 
68 
70  SIM_Data,
71  "IndexFieldVisualization",
72  getIndexFieldVisualizationDopDescription());
73 };
74 
75 #endif
#define SIM_NAME_SHOWGUIDE
Definition: SIM_Names.h:185
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
This class holds a signed distance function representing a GU_Detail.
#define GET_GUIDE_FUNC_I(DataName, FuncName, Default)
virtual bool getIsAlternateRepresentationSubclass() const
This class holds a three dimensional scalar field.
#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)
#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()