// 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 _Select3D_SensitiveGroup_HeaderFile
#define _Select3D_SensitiveGroup_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_Select3D_SensitiveGroup.hxx>

#include <Select3D_ListOfSensitive.hxx>
#include <Standard_Boolean.hxx>
#include <Select3D_SensitiveEntity.hxx>
#include <Handle_SelectBasics_EntityOwner.hxx>
#include <Handle_Select3D_SensitiveEntity.hxx>
#include <Handle_Select3D_Projector.hxx>
#include <Standard_Integer.hxx>
#include <SelectBasics_PickArgs.hxx>
#include <Standard_Real.hxx>
class SelectBasics_EntityOwner;
class Select3D_ListOfSensitive;
class Select3D_SensitiveEntity;
class Select3D_Projector;
class SelectBasics_ListOfBox2d;
class TopLoc_Location;
class TColgp_Array1OfPnt2d;
class Bnd_Box2d;


//! A framework to define selection of a sensitive group
//! by a sensitive entity which is a set of 3D sensitive entities.
//! Remark: 2 modes are possible for rectangle selection
//! the group is considered selected
//! 1) when all the entities inside are selected in the rectangle
//! 2) only one entity inside is selected by the rectangle
//! By default the "Match All entities" mode is set.
class Select3D_SensitiveGroup : public Select3D_SensitiveEntity
{

public:

  
  //! Constructs an empty sensitive group object.
  //! This is a set of sensitive 3D entities. The sensitive
  //! entities will be defined using the function Add to fill
  //! the entity owner OwnerId. If MatchAll is false, nothing can be added.
  Standard_EXPORT Select3D_SensitiveGroup(const Handle(SelectBasics_EntityOwner)& OwnerId, const Standard_Boolean MatchAll = Standard_True);
  
  //! Constructs a sensitive group object defined by the list
  //! TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.
  Standard_EXPORT Select3D_SensitiveGroup(const Handle(SelectBasics_EntityOwner)& OwnerId, Select3D_ListOfSensitive& TheList, const Standard_Boolean MatchAll = Standard_True);
  
  //! Adds the list of sensitive entities LL to the empty
  //! sensitive group object created at construction time.
  Standard_EXPORT   void Add (Select3D_ListOfSensitive& LL) ;
  
  //! Adds the sensitive entity aSensitive to the non-empty
  //! sensitive group object created at construction time.
  Standard_EXPORT   void Add (const Handle(Select3D_SensitiveEntity)& aSensitive) ;
  
  Standard_EXPORT   void Remove (const Handle(Select3D_SensitiveEntity)& aSensitive) ;
  
  //! Removes all sensitive entities from the list used at the
  //! time of construction, or added using the function Add.
  Standard_EXPORT   void Clear() ;
  
  //! Returns true if the sensitive entity aSensitive is in
  //! the list used at the time of construction, or added using the function Add.
  Standard_EXPORT   Standard_Boolean IsIn (const Handle(Select3D_SensitiveEntity)& aSensitive)  const;
  
  //! Sets the requirement that all sensitive entities in the
  //! list used at the time of construction, or added using
  //! the function Add must be matched.
      void Set (const Standard_Boolean MustMatchAllEntities) ;
  
  //! Returns true if all sensitive entities in the list used
  //! at the time of construction, or added using the function Add must be matched.
      Standard_Boolean MustMatchAll()  const;
  
  //! projection of the sensitive primitive in order to
  //! get 2D boxes for the Sort Algorithm
  Standard_EXPORT   void Project (const Handle(Select3D_Projector)& aProjector) ;
  
  //! gives the 2D boxes which represent the segment in the
  //! selection process...
  Standard_EXPORT   void Areas (SelectBasics_ListOfBox2d& boxes) ;
  
  Standard_EXPORT   Standard_Integer MaxBoxes()  const;
  
  Standard_EXPORT   Handle(Select3D_SensitiveEntity) GetConnected (const TopLoc_Location& aLocation) ;
  
  //! propagation of location on all the sensitive inside...
  Standard_EXPORT   void SetLocation (const TopLoc_Location& aLoc) ;
  
  //! propagation of location on all the sensitive inside...
  Standard_EXPORT   void ResetLocation() ;
  
  //! Checks whether the sensitive entity matches the picking
  //! detection area (close to the picking line).
  //! For details please refer to base class declaration.
  Standard_EXPORT   Standard_Boolean Matches (const SelectBasics_PickArgs& thePickArgs, Standard_Real& theMatchDMin, Standard_Real& theMatchDepth) ;
  
  Standard_EXPORT   Standard_Boolean Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol) ;
  
  Standard_EXPORT virtual   Standard_Boolean Matches (const TColgp_Array1OfPnt2d& Polyline, const Bnd_Box2d& aBox, const Standard_Real aTol) ;
  
  //! Sets the owner for all entities in group
  Standard_EXPORT   void Set (const Handle(SelectBasics_EntityOwner)& TheOwnerId) ;
  
  //! Gets group content
     const  Select3D_ListOfSensitive& GetEntities()  const;




  DEFINE_STANDARD_RTTI(Select3D_SensitiveGroup)

protected:




private: 


  Select3D_ListOfSensitive myList;
  Standard_Boolean myMustMatchAll;


};


#include <Select3D_SensitiveGroup.lxx>





#endif // _Select3D_SensitiveGroup_HeaderFile
