qgslightsource.h

Go to the documentation of this file.

/***************************************************************************
                          qgslightsource.h
                          ---------------
    begin                : April 2022
    copyright            : (C) 2022 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 QGSLIGHTSOURCE_H
#define QGSLIGHTSOURCE_H
 
#include "qgis.h"
#include "qgis_3d.h"
#include "qgis_sip.h"
#include "qgsreadwritecontext.h"
 
#include <QList>
 
class Qgs3DMapSettings;
class QgsProject;
class QDomElement;
class QDomDocument;
 
#ifndef SIP_RUN
namespace Qt3DCore
{
  class QEntity;
}
#endif

class _3D_EXPORT QgsLightSource SIP_ABSTRACT
{
  public:
    virtual ~QgsLightSource();

    virtual Qgis::LightSourceType type() const = 0;

    virtual QgsLightSource *clone() const = 0 SIP_FACTORY;

    QString id() const { return mId; }

    virtual Qt3DCore::QEntity *createEntity( const Qgs3DMapSettings &map, Qt3DCore::QEntity *parent ) const SIP_SKIP = 0;

    virtual QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const = 0;

    virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() ) = 0;

    virtual void resolveReferences( const QgsProject &project );

    static QgsLightSource *createFromXml( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY;
 
  protected:
    QgsLightSource();

    QString mId;
};
 
 
#endif // QGSLIGHTSOURCE_H