util_selection_set.hpp

Go to the documentation of this file.

#ifndef _UTIL_SELECTION_SET_HPP_
#define _UTIL_SELECTION_SET_HPP_
#include "def/define.h"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/dtk_maindoc_ptr.hpp"
#include "util/error_dtk.hpp"
#include "util/util_ent_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include <cstdio>
#include <memory>
 
 
class Dtk_SelectionSet; 
typedef Dtk_SmartPtr<Dtk_SelectionSet> Dtk_SelectionSetPtr;
typedef Dtk_tab<Dtk_SelectionSetPtr> Dtk_SelectionSetTab;
 
//! \ingroup SelectionSetClasses
//! \class Dtk_SelectionSet
//! \brief Dtk_SelectionSet represents a Selection Set entity which enables selecting a group of entities in a CAD Model.
//! \SmartPtr{Dtk_SelectionSetPtr}
class Dtk_SelectionSet: public Dtk_Entity
{
protected:
 
     struct Dtk_Handle; // Not defined here
     std::unique_ptr<Dtk_Handle> _Private; // Handle
 
     enum {
          _typeID = DTK_TYPE_SELECTION_SET
     };
 
     //! \brief Default constructor 
     Dtk_SelectionSet();
 
     //! \brief Copy constructor
     //! \param selectionSet the Dtk_SelectionSet to be copied
     Dtk_SelectionSet(const Dtk_SelectionSet& selectionSet);
 
     //! \brief Destructor
     ~Dtk_SelectionSet();
 
     inline virtual Dtk_Object* Clone() { return new Dtk_SelectionSet(*this); }
 
     friend class Dtk_SmartPtr<Dtk_SelectionSet>;
 
public:
     //! \DtkDynamicType
     Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
     { 
          if (inId == _typeID)
          {
               return 1; 
          }
          return Dtk_Object::DtkDynamicType(inId); 
     }
 
     //! \DtkDynamicCast
     static Dtk_SelectionSet* DtkDynamicCast(Dtk_Object * s)
     { 
          if(s->DtkDynamicType(_typeID)) 
               return static_cast<Dtk_SelectionSet*>(s); 
          return NULL; 
     } 
 
     //! \return The type of the entity type - DTK_TYPE_SELECTION_SET - 
     type_detk get_type_detk() const { return DTK_TYPE_SELECTION_SET; }
 
     Dtk_ErrorStatus Transform(const Dtk_transfo& inTransfo); 
 
     //! \CreateBase
     static Dtk_SelectionSetPtr Create();
 
     //! \brief Delete object
     static Dtk_SelectionSetPtr Release(Dtk_SelectionSetPtr inSelectionSet);
 
     //! \brief Dump the Selection Set entities 
     //! \param inFile the output file
     //!
     //! \b Sample
     //! \code
     //! Dtk_string fileName = ...;
     //! File * file = fileName.OpenFile(DTK_W);
     //!
     //! Dtk_SelectionSetPtr selectionSet;
     //! // Read the Selection Set 
     //! selectionSet.Dump(file);
     //! \endcode
     Dtk_ErrorStatus Dump(FILE * inFile);
 
     //! \brief Returns the name of the Selection Set entity
     Dtk_string GetName() const;
 
     //! \brief Sets the name of the Selection Set entity
     //! \param inName name
     void SetName(const Dtk_string& inName);
 
     //! \brief Adds a new Node Connector to the pool of connectors related to the Selection Set object
     Dtk_ErrorStatus AddNodeConnector (const Dtk_NodeConnectorPtr &inNodeConnector);
 
     //! \brief Adds a sub SelectionSet related to the Selection Set object
     Dtk_ErrorStatus AddSelectionSet(const Dtk_SelectionSetPtr &inSelectionSet);
 
     //! \brief Returns the array of connectors specifying the group of entities defined in the Selection Set object
     Dtk_tab <Dtk_NodeConnectorPtr> GetNodeConnectors () const;
 
     //! \brief Returns the array of sub SelectionSet specifying the group of entities defined in the Selection Set object
     Dtk_tab <Dtk_SelectionSetPtr> GetSelectionSet() const;
 
     //! \brief Returns the Number of connectors specifying the group of entities defined in the Selection Set object
     Dtk_Size_t GetNodeConnectorsNb () const;
 
     //! \brief Returns the Number of SelectionSet specifying the group of entities defined in the Selection Set object
     Dtk_Size_t GetSelectionSetsNb() const;
 
     //! \brief Returns the connector of Selection Set defined by its position
     Dtk_NodeConnectorPtr GetNodeConnectorByPos (const Dtk_Size_t& inPos) const;
 
     //! \brief Returns the SelectionSet of Selection Set defined by its position
     Dtk_SelectionSetPtr GetSelectionSetByPos (const Dtk_Size_t& inPos) const;
}; 
 
#endif