OCCT

// Created on: 1995-02-13
// 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_SelectionManager_HeaderFile
#define _SelectMgr_SelectionManager_HeaderFile

#include <SelectMgr_ViewerSelector.hxx>
#include <SelectMgr_TypeOfUpdate.hxx>

class SelectMgr_SelectableObject;

//! A framework to manage selection from the point of view of viewer selectors.
//! These can be added and removed, and selection modes can be activated and deactivated.
//! In addition, objects may be known to all selectors or only to some.
class SelectMgr_SelectionManager : public Standard_Transient
{
  DEFINE_STANDARD_RTTIEXT(SelectMgr_SelectionManager, Standard_Transient)
public:
  //! Constructs an empty selection manager object.
  Standard_EXPORT SelectMgr_SelectionManager(
    const occ::handle<SelectMgr_ViewerSelector>& theSelector);

  //! Return the Selector.
  const occ::handle<SelectMgr_ViewerSelector>& Selector() const { return mySelector; }

  //! Returns true if the manager contains the selectable object theObject.
  Standard_EXPORT bool Contains(const occ::handle<SelectMgr_SelectableObject>& theObject) const;

  //! Loads and computes selection mode theMode (if it is not equal to -1) in global context and
  //! adds selectable object to BVH tree. If the object theObject has an already calculated
  //! selection with mode theMode and it was removed, the selection will be recalculated.
  Standard_EXPORT void Load(const occ::handle<SelectMgr_SelectableObject>& theObject,
                            const int                                      theMode = -1);

  //! Removes selectable object theObject from all viewer selectors it was added to previously,
  //! removes it from all contexts and clears all computed selections of theObject.
  Standard_EXPORT void Remove(const occ::handle<SelectMgr_SelectableObject>& theObject);

  //! Activates the selection mode theMode in the selector theSelector for the selectable object
  //! anObject. By default, theMode is equal to 0. If theSelector is set to default (NULL), the
  //! selection with the mode theMode will be activated in all the viewers available.
  Standard_EXPORT void Activate(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                const int                                      theMode = 0);

  //! Deactivates mode theMode of theObject in theSelector. If theMode value is set to default (-1),
  //! all active selection modes will be deactivated. Likewise, if theSelector value is set to
  //! default (NULL), theMode will be deactivated in all viewer selectors.
  Standard_EXPORT void Deactivate(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                  const int                                      theMode = -1);

  //! Returns true if the selection with theMode is active for the selectable object theObject and
  //! selector theSelector. If all parameters are set to default values, it returns it there is any
  //! active selection in any known viewer selector for object theObject.
  Standard_EXPORT bool IsActivated(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                   const int theMode = -1) const;

  //! Removes sensitive entities from all viewer selectors
  //! after method Clear() was called to the selection they belonged to
  //! or it was recomputed somehow.
  Standard_EXPORT void ClearSelectionStructures(
    const occ::handle<SelectMgr_SelectableObject>& theObj,
    const int                                      theMode = -1);

  //! Re-adds newly calculated sensitive entities of recomputed selection
  //! defined by mode theMode to all viewer selectors contained that selection.
  Standard_EXPORT void RestoreSelectionStructures(
    const occ::handle<SelectMgr_SelectableObject>& theObj,
    const int                                      theMode = -1);

  //! Recomputes activated selections of theObject for all known viewer selectors according to
  //! theMode specified. If theMode is set to default (-1), then all activated selections will be
  //! recomputed. If theIsForce is set to true, then selection mode theMode for object theObject
  //! will be recomputed regardless of its activation status.
  Standard_EXPORT void RecomputeSelection(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                          const bool theIsForce = false,
                                          const int  theMode    = -1);

  //! Updates all selections of theObject in all viewer selectors according to its current update
  //! status. If theIsForce is set to true, the call is equal to recomputation.
  Standard_EXPORT void Update(const occ::handle<SelectMgr_SelectableObject>& theObject,
                              const bool                                     theIsForce = true);

  //! Sets type of update of all selections of theObject to the given theType.
  Standard_EXPORT void SetUpdateMode(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                     const SelectMgr_TypeOfUpdate                   theType);

  //! Sets type of update of selection with theMode of theObject to the given theType.
  Standard_EXPORT void SetUpdateMode(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                     const int                                      theMode,
                                     const SelectMgr_TypeOfUpdate                   theType);

  //! Allows to manage sensitivity of a particular selection of interactive object theObject and
  //! changes previous sensitivity value of all sensitive entities in selection with theMode
  //! to the given theNewSensitivity.
  Standard_EXPORT void SetSelectionSensitivity(
    const occ::handle<SelectMgr_SelectableObject>& theObject,
    const int                                      theMode,
    const int                                      theNewSens);

  //! Re-adds selectable object in BVHs in all viewer selectors.
  Standard_EXPORT void UpdateSelection(const occ::handle<SelectMgr_SelectableObject>& theObj);

protected:
  //! Recomputes given selection mode and updates BVHs in all viewer selectors
  Standard_EXPORT void recomputeSelectionMode(
    const occ::handle<SelectMgr_SelectableObject>& theObject,
    const occ::handle<SelectMgr_Selection>&        theSelection,
    const int                                      theMode);

private:
  //! Loads and creates selection structures for object theObject with mode theMode in specified
  //! viewer selector theSelector. If theSelector is set to default value (NULL), the selection mode
  //! created will be added to all known viewer selectors.
  Standard_EXPORT void loadMode(const occ::handle<SelectMgr_SelectableObject>& theObject,
                                const int                                      theMode);

  //! In multi-thread mode queues sensitive entities to build its BVH in separate threads.
  //! Otherwise, builds BVH for heavyweight entities immediately.
  Standard_EXPORT void buildBVH(const occ::handle<SelectMgr_Selection>& theSelection);

private:
  occ::handle<SelectMgr_ViewerSelector>                    mySelector;
  NCollection_Map<occ::handle<SelectMgr_SelectableObject>> myGlobal;
};

#endif // _SelectMgr_SelectionManager_HeaderFile