HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_GBPointRef.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: Geometry Library (C++)
7  *
8  * COMMENTS: A couple utility functions used by selections.
9  * You'll probably want to use primgroup->combine(ptgroup) instead.
10  */
11 
12 #ifndef __GA_GBPointRef_H__
13 #define __GA_GBPointRef_H__
14 
15 #include "GA_API.h"
16 #include "GA_Types.h"
17 
18 class UT_BitArray;
19 class GA_Detail;
20 class GA_PointGroup;
21 class GA_PrimitiveGroup;
22 
23 /// This function adds all the adjacent primitives of the pt_group to
24 /// prim_group within gdp. If given a restrict_group, then we use it to
25 /// restrict the list of primitives that we consider. The behaviour of this
26 /// group is determined by the restrict_if_contains flag. If this flag is true,
27 /// then only primitives in the restrict_group are considered. If the flag is
28 /// false, then only primitives _not_ in the restrict_group are used.
29 ///
30 /// NOTE: You'll probably want to use primgroup->combine(ptgroup) instead.
31 GA_API extern void GAgetPrimitiveClosure(const GA_Detail &gdp,
32  const GA_PointGroup *pt_group,
33  GA_PrimitiveGroup *prim_group,
34  const GA_PrimitiveGroup *restrict_group = 0,
35  bool restrict_if_contains = true);
36 /// Same version of the above function except pt_group is a bit array with each
37 /// bit representing if the particular point is in the pt_group.
38 ///
39 /// NOTE: You'll probably want to use primgroup->combine(ptgroup) instead.
40 GA_API extern void GAgetPrimitiveClosure(const GA_Detail &gdp,
41  const UT_BitArray &pt_array,
42  GA_PrimitiveGroup *prim_group,
43  const GA_PrimitiveGroup *restrict_group = 0,
44  bool restrict_if_contains = true);
45 
46 #endif
GA_API void GAgetPrimitiveClosure(const GA_Detail &gdp, const GA_PointGroup *pt_group, GA_PrimitiveGroup *prim_group, const GA_PrimitiveGroup *restrict_group=0, bool restrict_if_contains=true)
#define GA_API
Definition: GA_API.h:12
Container class for all geometry.
Definition: GA_Detail.h:95