0024002: Overall code and build procedure refactoring -- automatic

[occt.git] / src / AIS / AIS_SignatureFilter.hxx

diff --git a/src/AIS/AIS_SignatureFilter.hxx b/src/AIS/AIS_SignatureFilter.hxx
new file mode 100644 (file)
index 0000000..d77b171
--- /dev/null
+++ b/src/AIS/AIS_SignatureFilter.hxx
@@ -0,0 +1,100 @@
+// Created on: 1997-03-04
+// Created by: Robert COUBLANC
+// Copyright (c) 1997-1999 Matra Datavision
+// Copyright (c) 1999-2014 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _AIS_SignatureFilter_HeaderFile
+#define _AIS_SignatureFilter_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_Type.hxx>
+
+#include <Standard_Integer.hxx>
+#include <AIS_TypeFilter.hxx>
+#include <AIS_KindOfInteractive.hxx>
+#include <Standard_Boolean.hxx>
+class SelectMgr_EntityOwner;
+
+
+class AIS_SignatureFilter;
+DEFINE_STANDARD_HANDLE(AIS_SignatureFilter, AIS_TypeFilter)
+
+//! Selects Interactive Objects through their signatures
+//! and types. The signature provides an
+//! additional   characterization of an object's type, and
+//! takes the form of an index. The filter questions each
+//! Interactive Object in local context to determine
+//! whether it has an non-null owner, and if so, whether
+//! it has the desired signature. If the object returns true
+//! in each case, it is kept. If not, it is rejected.
+//! By default, the   interactive object has a None   type
+//! and a signature of 0. If you want to give a particular
+//! type and signature to your Interactive Object, you
+//! must redefine two virtual methods:   Type and Signature.
+//! This filter is only used in an open local contexts.
+//! In the Collector viewer, you can only locate
+//! Interactive Objects which answer positively to the
+//! positioned filters when a local context is open.
+//! Warning
+//! Some signatures have already been used by standard
+//! objects delivered in AIS. These include:
+//! -   signature 0 - Shape
+//! -   signature 1 - Point
+//! -   signature 2 - Axis
+//! -   signature 3 - Trihedron
+//! -   signature 4 - PlaneTrihedron
+//! -   signature 5 - Line
+//! -   signature 6 - Circle
+//! -   signature 7 - Plane
+class AIS_SignatureFilter : public AIS_TypeFilter
+{
+
+public:
+
+  
+  //! Initializes the signature filter, adding the signature
+  //! specification, aGivenSignature, to that for type,
+  //! aGivenKind, in AIS_TypeFilter.
+  Standard_EXPORT AIS_SignatureFilter(const AIS_KindOfInteractive aGivenKind, const Standard_Integer aGivenSignature);
+  
+  //! Returns False if the transient is not an AIS_InteractiveObject.
+  //! Returns False if the signature of InteractiveObject
+  //! is not the same as the stored one in the filter...
+  Standard_EXPORT Standard_Boolean IsOk (const Handle(SelectMgr_EntityOwner)& anobj) const Standard_OVERRIDE;
+
+
+
+
+  DEFINE_STANDARD_RTTI(AIS_SignatureFilter,AIS_TypeFilter)
+
+protected:
+
+
+
+
+private:
+
+
+  Standard_Integer mySig;
+
+
+};
+
+
+
+
+
+
+
+#endif // _AIS_SignatureFilter_HeaderFile