#############
HSelectionSet
#############

.. cpp:namespace:: HSelectionSet

.. default-domain:: cpp

Functions
=========

================================================= ================================================================================================================================================================================================================================================
..                                                :cpp:func:`HSelectionSet <HSelectionSet::HSelectionSet>`                                                                                                                                                                                        
..                                                :cpp:func:`~HSelectionSet <virtual HSelectionSet::~HSelectionSet>`                                                                                                                                                                              
void                                              :cpp:func:`Init <virtual void HSelectionSet::Init()>`                                                                                                                                                                                           
void                                              :cpp:func:`Select <virtual void HSelectionSet::Select(HC_KEY key, int num_include_keys, HC_KEY include_keys[], bool emit_message=false)>`                                                                                                       
void                                              :cpp:func:`Select <virtual void HSelectionSet::Select(HSelectionItem *new_sel, bool emit_message=false)>`                                                                                                                                       
void                                              :cpp:func:`SelectRegion <virtual void HSelectionSet::SelectRegion(HShellObject const &oShell, int num_include_keys, HC_KEY include_keys[], int region, bool emit_message)>`                                                                     
void                                              :cpp:func:`SelectSubentity <virtual void HSelectionSet::SelectSubentity(HC_KEY key, int num_include_keys, HC_KEY include_keys[], int count, int const faces[]=0, int const vertex1[]=0, int const vertex2[]=0, bool emit_message=false)>`       
void                                              :cpp:func:`Select <virtual void HSelectionSet::Select(HC_KEY key, char const *segpath, HC_KEY include_key, HC_KEY includer_key, bool emit_message=false)>`                                                                                      
void                                              :cpp:func:`DeSelect <virtual void HSelectionSet::DeSelect(HC_KEY key, bool emit_message=false)>`                                                                                                                                                
void                                              :cpp:func:`DeSelect <virtual void HSelectionSet::DeSelect(HC_KEY key, int num_include_keys, HC_KEY include_keys[], bool emit_message=false)>`                                                                                                   
void                                              :cpp:func:`DeSelect <virtual void HSelectionSet::DeSelect(HSelectionItem *remove_sel, bool emit_message=false)>`                                                                                                                                
void                                              :cpp:func:`DeSelectRegion <virtual void HSelectionSet::DeSelectRegion(HShellObject const &oShell, int region, bool emit_messag)>`                                                                                                               
void                                              :cpp:func:`DeSelectRegion <virtual void HSelectionSet::DeSelectRegion(HShellObject const &oShell, int num_include_keys, HC_KEY include_keys[], int region, bool emit_message=false)>`                                                           
void                                              :cpp:func:`DeSelectSubentity <virtual void HSelectionSet::DeSelectSubentity(HC_KEY key, int num_include_keys, HC_KEY include_keys[], int count, int const faces[], int const vertex1[], int const vertex2[], bool emit_message=false)>`         
bool                                              :cpp:func:`SelectSubentityOOC <virtual bool HSelectionSet::SelectSubentityOOC(HC_KEY key, int num_include_keys, HC_KEY include_keys[], int count, int const faces[]=0, int const vertex1[]=0, int const vertex2[]=0, bool emit_message=false)>` 
bool                                              :cpp:func:`DeSelectOOC <virtual bool HSelectionSet::DeSelectOOC(HC_KEY key, int num_include_keys, HC_KEY include_keys[], bool emit_message=false)>`                                                                                             
bool                                              :cpp:func:`HighlightRegionEdges <virtual bool HSelectionSet::HighlightRegionEdges()>`                                                                                                                                                           
void                                              :cpp:func:`HighlightRegionEdges <virtual void HSelectionSet::HighlightRegionEdges(bool yesno)>`                                                                                                                                                 
bool                                              :cpp:func:`HighlightAnnotations <virtual bool HSelectionSet::HighlightAnnotations()>`                                                                                                                                                           
void                                              :cpp:func:`HighlightAnnotations <virtual void HSelectionSet::HighlightAnnotations(bool yesno)>`                                                                                                                                                 
HRegionEdgeHighlightMode                          :cpp:func:`HighlightRegionEdgesAutoVisibility <virtual HRegionEdgeHighlightMode HSelectionSet::HighlightRegionEdgesAutoVisibility()>`                                                                                                           
void                                              :cpp:func:`HighlightRegionEdgesAutoVisibility <virtual void HSelectionSet::HighlightRegionEdgesAutoVisibility(bool yesno)>`                                                                                                                     
void                                              :cpp:func:`HighlightRegionEdgesAutoVisibility <virtual void HSelectionSet::HighlightRegionEdgesAutoVisibility(HRegionEdgeHighlightMode edge_state)>`                                                                                            
void                                              :cpp:func:`HighlightRegionFacesAutoVisibility <virtual void HSelectionSet::HighlightRegionFacesAutoVisibility(HRegionFaceHighlightMode face_state)>`                                                                                            
HRegionFaceHighlightMode                          :cpp:func:`HighlightRegionFacesAutoVisibility <virtual HRegionFaceHighlightMode HSelectionSet::HighlightRegionFacesAutoVisibility()>`                                                                                                           
void                                              :cpp:func:`DeSelectAll <virtual void HSelectionSet::DeSelectAll()>`                                                                                                                                                                             
bool                                              :cpp:func:`IsSelected <virtual bool HSelectionSet::IsSelected(HC_KEY key) const>`                                                                                                                                                               
bool                                              :cpp:func:`IsSelected <virtual bool HSelectionSet::IsSelected(HC_KEY key, int num_include_keys, const HC_KEY include_keys[]) const>`                                                                                                            
bool                                              :cpp:func:`IsSelected <virtual bool HSelectionSet::IsSelected(HSelectionItem const *item) const>`                                                                                                                                               
bool                                              :cpp:func:`IsRegionSelected <virtual bool HSelectionSet::IsRegionSelected(HC_KEY key, int num_include_keys, const HC_KEY include_keys[], int region) const>`                                                                                    
bool                                              :cpp:func:`IsHighlightSegment <virtual bool HSelectionSet::IsHighlightSegment(HC_KEY segment_key) const>`                                                                                                                                       
void                                              :cpp:func:`SetSelectionFaceColor <virtual void HSelectionSet::SetSelectionFaceColor(HPixelRGBA &rgba)>`                                                                                                                                         
void                                              :cpp:func:`SetGrayScale <virtual void HSelectionSet::SetGrayScale(bool grayScale)>`                                                                                                                                                             
void                                              :cpp:func:`SetInvisible <virtual void HSelectionSet::SetInvisible(bool Invisible)>`                                                                                                                                                             
bool                                              :cpp:func:`GetInvisible <virtual bool HSelectionSet::GetInvisible()>`                                                                                                                                                                           
void                                              :cpp:func:`SetAllowDisplacement <virtual void HSelectionSet::SetAllowDisplacement(bool allowDisplacement)>`                                                                                                                                     
bool                                              :cpp:func:`GetAllowDisplacement <virtual bool HSelectionSet::GetAllowDisplacement()>`                                                                                                                                                           
HSelList *                                        :cpp:func:`GetSelectionList <virtual HSelList * HSelectionSet::GetSelectionList()>`                                                                                                                                                             
void                                              :cpp:func:`GetSelectionFaceColor <virtual void HSelectionSet::GetSelectionFaceColor(HPixelRGBA &rgba)>`                                                                                                                                         
void                                              :cpp:func:`SetSelectionEdgeColor <virtual void HSelectionSet::SetSelectionEdgeColor(HPixelRGBA &rgb)>`                                                                                                                                          
void                                              :cpp:func:`GetSelectionEdgeColor <virtual void HSelectionSet::GetSelectionEdgeColor(HPixelRGBA &rgba)>`                                                                                                                                         
void                                              :cpp:func:`SetSelectionCutEdgeColor <virtual void HSelectionSet::SetSelectionCutEdgeColor(HPixelRGBA &rgb)>`                                                                                                                                    
void                                              :cpp:func:`GetSelectionCutEdgeColor <virtual void HSelectionSet::GetSelectionCutEdgeColor(HPixelRGBA &rgba)>`                                                                                                                                   
void                                              :cpp:func:`SetSelectionCutFaceColor <virtual void HSelectionSet::SetSelectionCutFaceColor(HPixelRGBA &rgb)>`                                                                                                                                    
void                                              :cpp:func:`GetSelectionCutFaceColor <virtual void HSelectionSet::GetSelectionCutFaceColor(HPixelRGBA &rgba)>`                                                                                                                                   
void                                              :cpp:func:`SetSelectionMarkerColor <virtual void HSelectionSet::SetSelectionMarkerColor(HPixelRGBA &rgb)>`                                                                                                                                      
void                                              :cpp:func:`GetSelectionMarkerColor <virtual void HSelectionSet::GetSelectionMarkerColor(HPixelRGBA &rgba)>`                                                                                                                                     
void                                              :cpp:func:`SetSelectionEdgeWeight <virtual void HSelectionSet::SetSelectionEdgeWeight(float weight)>`                                                                                                                                           
float                                             :cpp:func:`GetSelectionEdgeWeight <virtual float HSelectionSet::GetSelectionEdgeWeight()>`                                                                                                                                                      
void                                              :cpp:func:`SetSelectionMarkerSize <virtual void HSelectionSet::SetSelectionMarkerSize(float size)>`                                                                                                                                             
float                                             :cpp:func:`GetSelectionMarkerSize <virtual float HSelectionSet::GetSelectionMarkerSize()>`                                                                                                                                                      
HC_KEY                                            :cpp:func:`GetAt <virtual HC_KEY HSelectionSet::GetAt(unsigned int index)>`                                                                                                                                                                     
bool                                              :cpp:func:`GetAll <virtual bool HSelectionSet::GetAll(HC_KEY out_array[])>`                                                                                                                                                                     
:doc:`classHSelectionItem` const *                :cpp:func:`GetSelectionItemAt <HSelectionItem const  * HSelectionSet::GetSelectionItemAt(unsigned int index)>`                                                                                                                                  
:doc:`classHSelectionItem` const *                :cpp:func:`GetSelectionItem <HSelectionItem const  * HSelectionSet::GetSelectionItem(HC_KEY key)>`                                                                                                                                              
unsigned int                                      :cpp:func:`GetSize <unsigned int HSelectionSet::GetSize() const>`                                                                                                                                                                               
void                                              :cpp:func:`Reset <virtual void HSelectionSet::Reset()>`                                                                                                                                                                                         
bool                                              :cpp:func:`DeleteSelection <virtual bool HSelectionSet::DeleteSelection(bool emit_message=false)>`                                                                                                                                              
HC_KEY                                            :cpp:func:`GetHighlightStyle <HC_KEY HSelectionSet::GetHighlightStyle() const>`                                                                                                                                                                 
void                                              :cpp:func:`SetHighlightStyle <void HSelectionSet::SetHighlightStyle(HC_KEY key)>`                                                                                                                                                               
char const *                                      :cpp:func:`GetHighlightStyleName <char const  * HSelectionSet::GetHighlightStyleName() const>`                                                                                                                                                  
bool                                              :cpp:func:`DeInstance <bool HSelectionSet::DeInstance(HSelectionItem *sel_item)>`                                                                                                                                                               
bool                                              :cpp:func:`DeInstance <bool HSelectionSet::DeInstance(unsigned int index)>`                                                                                                                                                                     
bool                                              :cpp:func:`GetSubwindowPenetration <virtual bool HSelectionSet::GetSubwindowPenetration()>`                                                                                                                                                     
void                                              :cpp:func:`SetSubwindowPenetration <virtual void HSelectionSet::SetSubwindowPenetration(bool allow)>`                                                                                                                                           
bool                                              :cpp:func:`GetAllowSubentitySelection <virtual bool HSelectionSet::GetAllowSubentitySelection()>`                                                                                                                                               
void                                              :cpp:func:`SetAllowSubentitySelection <virtual void HSelectionSet::SetAllowSubentitySelection(bool allow)>`                                                                                                                                     
:cpp:enumerator:`~HSelectLevel`                   :cpp:func:`GetSelectionLevel <virtual HSelectLevel HSelectionSet::GetSelectionLevel() const>`                                                                                                                                                   
void                                              :cpp:func:`SetSelectionLevel <virtual void HSelectionSet::SetSelectionLevel(HSelectLevel level)>`                                                                                                                                               
bool                                              :cpp:func:`GetAllowEntitySelection <virtual bool HSelectionSet::GetAllowEntitySelection()>`                                                                                                                                                     
void                                              :cpp:func:`SetAllowEntitySelection <virtual void HSelectionSet::SetAllowEntitySelection(bool allow)>`                                                                                                                                           
bool                                              :cpp:func:`GetAllowRegionSelection <virtual bool HSelectionSet::GetAllowRegionSelection() const>`                                                                                                                                               
void                                              :cpp:func:`SetAllowRegionSelection <virtual void HSelectionSet::SetAllowRegionSelection(bool allow)>`                                                                                                                                           
void                                              :cpp:func:`RegisterHighlightSeg <void HSelectionSet::RegisterHighlightSeg(HC_KEY seg_key)>`                                                                                                                                                     
void                                              :cpp:func:`UnRegisterHighlightSeg <void HSelectionSet::UnRegisterHighlightSeg(HC_KEY seg_key)>`                                                                                                                                                 
:cpp:enumerator:`~HSelectionHighlightMode` const  :cpp:func:`GetHighlightMode <virtual HSelectionHighlightMode const HSelectionSet::GetHighlightMode()>`                                                                                                                                          
void                                              :cpp:func:`SetHighlightMode <virtual void HSelectionSet::SetHighlightMode(HSelectionHighlightMode m)>`                                                                                                                                          
void                                              :cpp:func:`SetHighlightTransparency <virtual void HSelectionSet::SetHighlightTransparency(float trans)>`                                                                                                                                        
HC_KEY                                            :cpp:func:`GetSelectionSegment <virtual HC_KEY HSelectionSet::GetSelectionSegment()>`                                                                                                                                                           
void                                              :cpp:func:`ToggleHighlightStyle <void HSelectionSet::ToggleHighlightStyle()>`                                                                                                                                                                   
bool                                              :cpp:func:`GetIsSelection <virtual bool HSelectionSet::GetIsSelection(HC_KEY key)>`                                                                                                                                                             
bool                                              :cpp:func:`GetReferenceSelection <virtual bool HSelectionSet::GetReferenceSelection() const>`                                                                                                                                                   
void                                              :cpp:func:`SetReferenceSelection <virtual void HSelectionSet::SetReferenceSelection(bool ref_sel)>`                                                                                                                                             
void                                              :cpp:func:`SetUseDefinedHighlight <void HSelectionSet::SetUseDefinedHighlight(bool use_defined_highlight)>`                                                                                                                                     
bool                                              :cpp:func:`GetUseDefinedHighlight <bool HSelectionSet::GetUseDefinedHighlight()>`                                                                                                                                                               
void                                              :cpp:func:`SetReferenceSelectionType <virtual void HSelectionSet::SetReferenceSelectionType(HRefSelType type)>`                                                                                                                                 
:cpp:enumerator:`~HRefSelType`                    :cpp:func:`GetReferenceSelectionType <virtual HRefSelType HSelectionSet::GetReferenceSelectionType()>`                                                                                                                                          
void                                              :cpp:func:`UpdateHighlightStyle <virtual void HSelectionSet::UpdateHighlightStyle()>`                                                                                                                                                           
:doc:`classHVHashPShowCache` *                    :cpp:func:`GetPShowCache <HVHashPShowCache * HSelectionSet::GetPShowCache()>`                                                                                                                                                                   
void                                              :cpp:func:`SetPShowCache <void HSelectionSet::SetPShowCache(HVHashPShowCache *new_cache)>`                                                                                                                                                      
void                                              :cpp:func:`FlushPShowCache <void HSelectionSet::FlushPShowCache()>`                                                                                                                                                                             
void                                              :cpp:func:`UpdateHighlighting <void HSelectionSet::UpdateHighlighting()>`                                                                                                                                                                       
:doc:`classHBaseView` *                           :cpp:func:`GetView <HBaseView * HSelectionSet::GetView()>`                                                                                                                                                                                      
void                                              :cpp:func:`SetSortSelectionList <void HSelectionSet::SetSortSelectionList(bool sort)>`                                                                                                                                                          
bool                                              :cpp:func:`GetSortSelectionList <bool HSelectionSet::GetSortSelectionList()>`                                                                                                                                                                   
bool                                              :cpp:func:`GetSubentityFaceSelection <virtual bool HSelectionSet::GetSubentityFaceSelection()>`                                                                                                                                                 
void                                              :cpp:func:`SetSubentityFaceSelection <virtual void HSelectionSet::SetSubentityFaceSelection(bool select)>`                                                                                                                                      
bool                                              :cpp:func:`GetSubentityEdgeSelection <virtual bool HSelectionSet::GetSubentityEdgeSelection()>`                                                                                                                                                 
void                                              :cpp:func:`SetSubentityEdgeSelection <virtual void HSelectionSet::SetSubentityEdgeSelection(bool select)>`                                                                                                                                      
bool                                              :cpp:func:`GetSubentityVertexSelection <virtual bool HSelectionSet::GetSubentityVertexSelection()>`                                                                                                                                             
void                                              :cpp:func:`SetSubentityVertexSelection <virtual void HSelectionSet::SetSubentityVertexSelection(bool select)>`                                                                                                                                  
void                                              :cpp:func:`SetAllowSubentityDeselection <virtual void HSelectionSet::SetAllowSubentityDeselection(bool allow)>`                                                                                                                                 
bool                                              :cpp:func:`GetAllowSubentityDeselection <virtual bool HSelectionSet::GetAllowSubentityDeselection()>`                                                                                                                                           
void                                              :cpp:func:`SetSubentityTracking <virtual void HSelectionSet::SetSubentityTracking(bool allow)>`                                                                                                                                                 
bool                                              :cpp:func:`GetSubentityTracking <virtual bool HSelectionSet::GetSubentityTracking()>`                                                                                                                                                           
void                                              :cpp:func:`GetSelectionBounding <void HSelectionSet::GetSelectionBounding(HPoint *minimum, HPoint *maximum) const>`                                                                                                                             
void                                              :cpp:func:`SetSelectWillNotify <virtual void HSelectionSet::SetSelectWillNotify(bool notify)>`                                                                                                                                                  
bool                                              :cpp:func:`GetSelectWillNotify <virtual bool HSelectionSet::GetSelectWillNotify() const>`                                                                                                                                                       
int                                               :cpp:func:`GetAttrLookupID <int HSelectionSet::GetAttrLookupID(char const *attribute_string)>`                                                                                                                                                  
:doc:`classHSelectionSegmentConditionInfo` *      :cpp:func:`GetSelectionSegmentConditionInfo <HSelectionSegmentConditionInfo * HSelectionSet::GetSelectionSegmentConditionInfo()>`                                                                                                               
:doc:`classHConditionStyleKeyInfoHash` *          :cpp:func:`GetConditionStyleKeyInfo <HConditionStyleKeyInfoHash * HSelectionSet::GetConditionStyleKeyInfo()>`                                                                                                                                   
Segment_Key_Set &                                 :cpp:func:`highlighted_segments <Segment_Key_Set & HSelectionSet::highlighted_segments()>`                                                                                                                                                      
================================================= ================================================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: HSelectionSet
   :project: mvo
   :members:
   :undoc-members:



