EIC code displayed by LXR master/​include/​opencascade/​SelectMgr_Selection.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:04:53

 // Created on: 1995-02-16
 // Created by: Mister rmi
 // Copyright (c) 1995-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 _SelectMgr_Selection_HeaderFile
 #define _SelectMgr_Selection_HeaderFile
 
 #include <SelectMgr_SensitiveEntity.hxx>
 #include <SelectMgr_StateOfSelection.hxx>
 #include <SelectMgr_TypeOfBVHUpdate.hxx>
 #include <SelectMgr_TypeOfUpdate.hxx>
 
 class Select3D_SensitiveEntity;
 
 //!  Represents the state of a given selection mode for a
 //! Selectable Object. Contains all the sensitive entities available for this mode.
 //! An interactive object can have an indefinite number of
 //! modes of selection, each representing a
 //! "decomposition" into sensitive primitives; each
 //! primitive has an Owner (SelectMgr_EntityOwner)
 //! which allows us to identify the exact entity which has
 //! been detected. Each Selection mode is identified by
 //! an index. The set of sensitive primitives which
 //! correspond to a given mode is stocked in a
 //! SelectMgr_Selection object. By Convention, the
 //! default selection mode which allows us to grasp the
 //! Interactive object in its entirety will be mode 0.
 //! AIS_Trihedron : 4 selection modes
 //! -   mode 0 : selection of a trihedron
 //! -   mode 1 : selection of the origin of the trihedron
 //! -   mode 2 : selection of the axes
 //! -   mode 3 : selection of the planes XOY, YOZ, XOZ
 //! when you activate one of modes 1 2 3 4 , you pick AIS objects of type:
 //! -   AIS_Point
 //! -   AIS_Axis (and information on the type of axis)
 //! -   AIS_Plane (and information on the type of plane).
 //!   AIS_PlaneTrihedron offers 3 selection modes:
 //! -   mode 0 : selection of the whole trihedron
 //! -   mode 1 : selection of the origin of the trihedron
 //! -   mode 2 : selection of the axes - same remarks as for the Trihedron.
 //! AIS_Shape : 7 maximum selection modes, depending
 //! on the complexity of the shape :
 //! -   mode 0 : selection of the AIS_Shape
 //! -   mode 1 : selection of the vertices
 //! -   mode 2 : selection of the edges
 //! -   mode 3 : selection of the wires
 //! -   mode 4 : selection of the faces
 //! -   mode 5 : selection of the shells
 //! -   mode 6 :   selection of the constituent solids.
 class SelectMgr_Selection : public Standard_Transient
 {
   DEFINE_STANDARD_RTTIEXT(SelectMgr_Selection, Standard_Transient)
 public:
 
   //! Constructs a selection object defined by the selection mode IdMode.
   //! The default setting 0 is the selection mode for a shape in its entirety.
   Standard_EXPORT SelectMgr_Selection (const Standard_Integer theModeIdx = 0);
 
   Standard_EXPORT ~SelectMgr_Selection();
 
   Standard_EXPORT void Destroy();
 
   //! Adds the sensitive primitive to the list of stored entities in this object.
   //! Raises NullObject if the primitive is a null handle.
   Standard_EXPORT void Add (const Handle(Select3D_SensitiveEntity)& theSensitive);
 
   //! empties the selection from all the stored entities
   Standard_EXPORT void Clear();
 
   //! returns true if no sensitive entity is stored.
   Standard_Boolean IsEmpty() const { return myEntities.IsEmpty(); }
 
   //! returns the selection mode represented by this selection
   Standard_Integer Mode() const { return myMode; }
 
   //! Return entities.
   const NCollection_Vector<Handle(SelectMgr_SensitiveEntity)>& Entities() const { return myEntities; }
 
   //! Return entities.
   NCollection_Vector<Handle(SelectMgr_SensitiveEntity)>& ChangeEntities() { return myEntities; }
 
   //! Returns the flag UpdateFlag.
   //! This flage gives the update status of this framework
   //! in a ViewerSelector object:
   //! -   full
   //! -   partial, or
   //! -   none.
   SelectMgr_TypeOfUpdate UpdateStatus() const { return myUpdateStatus; }
 
   void UpdateStatus (const SelectMgr_TypeOfUpdate theStatus) { myUpdateStatus = theStatus; }
 
   void UpdateBVHStatus (const SelectMgr_TypeOfBVHUpdate theStatus) { myBVHUpdateStatus = theStatus; }
 
   SelectMgr_TypeOfBVHUpdate BVHUpdateStatus() const { return myBVHUpdateStatus; }
 
   //! Returns status of selection
   SelectMgr_StateOfSelection GetSelectionState() const { return mySelectionState; }
 
   //! Sets status of selection
   void SetSelectionState (const SelectMgr_StateOfSelection theState) const { mySelectionState = theState; }
 
   //! Returns sensitivity of the selection
   Standard_Integer Sensitivity() const { return mySensFactor; }
 
   //! Changes sensitivity of the selection and all its entities to the given value.
   //! IMPORTANT: This method does not update any outer selection structures, so for
   //! proper updates use SelectMgr_SelectionManager::SetSelectionSensitivity method.
   Standard_EXPORT void SetSensitivity (const Standard_Integer theNewSens);
 
   //! Dumps the content of me into the stream
   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
 
 private:
 
   NCollection_Vector<Handle(SelectMgr_SensitiveEntity)> myEntities;
   Standard_Integer                                      myMode;
   SelectMgr_TypeOfUpdate                                myUpdateStatus;
   mutable SelectMgr_StateOfSelection                    mySelectionState;
   mutable SelectMgr_TypeOfBVHUpdate                     myBVHUpdateStatus;
   Standard_Integer                                      mySensFactor;
   Standard_Boolean                                      myIsCustomSens;
 };
 
 DEFINE_STANDARD_HANDLE(SelectMgr_Selection, Standard_Transient)
 
 #endif

This page was automatically generated by the 2.3.7 LXR engine. The LXR team