HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_PointNeighbourList.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_PointNeighbourList.h ( SIM Library, C++)
7  *
8  * COMMENTS:
9  * This class builds a GU_NeighbourList of the given Geometry
10  * as an alternative representation, allowing one to cache
11  * this useful structure.
12  */
13 
14 #ifndef __SIM_PointNeighbourList_H__
15 #define __SIM_PointNeighbourList_H__
16 
17 #include "SIM_API.h"
18 
19 #include "SIM_Data.h"
20 #include "SIM_DataUtils.h"
21 
22 #include "SIM_Utils.h"
23 
24 class GU_NeighbourList;
25 
26 /// This class holds a GU_NeighbourList which people can query.
27 /// The pointtree refers to the point numbers of the SIM_Geometry
28 /// this is an alternative represenation of.
30 {
31 public:
32  /// Get the list.
33  GU_NeighbourList *getList() const;
34 
35  /// Forces a rebuild of the neighbour list, used when the
36  /// point positions have changed.
37  void forceRebuild(const GU_Detail *gdp);
38 
39 protected:
40  explicit SIM_PointNeighbourList(const SIM_DataFactory *factory);
41  ~SIM_PointNeighbourList() override;
42 
43  /// Overrides to properly implement this class as a SIM_Data.
44  /// This object is meant to be updated from the object's geometry at
45  /// each frame, so we only implement skeleton save, and load methods.
46  void initializeSubclass() override;
47  int64 getMemorySizeSubclass() const override;
48  bool getIsAlternateRepresentationSubclass() const override;
50  const SIM_Data &) override;
51 
52 private:
53  GU_NeighbourList *myList;
54 
56 
58  SIM_Data,
59  "Point Neighbour List",
61 };
62 
63 #endif
#define DECLARE_STANDARD_GETCASTTOTYPE()
Definition: SIM_DataUtils.h:45
virtual bool getIsAlternateRepresentationSubclass() const
virtual int64 getMemorySizeSubclass() const
#define DECLARE_DATAFACTORY(DataClass, SuperClass, Description, DopParms)
Definition: SIM_DataUtils.h:58
long long int64
Definition: SYS_Types.h:116
#define SIM_API
Definition: SIM_API.h:10
virtual void initAlternateRepresentationSubclass(const SIM_Data &)
static const SIM_DopDescription * getEmptyDopDescription()
A DOP description that says not to create an automatic DOP.
virtual void initializeSubclass()