vtkContext2DScalarBarActor.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"
#include "vtkCoordinate.h"  // for Position and Position 2
#include "vtkRect.h"        // for functions that return vtkRects
#include "vtkScalarBarActor.h"
#include "vtkSmartPointer.h"  // for smart pointers
 
class vtkAxis;
class vtkColorLegend;
class vtkColorTransferFunctionItem;
class vtkContextActor;
class vtkContext2D;
class vtkContextItem;
class vtkContextScene;
class vtkDoubleArray;
class vtkImageData;
class vtkPoints2D;
class vtkScalarsToColors;
class vtkScalarBarItem;
class vtkTextProperty;
class vtkViewport;
 
class QPCL_ENGINE_LIB_API vtkContext2DScalarBarActor
    : public vtkScalarBarActor {
public:
    vtkTypeMacro(vtkContext2DScalarBarActor, vtkScalarBarActor);
    void PrintSelf(ostream& os, vtkIndent indent) override;
    static vtkContext2DScalarBarActor* New();
 
 
    vtkGetMacro(TitleJustification, int);
    vtkSetClampMacro(TitleJustification, int, VTK_TEXT_LEFT, VTK_TEXT_RIGHT);
 
 
    vtkSetMacro(ForceHorizontalTitle, bool);
    vtkGetMacro(ForceHorizontalTitle, bool);
    vtkBooleanMacro(ForceHorizontalTitle, bool);
 
    enum { PrecedeScalarBar = 0, SucceedScalarBar };
 
    enum OutOfRangeType {
        BELOW_RANGE = 0,
        ABOVE_RANGE = 1,
    };
 
 
    vtkSetClampMacro(ScalarBarThickness, int, 0, VTK_INT_MAX);
    vtkGetMacro(ScalarBarThickness, int);
 
 
    vtkSetClampMacro(ScalarBarLength, double, 0, 1);
    vtkGetMacro(ScalarBarLength, double);
 
 
    vtkSetMacro(ReverseLegend, bool);
    vtkGetMacro(ReverseLegend, bool);
    vtkBooleanMacro(ReverseLegend, bool);
 
 
    vtkGetMacro(AutomaticLabelFormat, int);
    vtkSetMacro(AutomaticLabelFormat, int);
    vtkBooleanMacro(AutomaticLabelFormat, int);
 
 
    vtkSetMacro(AddRangeLabels, int);
    vtkGetMacro(AddRangeLabels, int);
 
 
    vtkSetMacro(AutomaticAnnotations, int);
    vtkGetMacro(AutomaticAnnotations, int);
    vtkBooleanMacro(AutomaticAnnotations, int);
 
 
    vtkGetMacro(AddRangeAnnotations, int);
    vtkSetMacro(AddRangeAnnotations, int);
    vtkBooleanMacro(AddRangeAnnotations, int);
 
 
    vtkGetMacro(OutlineScalarBar, int);
    vtkSetMacro(OutlineScalarBar, int);
    vtkBooleanMacro(OutlineScalarBar, int);
 
 
    vtkSetMacro(DrawTickMarks, bool);
    vtkGetMacro(DrawTickMarks, bool);
 
 
    vtkSetStringMacro(RangeLabelFormat);
    vtkGetStringMacro(RangeLabelFormat);
 
 
    void SetUseCustomLabels(bool useLabels);
    vtkGetMacro(UseCustomLabels, bool);
 
 
    vtkSetMacro(NumberOfTicks, int);
    vtkGetMacro(NumberOfTicks, int);
 
 
    void SetNumberOfCustomLabels(vtkIdType numLabels);
    vtkIdType GetNumberOfCustomLabels();
 
    void SetCustomLabel(vtkIdType index, double value);
 
    int RenderOverlay(vtkViewport* viewport) override;
 
    int RenderOpaqueGeometry(vtkViewport* viewport) override;
 
    void ReleaseGraphicsResources(vtkWindow* window) override;
 
    virtual bool Paint(vtkContext2D* painter);
 
    vtkRectf GetBoundingRect();
 
    int GetEstimatedNumberOfAnnotations();
 
protected:
    vtkContext2DScalarBarActor();
    ~vtkContext2DScalarBarActor() override;
 
private:
    vtkContext2DScalarBarActor(const vtkContext2DScalarBarActor&) = delete;
    void operator=(const vtkContext2DScalarBarActor&) = delete;
 
    vtkContextActor* ActorDelegate;
 
    int TitleJustification;
 
    bool ForceHorizontalTitle;
 
    int ScalarBarThickness;
 
    double ScalarBarLength;
 
    int NumberOfTicks;
 
    int AutomaticLabelFormat;
 
    int AddRangeLabels;
    int AutomaticAnnotations;
    int AddRangeAnnotations;
    char* RangeLabelFormat;
 
    int OutlineScalarBar;
 
    double Spacer;
 
    bool DrawTickMarks;
 
    bool UseCustomLabels;
 
    bool ReverseLegend;
 
    vtkSmartPointer<vtkDoubleArray> CustomLabels;
 
    class vtkScalarBarItem;
    vtkScalarBarItem* ScalarBarItem;
 
    vtkViewport* CurrentViewport;
 
    vtkAxis* Axis;
 
    void UpdateScalarBarTexture(vtkImageData* image);
 
    void GetSize(double size[2], vtkContext2D* painter);
 
    vtkRectf GetColorBarRect(double size[2]);
 
    vtkRectf GetFullColorBarRect(double size[2]);
 
    vtkRectf GetAboveRangeColorRect(double size[2]);
 
    vtkRectf GetBelowRangeColorRect(double size[2]);
 
    vtkRectf GetOutOfRangeColorRectInternal(
            vtkContext2DScalarBarActor::OutOfRangeType type, double size[2]);
 
    vtkRectf GetNaNColorRect(double size[2]);
 
    void UpdateTextProperties();
 
    void PaintColorBar(vtkContext2D* painter, double size[2]);
 
    void PaintAxis(vtkContext2D* painter, double size[2]);
 
    void PaintTitle(vtkContext2D* painter, double size[2]);
 
    class vtkAnnotationMap;
 
    void PaintAnnotations(vtkContext2D* painter,
                          double size[2],
                          const vtkAnnotationMap& map);
 
    void PaintAnnotationsVertically(vtkContext2D* painter,
                                    double size[2],
                                    const vtkAnnotationMap& map);
 
    void PaintAnnotationsHorizontally(vtkContext2D* painter,
                                      double size[2],
                                      const vtkAnnotationMap& map);
};