qgspainteffectregistry.cpp

Go to the documentation of this file.

/***************************************************************************
                            qgspainteffectregistry.cpp
                             ------------------------
    begin                : January 2015
    copyright            : (C) 2015 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgspainteffectregistry.h"
 
#include "qgsapplication.h"
#include "qgsblureffect.h"
#include "qgscoloreffect.h"
#include "qgseffectstack.h"
#include "qgsgloweffect.h"
#include "qgsshadoweffect.h"
#include "qgstransformeffect.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
QgsPaintEffect *QgsPaintEffectMetadata::createPaintEffect( const QVariantMap &map )
{
  return mCreateFunc ? mCreateFunc( map ).release() : nullptr;
}
 
QgsPaintEffectAbstractMetadata::QgsPaintEffectAbstractMetadata( const QString &name, const QString &visibleName )
  : mName( name )
  , mVisibleName( visibleName )
{}
 
QgsPaintEffectRegistry::QgsPaintEffectRegistry()
{
  //init registry with known effects
  addEffectType( new QgsPaintEffectMetadata( u"blur"_s, QObject::tr( "Blur" ), QgsBlurEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"dropShadow"_s, QObject::tr( "Drop Shadow" ), QgsDropShadowEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"innerShadow"_s, QObject::tr( "Inner Shadow" ), QgsInnerShadowEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"effectStack"_s, QObject::tr( "Stack" ), QgsEffectStack::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"outerGlow"_s, QObject::tr( "Outer Glow" ), QgsOuterGlowEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"innerGlow"_s, QObject::tr( "Inner Glow" ), QgsInnerGlowEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"drawSource"_s, QObject::tr( "Source" ), QgsDrawSourceEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"transform"_s, QObject::tr( "Transform" ), QgsTransformEffect::create, nullptr ) );
  addEffectType( new QgsPaintEffectMetadata( u"color"_s, QObject::tr( "Colorise" ), QgsColorEffect::create, nullptr ) );
}
 
QgsPaintEffectRegistry::~QgsPaintEffectRegistry()
{
  qDeleteAll( mMetadata );
}
 
QgsPaintEffectAbstractMetadata *QgsPaintEffectRegistry::effectMetadata( const QString &name ) const
{
  if ( mMetadata.contains( name ) )
    return mMetadata.value( name );
  else
    return nullptr;
}
 
bool QgsPaintEffectRegistry::addEffectType( QgsPaintEffectAbstractMetadata *metadata )
{
  if ( !metadata || mMetadata.contains( metadata->name() ) )
    return false;
 
  mMetadata[metadata->name()] = metadata;
  return true;
}
 
std::unique_ptr<QgsPaintEffect> QgsPaintEffectRegistry::createEffect( const QString &name, const QVariantMap &properties ) const
{
  if ( !mMetadata.contains( name ) )
    return nullptr;
 
  std::unique_ptr<QgsPaintEffect> effect( mMetadata[name]->createPaintEffect( properties ) );
  return effect;
}
 
std::unique_ptr<QgsPaintEffect> QgsPaintEffectRegistry::createEffect( const QDomElement &element ) const
{
  if ( element.isNull() )
  {
    return nullptr;
  }
 
  const QString type = element.attribute( u"type"_s );
 
  std::unique_ptr<QgsPaintEffect> effect( QgsApplication::paintEffectRegistry()->createEffect( type ) );
  if ( !effect )
    return nullptr;
 
  effect->readProperties( element );
  return effect;
}
 
QStringList QgsPaintEffectRegistry::effects() const
{
  QStringList lst;
  QMap<QString, QgsPaintEffectAbstractMetadata *>::ConstIterator it = mMetadata.begin();
  for ( ; it != mMetadata.end(); ++it )
  {
    lst.append( it.key() );
  }
  return lst;
}
 
std::unique_ptr<QgsPaintEffect> QgsPaintEffectRegistry::defaultStack()
{
  //NOTE - also remember to update isDefaultStack below if making changes to this list
  auto stack = std::make_unique<QgsEffectStack>();
  QgsDropShadowEffect *dropShadow = new QgsDropShadowEffect();
  dropShadow->setEnabled( false );
  stack->appendEffect( dropShadow );
  QgsOuterGlowEffect *outerGlow = new QgsOuterGlowEffect();
  outerGlow->setEnabled( false );
  stack->appendEffect( outerGlow );
  stack->appendEffect( new QgsDrawSourceEffect() );
  QgsInnerShadowEffect *innerShadow = new QgsInnerShadowEffect();
  innerShadow->setEnabled( false );
  stack->appendEffect( innerShadow );
  QgsInnerGlowEffect *innerGlow = new QgsInnerGlowEffect();
  innerGlow->setEnabled( false );
  stack->appendEffect( innerGlow );
  return stack;
}
 
bool QgsPaintEffectRegistry::isDefaultStack( QgsPaintEffect *effect )
{
  QgsEffectStack *effectStack = dynamic_cast< QgsEffectStack * >( effect );
  if ( !effectStack )
    return false;
 
  if ( effectStack->count() != 5 )
    return false;
 
  for ( int i = 0; i < 5; ++i )
  {
    //only the third effect should be enabled
    if ( effectStack->effect( i )->enabled() != ( i == 2 ) )
      return false;
  }
 
  if ( !dynamic_cast< QgsDropShadowEffect * >( effectStack->effect( 0 ) ) )
    return false;
  if ( !dynamic_cast< QgsOuterGlowEffect * >( effectStack->effect( 1 ) ) )
    return false;
  if ( !dynamic_cast< QgsDrawSourceEffect * >( effectStack->effect( 2 ) ) )
    return false;
  if ( !dynamic_cast< QgsInnerShadowEffect * >( effectStack->effect( 3 ) ) )
    return false;
  if ( !dynamic_cast< QgsInnerGlowEffect * >( effectStack->effect( 4 ) ) )
    return false;
 
  QgsDrawSourceEffect *sourceEffect = static_cast< QgsDrawSourceEffect * >( effectStack->effect( 2 ) );
  if ( !qgsDoubleNear( sourceEffect->opacity(), 1.0 ) )
    return false;
  if ( sourceEffect->blendMode() != QPainter::CompositionMode_SourceOver )
    return false;
 
  //we don't go as far as to check disabled effect's properties
  return true;
}