Tulip  5.5.1
Large graphs analysis and drawing
ColorProperty.h
1 /*
2  *
3  * This file is part of Tulip (http://tulip.labri.fr)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 
20 #ifndef TULIP_COLORS_H
21 #define TULIP_COLORS_H
22 
23 #include <tulip/PropertyTypes.h>
24 #include <tulip/AbstractProperty.h>
25 
26 namespace tlp {
27 
28 class PropertyContext;
29 
30 typedef AbstractProperty<tlp::ColorType, tlp::ColorType> AbstractColorProperty;
31 
32 /**
33  * @ingroup Graph
34  * @brief A graph property that maps a tlp::Color value to graph elements.
35  */
36 class TLP_SCOPE ColorProperty : public AbstractColorProperty {
37 public:
38  ColorProperty(Graph *g, const std::string &n = "");
39  // PropertyInterface inherited methods
40  PropertyInterface *clonePrototype(Graph *, const std::string &) const override;
41  static const std::string propertyTypename;
42  const std::string &getTypename() const override {
43  return propertyTypename;
44  }
45  DEFINE_GET_CPP_CLASS_NAME;
46 
47  int compare(const node n1, const node n2) const override;
48  int compare(const edge e1, const edge e2) const override;
49 };
50 
51 /**
52  * @ingroup Graph
53  * @brief A graph property that maps a std::vector<tlp::Color> value to graph elements.
54  */
55 class TLP_SCOPE ColorVectorProperty
56  : public AbstractVectorProperty<tlp::ColorVectorType, tlp::ColorType> {
57 public:
58  ColorVectorProperty(Graph *g, const std::string &n = "")
59  : AbstractVectorProperty<ColorVectorType, tlp::ColorType>(g, n) {}
60  // PropertyInterface inherited methods
61  PropertyInterface *clonePrototype(Graph *, const std::string &) const override;
62  static const std::string propertyTypename;
63  const std::string &getTypename() const override {
64  return propertyTypename;
65  }
66  DEFINE_GET_CPP_CLASS_NAME;
67 };
68 } // namespace tlp
69 #endif
tlp::Graph
Definition: Graph.h:234
tlp::ColorProperty
A graph property that maps a tlp::Color value to graph elements.
Definition: ColorProperty.h:36
tlp::PropertyInterface
PropertyInterface describes the interface of a graph property.
Definition: PropertyInterface.h:60
tlp::ColorVectorProperty
A graph property that maps a std::vector<tlp::Color> value to graph elements.
Definition: ColorProperty.h:55
tlp::AbstractProperty
This class extends upon PropertyInterface, and adds type-safe methods to get and set the node and edg...
Definition: AbstractProperty.h:55
tlp::ColorProperty::getTypename
const std::string & getTypename() const override
Gets a string describing the type of the property value (e.g. "graph", "double", "layout",...
Definition: ColorProperty.h:42
tlp::ColorVectorProperty::getTypename
const std::string & getTypename() const override
Gets a string describing the type of the property value (e.g. "graph", "double", "layout",...
Definition: ColorProperty.h:63
tlp
Definition: AbstractProperty.h:34
tlp::edge
The edge struct represents an edge in a Graph object.
Definition: Edge.h:40
tlp::node
The node struct represents a node in a Graph object.
Definition: Node.h:40