qgsannotationlayer3drenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgsannotationlayer3drenderer.h
  --------------------------------------
  Date                 : September 2025
  Copyright            : (C) 2025 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSANNOTATIONLAYER3DRENDERER_H
#define QGSANNOTATIONLAYER3DRENDERER_H
 
#include "qgis_3d.h"
#include "qgis_sip.h"
#include "qgs3drendererregistry.h"
#include "qgsabstract3drenderer.h"
#include "qgsmaplayerref.h"
#include "qgstextformat.h"
 
class QgsAnnotationLayer;
 
#ifdef SIP_RUN
// this is needed for the "convert to subclass" code below to compile
% ModuleHeaderCode
#include "qgsannotationlayer3drenderer.h"
  % End
#endif

  class _3D_EXPORT QgsAnnotationLayer3DRendererMetadata : public Qgs3DRendererAbstractMetadata
{
  public:
    QgsAnnotationLayer3DRendererMetadata();

    QgsAbstract3DRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) override SIP_FACTORY;
};

class _3D_EXPORT QgsAnnotationLayer3DRenderer : public QgsAbstract3DRenderer
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsAnnotationLayer3DRenderer *>( sipCpp ) != nullptr )
      sipType = sipType_QgsAnnotationLayer3DRenderer;
    else
      sipType = nullptr;
    SIP_END
#endif
 
  public:
    QgsAnnotationLayer3DRenderer();

    void setLayer( QgsAnnotationLayer *layer );

    QgsAnnotationLayer *layer() const;
 
    QString type() const override;
    QgsAnnotationLayer3DRenderer *clone() const override SIP_FACTORY;
    Qt3DCore::QEntity *createEntity( Qgs3DMapSettings *map ) const override SIP_SKIP;
 
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
    void resolveReferences( const QgsProject &project ) override;

    Qgis::AltitudeClamping altitudeClamping() const { return mAltClamping; }

    void setAltitudeClamping( Qgis::AltitudeClamping clamping ) { mAltClamping = clamping; }

    double zOffset() const { return mZOffset; }

    void setZOffset( double offset ) { mZOffset = offset; }

    bool showCalloutLines() const;

    void setShowCalloutLines( bool show );
 
    // TODO -- consider exposing via QgsSimpleLineMaterialSettings, for now, for testing only

    SIP_SKIP void setCalloutLineColor( const QColor &color );

    SIP_SKIP QColor calloutLineColor() const;

    SIP_SKIP void setCalloutLineWidth( double width );

    SIP_SKIP double calloutLineWidth() const;

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );
 
  private:
#ifdef SIP_RUN
    QgsAnnotationLayer3DRenderer( const QgsAnnotationLayer3DRenderer & );
#endif
 
    static constexpr double DEFAULT_Z_OFFSET = 50;
 
    QgsMapLayerRef mLayerRef;
    Qgis::AltitudeClamping mAltClamping = Qgis::AltitudeClamping::Relative;
    double mZOffset = DEFAULT_Z_OFFSET;
    bool mShowCalloutLines = true;
    QColor mCalloutLineColor { 0, 0, 0 };
    double mCalloutLineWidth = 2;
    QgsTextFormat mTextFormat;
};
 
#endif // QGSANNOTATIONLAYER3DRENDERER_H