summaryrefslogtreecommitdiff
path: root/inc/AIS_AttributeFilter.hxx
blob: 7acdbc86437490744cfd1cfc47f6e0d3667cf68b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _AIS_AttributeFilter_HeaderFile
#define _AIS_AttributeFilter_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_AIS_AttributeFilter_HeaderFile
#include <Handle_AIS_AttributeFilter.hxx>
#endif

#ifndef _Quantity_NameOfColor_HeaderFile
#include <Quantity_NameOfColor.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _SelectMgr_Filter_HeaderFile
#include <SelectMgr_Filter.hxx>
#endif
#ifndef _Handle_SelectMgr_EntityOwner_HeaderFile
#include <Handle_SelectMgr_EntityOwner.hxx>
#endif
class SelectMgr_EntityOwner;


//! Selects Interactive Objects, which have the desired width or color. <br>
//! The filter questions each Interactive Object in local <br>
//! context to determine whether it has an non-null <br>
//! owner, and if so, whether it has the required color <br>
//! and width attributes. If the object returns true in each <br>
//! case, it is kept. If not, it is rejected. <br>
//! This filter is used only in an open local context. <br>
//! In the Collector viewer, you can only locate <br>
//! Interactive Objects, which answer positively to the <br>
//! filters, which are in position when a local context is open. <br>
class AIS_AttributeFilter : public SelectMgr_Filter {

public:

  
//! Constructs an empty attribute filter object. <br>
//! This filter object determines whether selectable <br>
//! interactive objects have a non-null owner. <br>
  Standard_EXPORT   AIS_AttributeFilter();
  
//! Constructs an attribute filter object defined by the <br>
//! color attribute aCol. <br>
  Standard_EXPORT   AIS_AttributeFilter(const Quantity_NameOfColor aCol);
  
//! Constructs an attribute filter object defined by the line <br>
//! width attribute aWidth. <br>
  Standard_EXPORT   AIS_AttributeFilter(const Standard_Real aWidth);
  
//! Indicates that the Interactive Object has the color <br>
//! setting specified by the argument aCol at construction time. <br>
        Standard_Boolean HasColor() const;
  
//! Indicates that the Interactive Object has the width <br>
//! setting specified by the argument aWidth at <br>
//! construction time. <br>
        Standard_Boolean HasWidth() const;
  //! Sets the color aCol. <br>
//! This must be chosen from the list of colors in Quantity_NameOfColor. <br>
        void SetColor(const Quantity_NameOfColor aCol) ;
  //!  Sets the line width aWidth. <br>
        void SetWidth(const Standard_Real aWidth) ;
  
//! Removes the setting for color from the filter. <br>
        void UnsetColor() ;
  
//! Removes the setting for width from the filter. <br>
        void UnsetWidth() ;
  //! Indicates that the selected Interactive Object passes <br>
//! the filter. The owner, anObj, can be either direct or <br>
//! user. A direct owner is the corresponding <br>
//! construction element, whereas a user is the <br>
//! compound shape of which the entity forms a part. <br>
//! If the Interactive Object returns Standard_True <br>
//! when detected by the Local Context selector through <br>
//! the mouse, the object is kept; if not, it is rejected. <br>
  Standard_EXPORT   virtual  Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& anObj) const;




  DEFINE_STANDARD_RTTI(AIS_AttributeFilter)

protected:




private: 


Quantity_NameOfColor myCol;
Standard_Real myWid;
Standard_Boolean hasC;
Standard_Boolean hasW;


};


#include <AIS_AttributeFilter.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif