cvSelectionHighlighter.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include "qPCL.h"
 
// LOCAL
#include "cvGenericSelectionTool.h"
#include "cvSelectionData.h"
 
// Qt
#include <QColor>
#include <QObject>
#include <QString>
 
// VTK
#include <vtkActor.h>  // Full definition needed for vtkSmartPointer<vtkActor>
#include <vtkSmartPointer.h>
class vtkIdTypeArray;
class vtkPolyData;
class vtkDataArray;
class vtkFieldData;
class vtkDataSetMapper;
class vtkExtractSelection;
class vtkSelection;
class vtkSelectionNode;
class vtkRenderer;
class vtkActor2D;
class vtkLabeledDataMapper;
 
namespace PclUtils {
class PCLVis;
}
 
struct QPCL_ENGINE_LIB_API SelectionLabelProperties {
    // General (ParaView defaults from VTK/Rendering/Core/vtkProperty.h)
    double opacity = 1.0;
    int pointSize = 5;  // ParaView default
    int lineWidth = 2;
 
    // Cell Label Font (ParaView defaults from
    // representations_remotingviews.xml) Line 4468-4521: CellLabelColor
    // default_values="0.0 1.0 0.0" (Green)
    QString cellLabelFontFamily = "Arial";  // ParaView: FontFamily = 0 (Arial)
    int cellLabelFontSize = 18;             // ParaView: CellLabelFontSize = 18
    QColor cellLabelColor = QColor(0, 255, 0);  // ParaView: Green (0, 1, 0)
    double cellLabelOpacity = 1.0;
    bool cellLabelBold = false;    // ParaView: default_values="0"
    bool cellLabelItalic = false;  // ParaView: default_values="0"
    bool cellLabelShadow = false;  // ParaView: default_values="0" (NOT true!)
    int cellLabelHorizontalJustification = 0;  // ParaView: 0=Left
    int cellLabelVerticalJustification = 0;    // ParaView: 0=Bottom
    QString cellLabelFormat = "";  // ParaView: empty (auto-select format)
 
    // Point Label Font (ParaView defaults from
    // representations_remotingviews.xml) Line 4326-4401: PointLabelColor
    // default_values="1 1 0" (Yellow)
    QString pointLabelFontFamily = "Arial";  // ParaView: FontFamily = 0 (Arial)
    int pointLabelFontSize = 18;  // ParaView: PointLabelFontSize = 18
    QColor pointLabelColor = QColor(255, 255, 0);  // ParaView: Yellow (1, 1, 0)
    double pointLabelOpacity = 1.0;
    bool pointLabelBold = false;    // ParaView: default_values="0"
    bool pointLabelItalic = false;  // ParaView: default_values="0"
    bool pointLabelShadow = false;  // ParaView: default_values="0" (NOT true!)
    int pointLabelHorizontalJustification = 0;  // ParaView: 0=Left
    int pointLabelVerticalJustification = 0;    // ParaView: 0=Bottom
    QString pointLabelFormat = "";  // ParaView: empty (auto-select format)
 
    // Tooltip
    bool showTooltips = true;
    int maxTooltipAttributes = 15;
};
 
