SizeProperty.h

/*
 *
 * This file is part of Tulip (https://tulip.labri.fr)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 */
 
#ifndef TULIP_SIZES_H
#define TULIP_SIZES_H
 
#include <tulip/tuliphash.h>
 
#include <tulip/PropertyTypes.h>
#include <tulip/AbstractProperty.h>
#include <tulip/PropertyAlgorithm.h>
 
namespace tlp {
 
class PropertyContext;
 
typedef AbstractProperty<tlp::SizeType, tlp::SizeType> AbstractSizeProperty;
 
/**
 * @ingroup Graph
 * @brief A graph property that maps a tlp::Size value to graph elements.
 */
class TLP_SCOPE SizeProperty : public AbstractSizeProperty {
 
public:
  SizeProperty(Graph *, const std::string &n = "");
  using AbstractSizeProperty::operator=;
 
  Size getMax(const Graph *sg = nullptr);
  Size getMin(const Graph *sg = nullptr);
  void scale(const tlp::Vector<float, 3> &, const Graph *sg = nullptr);
  void scale(const tlp::Vector<float, 3> &, Iterator<node> *, Iterator<edge> *);
 
  // redefinition of some PropertyInterface methods
  PropertyInterface *clonePrototype(Graph *, const std::string &) const override;
  static const std::string propertyTypename;
  const std::string &getTypename() const override {
    return propertyTypename;
  }
  DEFINE_GET_CPP_CLASS_NAME;
 
  // redefinition of some AbstractProperty methods
  void setNodeValue(const node n,
                    tlp::StoredType<tlp::SizeType::RealType>::ReturnedConstValue v) override;
  void setAllNodeValue(tlp::StoredType<tlp::SizeType::RealType>::ReturnedConstValue v) override;
  void setValueToGraphNodes(tlp::StoredType<tlp::SizeType::RealType>::ReturnedConstValue v,
                            const Graph *graph) override;
 
  int compare(const node n1, const node n2) const override;
 
protected:
  void resetMinMax();
 
private:
  tlp_hash_map<unsigned int, Size> max, min;
  tlp_hash_map<unsigned int, bool> minMaxOk;
  void computeMinMax(const Graph *sg = nullptr);
};
 
/**
 * @ingroup Graph
 * @brief A graph property that maps a std::vector<tlp::Size> value to graph elements.
 */
class TLP_SCOPE SizeVectorProperty
    : public AbstractVectorProperty<tlp::SizeVectorType, tlp::SizeType> {
public:
  SizeVectorProperty(Graph *g, const std::string &n = "")
      : AbstractVectorProperty<SizeVectorType, SizeType>(g, n) {}
  using AbstractVectorProperty<tlp::SizeVectorType, tlp::SizeType>::operator=;
 
  // redefinition of some PropertyInterface methods
  PropertyInterface *clonePrototype(Graph *, const std::string &) const override;
  static const std::string propertyTypename;
  const std::string &getTypename() const override {
    return propertyTypename;
  }
  DEFINE_GET_CPP_CLASS_NAME;
};
} // namespace tlp
#endif