Badge.h

//=========================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//=========================================================================
 
#ifndef smtk_view_Badge_h
#define smtk_view_Badge_h
 
#include "smtk/view/Configuration.h"
 
#include "smtk/PublicPointerDefs.h"
#include "smtk/SharedFromThis.h"
 
#include <array>
 
namespace smtk
{
namespace view
{
 
class SMTKCORE_EXPORT BadgeAction
{
public:
  using PhraseVisitor = std::function<bool(DescriptivePhrase*)>;
 
  virtual void visitRelatedPhrases(PhraseVisitor visitor) const { (void)visitor; }
};
 
class SMTKCORE_EXPORT BadgeActionToggle : public BadgeAction
{
};
 
class SMTKCORE_EXPORT Badge : smtkEnableSharedPtr(Badge)
{
public:
  smtkTypeMacroBase(Badge);
  Badge() = default;
  Badge(const Badge&) = delete;
  Badge& operator=(const Badge&) = delete;
  virtual ~Badge() = default;
 
  virtual bool appliesToPhrase(const DescriptivePhrase*) const { return false; }
 
  virtual std::string tooltip(const DescriptivePhrase*) const { return std::string(); }
 
  virtual std::string icon(const DescriptivePhrase* phrase, const std::array<float, 4>& background)
    const = 0;
 
  virtual bool action(const DescriptivePhrase*, const BadgeAction&) { return false; }
 
  bool isDefault() const { return m_isDefault; }
 
  void setIsDefault(bool isDefault) { m_isDefault = isDefault; }
 
protected:
  bool m_isDefault{ false };
};
} // namespace view
} // namespace smtk
#endif