class QPCL_ENGINE_LIB_API cvSelectionHighlighter
    : public QObject,
      public cvGenericSelectionTool {
    Q_OBJECT
public:
    enum HighlightMode {
        HOVER,        
        PRESELECTED,  
        SELECTED,  
        BOUNDARY   
    };
 
    cvSelectionHighlighter();
 
    ~cvSelectionHighlighter();
 
    bool highlightSelection(const vtkSmartPointer<vtkIdTypeArray>& selection,
                            int fieldAssociation,
                            HighlightMode mode = SELECTED);
 
    bool highlightSelection(vtkPolyData* polyData,
                            const vtkSmartPointer<vtkIdTypeArray>& selection,
                            int fieldAssociation,
                            HighlightMode mode = SELECTED);
 
    bool highlightSelection(const cvSelectionData& selectionData,
                            HighlightMode mode = SELECTED);
 
    bool highlightElement(vtkPolyData* polyData,
                          vtkIdType elementId,
                          int fieldAssociation);
 
    void clearHighlights();
 
    void clearHoverHighlight();
 
    void setHighlightsVisible(bool visible);
 
    void setHighlightColor(double r,
                           double g,
                           double b,
                           HighlightMode mode = SELECTED);
 
    void setHighlightOpacity(double opacity, HighlightMode mode = SELECTED);
 
    const double* getHighlightColor(HighlightMode mode) const;
 
    double getHighlightOpacity(HighlightMode mode) const;
 
    void setPointSize(int size, HighlightMode mode = SELECTED);
 
    int getPointSize(HighlightMode mode) const;
 
    void setLineWidth(int width, HighlightMode mode = SELECTED);
 
    int getLineWidth(HighlightMode mode) const;
 
    void setEnabled(bool enabled);
 
    // =========================================================================
    // Label Properties (Single Source of Truth)
    // =========================================================================
 
    const SelectionLabelProperties& getLabelProperties(
            bool interactive = false) const;
 
    void setLabelProperties(const SelectionLabelProperties& props,
                            bool interactive = false);
 
    // =========================================================================
    // Selection Label Array Methods (ParaView-style)
    // =========================================================================
 
    void setPointLabelArray(const QString& arrayName, bool visible = true);
 
    void setCellLabelArray(const QString& arrayName, bool visible = true);
 
    QString getPointLabelArrayName() const { return m_pointLabelArrayName; }
 
    QString getCellLabelArrayName() const { return m_cellLabelArrayName; }
 
    bool isPointLabelVisible() const { return m_pointLabelVisible; }
 
    bool isCellLabelVisible() const { return m_cellLabelVisible; }
 
    // =========================================================================
    // QColor convenience methods (for Qt UI components)
    // =========================================================================
 
    QColor getHighlightQColor(HighlightMode mode) const;
 
    void setHighlightQColor(const QColor& color, HighlightMode mode = SELECTED);
 
signals:
    void colorChanged(int mode);
 
    void opacityChanged(int mode);
 
    void pointSizeChanged(int mode);
 
    void lineWidthChanged(int mode);
 
    void labelPropertiesChanged(bool interactive);
 
    void propertiesChanged();
 
private:
    vtkSmartPointer<vtkActor> createHighlightActor(vtkPolyData* polyData,
                                                   vtkIdTypeArray* selection,
                                                   int fieldAssociation,
                                                   HighlightMode mode);
 
    vtkSmartPointer<vtkSelectionNode> createSelectionNode(
            vtkIdTypeArray* selection, int fieldAssociation);
 
    void addActorToVisualizer(vtkActor* actor, const QString& id);
 
    void removeActorFromVisualizer(const QString& id);
 
    void updateLabelActor(bool isPointLabels);
 
    // m_viewer is inherited from cvGenericSelectionTool
 
    // Highlight actors (ParaView-style multi-level)
    vtkSmartPointer<vtkActor> m_hoverActor;        
    vtkSmartPointer<vtkActor> m_preselectedActor;  
    vtkSmartPointer<vtkActor> m_selectedActor;     
    vtkSmartPointer<vtkActor> m_boundaryActor;     
 
    // Colors for different modes (Enhanced for maximum visibility)
    // Using bright, highly saturated colors that stand out
    double m_hoverColor[3];  
    double m_preselectedColor[3];  
    double m_selectedColor[3];  
    double m_boundaryColor[3];  
 
    // Opacities (Enhanced for maximum visibility)
    double m_hoverOpacity;        
    double m_preselectedOpacity;  
    double m_selectedOpacity;     
    double m_boundaryOpacity;     
 
    // Point sizes for different modes
    int m_hoverPointSize;
    int m_preselectedPointSize;
    int m_selectedPointSize;
    int m_boundaryPointSize;
 
    // Line widths for different modes
    int m_hoverLineWidth;
    int m_preselectedLineWidth;
    int m_selectedLineWidth;
    int m_boundaryLineWidth;
 
    bool m_enabled;
    QString m_hoverActorId;
    QString m_preselectedActorId;
    QString m_selectedActorId;
    QString m_boundaryActorId;
 
    // Label properties (single source of truth)
    SelectionLabelProperties m_labelProperties;  
    SelectionLabelProperties m_interactiveLabelProperties;  
 
    // Label array names for displaying on selected elements
    QString m_pointLabelArrayName;  
    QString m_cellLabelArrayName;   
    bool m_pointLabelVisible;       
    bool m_cellLabelVisible;        
 
    // Label actors for rendering labels on selected elements
    vtkSmartPointer<vtkActor2D> m_pointLabelActor;  
    vtkSmartPointer<vtkActor2D> m_cellLabelActor;   
    vtkSmartPointer<vtkPolyData>
            m_lastSelectionPolyData;  
};
 
//=============================================================================
// Tooltip Formatter (merged from cvTooltipFormatter.h)
//=============================================================================
 
class QPCL_ENGINE_LIB_API cvTooltipFormatter {
public:
    enum AssociationType { POINTS = 1, CELLS = 0 };
 
    cvTooltipFormatter();
 
    ~cvTooltipFormatter();
 
    QString getTooltipInfo(vtkPolyData* polyData,
                           vtkIdType elementId,
                           AssociationType association,
                           const QString& datasetName = QString());
 
    QString getPlainTooltipInfo(vtkPolyData* polyData,
                                vtkIdType elementId,
                                AssociationType association,
                                const QString& datasetName = QString());
 
    void setMaxAttributes(int maxAttribs);
 
private:
    QString formatPointTooltip(vtkPolyData* polyData,
                               vtkIdType pointId,
                               const QString& datasetName);
 
    QString formatCellTooltip(vtkPolyData* polyData,
                              vtkIdType cellId,
                              const QString& datasetName);
 
    void addArrayValues(QString& tooltip,
                        vtkFieldData* fieldData,
                        vtkIdType tupleIndex);
 
    QString formatArrayValue(vtkDataArray* array, vtkIdType tupleIndex);
 
    QString formatNumber(double value);
 
    int m_maxAttributes;  
};