Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::ClusterGraphAttributes Class Reference

Stores additional attributes of a clustered graph (like layout information). More...

#include <ogdf/cluster/ClusterGraphAttributes.h>

+ Inheritance diagram for ogdf::ClusterGraphAttributes:

Public Member Functions

ColorfillBgColor (node v)
 Returns the background color of fill patterns for node v. More...
 
const ColorfillBgColor (node v) const
 Returns the background color of fill patterns for node v. More...
 
ColorfillColor (node v)
 Returns the fill color of node v. More...
 
const ColorfillColor (node v) const
 Returns the fill color of node v. More...
 
FillPatternfillPattern (node v)
 Returns the fill pattern of node v. More...
 
FillPattern fillPattern (node v) const
 Returns the fill pattern of node v. More...
 
NodeArray< double > & height ()
 Returns a reference to the node array m_height. More...
 
const NodeArray< double > & height () const
 Returns a reference to the node array m_height. More...
 
double & height (node v)
 Returns the height of the bounding box of node v. More...
 
double height (node v) const
 Returns the height of the bounding box of node v. More...
 
string & label (edge e)
 Returns the label of edge e. More...
 
const string & label (edge e) const
 Returns the label of edge e. More...
 
string & label (node v)
 Returns the label of node v. More...
 
const string & label (node v) const
 Returns the label of node v. More...
 
ColorstrokeColor (edge e)
 Returns the stroke color of edge e. More...
 
const ColorstrokeColor (edge e) const
 Returns the stroke color of edge e. More...
 
ColorstrokeColor (node v)
 Returns the stroke color of node v. More...
 
const ColorstrokeColor (node v) const
 Returns the stroke color of node v. More...
 
StrokeTypestrokeType (edge e)
 Returns the stroke type of edge e. More...
 
StrokeType strokeType (edge e) const
 Returns the stroke type of edge e. More...
 
StrokeTypestrokeType (node v)
 Returns the stroke type of node v. More...
 
StrokeType strokeType (node v) const
 Returns the stroke type of node v. More...
 
float & strokeWidth (edge e)
 Returns the stroke width of edge e. More...
 
float strokeWidth (edge e) const
 Returns the stroke width of edge e. More...
 
float & strokeWidth (node v)
 Returns the stroke width of node v. More...
 
float strokeWidth (node v) const
 Returns the stroke width of node v. More...
 
NodeArray< double > & width ()
 Returns a reference to the node array #m_width. More...
 
const NodeArray< double > & width () const
 Returns a reference to the node array m_width. More...
 
double & width (node v)
 Returns the width of the bounding box of node v. More...
 
double width (node v) const
 Returns the width of the bounding box of node v. More...
 
double & x (node v)
 Returns the x-coordinate of node v. More...
 
double x (node v) const
 Returns the x-coordinate of node v. More...
 
double & y (node v)
 Returns the y-coordinate of node v. More...
 
double y (node v) const
 Returns the y-coordinate of node v. More...
 
Cluster attributes
double x (cluster c) const
 Returns the x-position of cluster c's cage (lower left corner). More...
 
double & x (cluster c)
 Returns the x-position of cluster c's cage (lower left corner). More...
 
double y (cluster c) const
 Returns the y-position of cluster c's cage (lower left corner). More...
 
double & y (cluster c)
 Returns the y-position of cluster c's cage (lower left corner). More...
 
double width (cluster c) const
 Returns the width of cluster c. More...
 
double & width (cluster c)
 Returns the width of cluster c. More...
 
double height (cluster c) const
 Returns the height of cluster c. More...
 
double & height (cluster c)
 Returns the height of cluster c. More...
 
const StrokeTypestrokeType (cluster c) const
 Returns the stroke type of cluster c. More...
 
StrokeTypestrokeType (cluster c)
 Returns the stroke type of cluster c. More...
 
const ColorstrokeColor (cluster c) const
 Returns the stroke color of cluster c. More...
 
ColorstrokeColor (cluster c)
 Returns the stroke color of cluster c. More...
 
const float & strokeWidth (cluster c) const
 Returns the stroke width of cluster c. More...
 
float & strokeWidth (cluster c)
 Returns the stroke width of cluster c. More...
 
const FillPatternfillPattern (cluster c) const
 Returns the fill pattern of cluster c. More...
 
FillPatternfillPattern (cluster c)
 Returns the fill pattern of cluster c. More...
 
const ColorfillColor (cluster c) const
 Returns the fill color of cluster c. More...
 
ColorfillColor (cluster c)
 Returns the fill color of cluster c. More...
 
const ColorfillBgColor (cluster c) const
 Returns the background color of fill patterns for cluster c. More...
 
ColorfillBgColor (cluster c)
 Returns the background color of fill patterns for cluster c. More...
 
const string & label (cluster c) const
 Returns the label of cluster c. More...
 
string & label (cluster c)
 Returns the label of cluster c. More...
 
const string & templateCluster (cluster c) const
 Returns the template of cluster c. More...
 
string & templateCluster (cluster c)
 Returns the template of cluster c. More...
 
virtual void scale (double sx, double sy, bool scaleNodes=true) override
 Scales the layout by (sx,sy). More...
 
virtual void translate (double dx, double dy) override
 Translates the layout by (dx,dy). More...
 
virtual void flipVertical (const DRect &box) override
 Flips the (whole) layout vertically such that the part in box remains in this area. More...
 
virtual void flipHorizontal (const DRect &box) override
 Flips the (whole) layout horizontally such that the part in box remains in this area. More...
 
virtual void scale (double sx, double sy, bool scaleNodes=true)
 
virtual void scale (double s, bool scaleNodes=true)
 
virtual void flipVertical ()
 Flips the layout vertically within its bounding box. More...
 
virtual void flipVertical (const DRect &box)
 Flips the (whole) layout vertically such that the part in box remains in this area. More...
 
virtual void flipHorizontal ()
 Flips the layout horizontally within its bounding box. More...
 
virtual void flipHorizontal (const DRect &box)
 Flips the (whole) layout horizontally such that the part in box remains in this area. More...
 
Utility functions
virtual DRect boundingBox () const override
 Returns the bounding box of the layout. More...
 
void updateClusterPositions (double boundaryDist=1.0)
 Updates positions of cluster boundaries wrt to children and child clusters. More...
 
cluster clusterOf (node v)
 Returns the parent cluster of node v. More...
 
- Public Member Functions inherited from ogdf::GraphAttributes
 GraphAttributes ()
 Constructs graph attributes for no associated graph (default constructor). More...
 
 GraphAttributes (const Graph &G, long attr=nodeGraphics|edgeGraphics)
 Constructs graph attributes associated with the graph G. More...
 
 GraphAttributes (const GraphAttributes &)=default
 Copy constructor. More...
 
GraphAttributesoperator= (const GraphAttributes &)=default
 Copy assignment operator. More...
 
virtual ~GraphAttributes ()
 
long attributes () const
 Returns currently accessible attributes. More...
 
bool has (long attr) const
 Returns true iff all attributes in attr are available. More...
 
virtual void init (const Graph &G, long attr)
 Initializes the graph attributes for graph G. More...
 
void init (long attr)
 Re-initializes the graph attributes while maintaining the associated graph. More...
 
void addAttributes (long attr)
 Enables attributes specified by attr and allocates required memory. More...
 
void destroyAttributes (long attr)
 Disables attributes specified by attr and releases available memory. More...
 
const GraphconstGraph () const
 Returns a reference to the associated graph. More...
 
bool directed () const
 Returns if the graph is directed. More...
 
bool & directed ()
 Returns if the graph is directed. More...
 
double x (node v) const
 Returns the x-coordinate of node v. More...
 
double & x (node v)
 Returns the x-coordinate of node v. More...
 
double y (node v) const
 Returns the y-coordinate of node v. More...
 
double & y (node v)
 Returns the y-coordinate of node v. More...
 
double z (node v) const
 Returns the z-coordinate of node v. More...
 
double & z (node v)
 Returns the z-coordinate of node v. More...
 
double xLabel (node v) const
 Returns the label x-coordinate of node v. More...
 
double & xLabel (node v)
 Returns the label x-coordinate of node v. More...
 
double yLabel (node v) const
 Returns the label y-coordinate of node v. More...
 
double & yLabel (node v)
 Returns the label y-coordinate of node v. More...
 
double zLabel (node v) const
 Returns the label z-coordinate of node v. More...
 
double & zLabel (node v)
 Returns the label z-coordinate of node v. More...
 
double width (node v) const
 Returns the width of the bounding box of node v. More...
 
double & width (node v)
 Returns the width of the bounding box of node v. More...
 
const NodeArray< double > & width () const
 Returns a reference to the node array m_width. More...
 
NodeArray< double > & width ()
 Returns a reference to the node array #m_width. More...
 
double height (node v) const
 Returns the height of the bounding box of node v. More...
 
double & height (node v)
 Returns the height of the bounding box of node v. More...
 
const NodeArray< double > & height () const
 Returns a reference to the node array m_height. More...
 
NodeArray< double > & height ()
 Returns a reference to the node array m_height. More...
 
Shape shape (node v) const
 Returns the shape type of node v. More...
 
Shapeshape (node v)
 Returns the shape type of node v. More...
 
StrokeType strokeType (node v) const
 Returns the stroke type of node v. More...
 
StrokeTypestrokeType (node v)
 Returns the stroke type of node v. More...
 
const ColorstrokeColor (node v) const
 Returns the stroke color of node v. More...
 
ColorstrokeColor (node v)
 Returns the stroke color of node v. More...
 
float strokeWidth (node v) const
 Returns the stroke width of node v. More...
 
float & strokeWidth (node v)
 Returns the stroke width of node v. More...
 
FillPattern fillPattern (node v) const
 Returns the fill pattern of node v. More...
 
FillPatternfillPattern (node v)
 Returns the fill pattern of node v. More...
 
const ColorfillColor (node v) const
 Returns the fill color of node v. More...
 
ColorfillColor (node v)
 Returns the fill color of node v. More...
 
const ColorfillBgColor (node v) const
 Returns the background color of fill patterns for node v. More...
 
ColorfillBgColor (node v)
 Returns the background color of fill patterns for node v. More...
 
const string & label (node v) const
 Returns the label of node v. More...
 
string & label (node v)
 Returns the label of node v. More...
 
const string & templateNode (node v) const
 Returns the template name of node v. More...
 
string & templateNode (node v)
 Returns the template name of node v. More...
 
int weight (node v) const
 Returns the weight of node v. More...
 
int & weight (node v)
 Returns the weight of node v. More...
 
Graph::NodeType type (node v) const
 Returns the type of node v. More...
 
Graph::NodeTypetype (node v)
 Returns the type of node v. More...
 
int idNode (node v) const
 Returns the user ID of node v. More...
 
int & idNode (node v)
 Returns the user ID of node v. More...
 
const DPolylinebends (edge e) const
 Returns the list of bend points of edge e. More...
 
DPolylinebends (edge e)
 Returns the list of bend points of edge e. More...
 
EdgeArrow arrowType (edge e) const
 Returns the arrow type of edge e. More...
 
EdgeArrowarrowType (edge e)
 Returns the arrow type of edge e. More...
 
StrokeType strokeType (edge e) const
 Returns the stroke type of edge e. More...
 
StrokeTypestrokeType (edge e)
 Returns the stroke type of edge e. More...
 
const ColorstrokeColor (edge e) const
 Returns the stroke color of edge e. More...
 
ColorstrokeColor (edge e)
 Returns the stroke color of edge e. More...
 
float strokeWidth (edge e) const
 Returns the stroke width of edge e. More...
 
float & strokeWidth (edge e)
 Returns the stroke width of edge e. More...
 
const string & label (edge e) const
 Returns the label of edge e. More...
 
string & label (edge e)
 Returns the label of edge e. More...
 
int intWeight (edge e) const
 Returns the (integer) weight of edge e. More...
 
int & intWeight (edge e)
 Returns the (integer) weight of edge e. More...
 
double doubleWeight (edge e) const
 Returns the (real number) weight of edge e. More...
 
double & doubleWeight (edge e)
 Returns the (real number) weight of edge e. More...
 
Graph::EdgeType type (edge e) const
 Returns the type of edge e. More...
 
Graph::EdgeTypetype (edge e)
 Returns the type of edge e. More...
 
uint32_t subGraphBits (edge e) const
 Returns the edgesubgraph value of an edge e. More...
 
uint32_t & subGraphBits (edge e)
 Returns the edgesubgraph value of an edge e. More...
 
bool inSubGraph (edge e, int n) const
 Checks whether edge e belongs to basic graph n. More...
 
void addSubGraph (edge e, int n)
 Adds edge e to basic graph n. More...
 
void removeSubGraph (edge e, int n)
 Removes edge e from basic graph n. More...
 
virtual void scale (double s, bool scaleNodes=true)
 Scales the layout by s. More...
 
virtual void translateToNonNeg ()
 Translates the layout such that the lower left corner is at (0,0). More...
 
virtual void flipVertical ()
 Flips the layout vertically within its bounding box. More...
 
virtual void flipHorizontal ()
 Flips the layout horizontally within its bounding box. More...
 
virtual void scaleAndTranslate (double sx, double sy, double dx, double dy, bool scaleNodes=true)
 Scales the layout by (sx,sy) and then translates it by (dx,dy). More...
 
virtual void scaleAndTranslate (double s, double dx, double dy, bool scaleNodes=true)
 Scales the layout by s and then translates it by (dx,dy). More...
 
virtual void rotateRight90 ()
 Rotates the layout by 90 degree (in clockwise direction) around the origin. More...
 
virtual void rotateLeft90 ()
 Rotates the layout by 90 degree (in counter-clockwise direction) around the origin. More...
 
DPoint point (node v) const
 Returns a DPoint corresponding to the x- and y-coordinates of v. More...
 
void transferToOriginal (GraphAttributes &origAttr) const
 Copies attributes of this to origAttr. More...
 
void transferToCopy (GraphAttributes &copyAttr) const
 Copies attributes of this to copyAttr. More...
 
template<class Rectangle = DRect>
void nodeBoundingBoxes (NodeArray< Rectangle > &boundingBoxes) const
 Computes the bounding rectangle for each node. More...
 
void setAllWidth (double w)
 Sets the width of all nodes to w. More...
 
void setAllHeight (double h)
 Sets the height of all nodes to h. More...
 
void clearAllBends ()
 Removes all edge bends. More...
 
void removeUnnecessaryBendsHV ()
 Removes unnecessary bend points in orthogonal segements. More...
 
void addNodeCenter2Bends (int mode=1)
 Adds additional bend points to all edges for connecting their endpoints. More...
 
bool isAssociationClass (node v) const
 Returns true iff v represents an association class. More...
 
int hierarchyList (List< List< node > * > &list) const
 Returns a list of all inheritance hierarchies in the graph. More...
 
int hierarchyList (List< List< edge > * > &list) const
 Returns a list of all inheritance hierarchies in the graph. More...
 

Static Public Attributes

Flags for enabling attributes
static const long clusterGraphics
 Corresponds to cluster attributes x(cluster), y(cluster), width(cluster), height(cluster). More...
 
static const long clusterStyle
 Corresponds to cluster attributes strokeColor(cluster), strokeType(cluster), strokeWidth(cluster), fillPattern(cluster), fillColor(cluster), and fillBgColor(cluster). More...
 
static const long clusterLabel
 Corresponds to cluster attribute label(cluster). More...
 
static const long clusterTemplate
 Corresponds to cluster attribute templateCluster(cluster). More...
 
static const long all
 Enables all available flags. More...
 
- Static Public Attributes inherited from ogdf::GraphAttributes
static const long nodeGraphics
 Corresponds to node attributes x(node), y(node), width(node), height(node), and shape(node). More...
 
static const long edgeGraphics
 Corresponds to edge attribute bends(edge). More...
 
static const long edgeIntWeight
 Corresponds to edge attribute intWeight(edge). More...
 
static const long edgeDoubleWeight
 Corresponds to edge attribute doubleWeight(edge). More...
 
static const long edgeLabel
 Corresponds to edge attribute label(edge). More...
 
static const long nodeLabel
 Corresponds to node attribute label(node). More...
 
static const long edgeType
 Corresponds to edge attribute type(edge). More...
 
static const long nodeType
 Corresponds to node attribute type(node). More...
 
static const long nodeId
 Corresponds to node attribute idNode(node). More...
 
static const long edgeArrow
 Corresponds to edge attribute arrowType(edge). More...
 
static const long edgeStyle
 Corresponds to edge attributes strokeColor(edge), strokeType(edge), and strokeWidth(edge). More...
 
static const long nodeStyle
 Corresponds to node attributes strokeColor(node), strokeType(node), strokeWidth(node), fillPattern(node), fillColor(node), and fillBgColor(node). More...
 
static const long nodeTemplate
 Corresponds to node attribute templateNode(node). More...
 
static const long edgeSubGraphs
 Corresponds to edge attributes modified by addSubGraph(edge, int), inSubGraph(edge, int) const, and removeSubGraph(edge, int). More...
 
static const long nodeWeight
 Corresponds to node attribute weight(node). More...
 
static const long threeD
 Corresponds to node attribute z(node). Note that all methods work on 2D coordinates only. More...
 
static const long nodeLabelPosition
 Corresponds to node attributes xLabel(node), yLabel(node), and zLabel(node). More...
 
static const long all
 Enables all available flags. More...
 

Protected Attributes

ClusterArray< string > m_clusterTemplate
 Name of cluster template. More...
 
ClusterArray< Fillm_fill
 Fill (style of interior) More...
 
ClusterArray< double > m_height
 Cluster height. More...
 
ClusterArray< string > m_label
 Cluster label. More...
 
const ClusterGraphm_pClusterGraph
 Only points to existing graphs. More...
 
ClusterArray< Strokem_stroke
 Stroke (style of boundary) More...
 
ClusterArray< double > m_width
 Cluster width. More...
 
ClusterArray< double > m_x
 X-position of lower left corner. More...
 
ClusterArray< double > m_y
 Y-position of lower left corner. More...
 
- Protected Attributes inherited from ogdf::GraphAttributes
long m_attributes
 bit vector of currently used attributes More...
 
EdgeArray< DPolylinem_bends
 list of bend points of an edge More...
 
bool m_directed
 whether or not the graph is directed More...
 
EdgeArray< double > m_doubleWeight
 (real number) weight of an edge More...
 
EdgeArray< EdgeArrowm_edgeArrow
 arrow type of an edge More...
 
EdgeArray< string > m_edgeLabel
 label of an edge More...
 
EdgeArray< Strokem_edgeStroke
 stroke of an edge More...
 
EdgeArray< Graph::EdgeTypem_eType
 type of an edge (association or generalization) More...
 
NodeArray< double > m_height
 height of a nodes's bounding box More...
 
EdgeArray< int > m_intWeight
 (integer) weight of an edge More...
 
NodeArray< Fillm_nodeFill
 fill of a node More...
 
NodeArray< int > m_nodeId
 user ID of a node More...
 
NodeArray< int > m_nodeIntWeight
 (integer) weight of a node More...
 
NodeArray< string > m_nodeLabel
 label of a node More...
 
NodeArray< double > m_nodeLabelPosX
 x-coordinate of a node label More...
 
NodeArray< double > m_nodeLabelPosY
 y-coordinate of a node label More...
 
NodeArray< double > m_nodeLabelPosZ
 z-coordinate of a node label More...
 
NodeArray< Shapem_nodeShape
 shape of a node More...
 
NodeArray< Strokem_nodeStroke
 stroke of a node More...
 
NodeArray< string > m_nodeTemplate
 name of template of a node More...
 
const Graphm_pGraph
 associated graph More...
 
EdgeArray< uint32_t > m_subGraph
 is element of subgraphs given by bitvector More...
 
NodeArray< Graph::NodeTypem_vType
 type (vertex, dummy, generalizationMerger) More...
 
NodeArray< double > m_width
 width of a node's bounding box More...
 
NodeArray< double > m_x
 x-coordinate of a node More...
 
NodeArray< double > m_y
 y-coordinate of a node More...
 
NodeArray< double > m_z
 z-coordinate of a node More...
 

Construction and management of attributes

 ClusterGraphAttributes ()
 Constructs cluster graph attributes for no associated graph. More...
 
 ClusterGraphAttributes (const ClusterGraph &cg, long initAttributes=nodeGraphics|edgeGraphics|clusterGraphics)
 Constructs cluster graph attributes for cluster graph cg with attributes initAttributes. More...
 
virtual ~ClusterGraphAttributes ()
 
void init (ClusterGraph &cg, long attr=0)
 Initializes the ClusterGraphAttributes for ClusterGraph cg. More...
 
void init (long attr=0)
 Re-initializes the ClusterGraphAttributes while maintaining the associated CluterGraph. More...
 
void addAttributes (long attr)
 Enables attributes specified by attr and allocates required memory. More...
 
void destroyAttributes (long attr)
 Disables attributes specified by attr and releases available memory. More...
 
const ClusterGraphconstClusterGraph () const
 Returns the associated cluster graph. More...
 
void addClusterAttributes (long attr)
 Add all cluster-related attributes in attr. More...
 
void destroyClusterAttributes (long attr)
 Destroy all cluster-related attributes in attr. More...
 
virtual void init (const Graph &G, long attr)
 Forbidden initialization, use init(ClusterGraph &cg, long initAttributes) instead! More...
 
void init (long attr)
 Forbidden initialization, use init(ClusterGraph &cg, long initAttributes) instead! More...
 

Detailed Description

Stores additional attributes of a clustered graph (like layout information).

Definition at line 47 of file ClusterGraphAttributes.h.

Constructor & Destructor Documentation

◆ ClusterGraphAttributes() [1/2]

ogdf::ClusterGraphAttributes::ClusterGraphAttributes ( )
inline

Constructs cluster graph attributes for no associated graph.

Definition at line 109 of file ClusterGraphAttributes.h.

◆ ClusterGraphAttributes() [2/2]

ogdf::ClusterGraphAttributes::ClusterGraphAttributes ( const ClusterGraph cg,
long  initAttributes = nodeGraphics|edgeGraphics|clusterGraphics 
)
explicit

Constructs cluster graph attributes for cluster graph cg with attributes initAttributes.

◆ ~ClusterGraphAttributes()

virtual ogdf::ClusterGraphAttributes::~ClusterGraphAttributes ( )
inlinevirtual

Definition at line 116 of file ClusterGraphAttributes.h.

Member Function Documentation

◆ addAttributes()

void ogdf::ClusterGraphAttributes::addAttributes ( long  attr)

Enables attributes specified by attr and allocates required memory.

◆ addClusterAttributes()

void ogdf::ClusterGraphAttributes::addClusterAttributes ( long  attr)
private

Add all cluster-related attributes in attr.

Precondition
m_attributes already contains attr.

◆ boundingBox()

virtual DRect ogdf::ClusterGraphAttributes::boundingBox ( ) const
overridevirtual

Returns the bounding box of the layout.

Reimplemented from ogdf::GraphAttributes.

◆ clusterOf()

cluster ogdf::ClusterGraphAttributes::clusterOf ( node  v)
inline

Returns the parent cluster of node v.

Definition at line 435 of file ClusterGraphAttributes.h.

◆ constClusterGraph()

const ClusterGraph& ogdf::ClusterGraphAttributes::constClusterGraph ( ) const
inline

Returns the associated cluster graph.

Definition at line 156 of file ClusterGraphAttributes.h.

◆ destroyAttributes()

void ogdf::ClusterGraphAttributes::destroyAttributes ( long  attr)

Disables attributes specified by attr and releases available memory.

◆ destroyClusterAttributes()

void ogdf::ClusterGraphAttributes::destroyClusterAttributes ( long  attr)
private

Destroy all cluster-related attributes in attr.

Precondition
m_attributes already contains attr.

◆ fillBgColor() [1/4]

Color& ogdf::ClusterGraphAttributes::fillBgColor ( cluster  c)
inline

Returns the background color of fill patterns for cluster c.

Precondition
clusterStyle is enabled

Definition at line 340 of file ClusterGraphAttributes.h.

◆ fillBgColor() [2/4]

const Color& ogdf::ClusterGraphAttributes::fillBgColor ( cluster  c) const
inline

Returns the background color of fill patterns for cluster c.

Precondition
clusterStyle is enabled

Definition at line 331 of file ClusterGraphAttributes.h.

◆ fillBgColor() [3/4]

Color& ogdf::GraphAttributes::fillBgColor
inline

Returns the background color of fill patterns for node v.

Precondition
nodeStyle is enabled

Definition at line 577 of file GraphAttributes.h.

◆ fillBgColor() [4/4]

const Color& ogdf::GraphAttributes::fillBgColor
inline

Returns the background color of fill patterns for node v.

Precondition
nodeStyle is enabled

Definition at line 568 of file GraphAttributes.h.

◆ fillColor() [1/4]

Color& ogdf::ClusterGraphAttributes::fillColor ( cluster  c)
inline

Returns the fill color of cluster c.

Precondition
clusterStyle is enabled

Definition at line 322 of file ClusterGraphAttributes.h.

◆ fillColor() [2/4]

const Color& ogdf::ClusterGraphAttributes::fillColor ( cluster  c) const
inline

Returns the fill color of cluster c.

Precondition
clusterStyle is enabled

Definition at line 313 of file ClusterGraphAttributes.h.

◆ fillColor() [3/4]

Color& ogdf::GraphAttributes::fillColor
inline

Returns the fill color of node v.

Precondition
nodeStyle is enabled

Definition at line 558 of file GraphAttributes.h.

◆ fillColor() [4/4]

const Color& ogdf::GraphAttributes::fillColor
inline

Returns the fill color of node v.

Precondition
nodeStyle is enabled

Definition at line 549 of file GraphAttributes.h.

◆ fillPattern() [1/4]

FillPattern& ogdf::ClusterGraphAttributes::fillPattern ( cluster  c)
inline

Returns the fill pattern of cluster c.

Precondition
clusterStyle is enabled

Definition at line 304 of file ClusterGraphAttributes.h.

◆ fillPattern() [2/4]

const FillPattern& ogdf::ClusterGraphAttributes::fillPattern ( cluster  c) const
inline

Returns the fill pattern of cluster c.

Precondition
clusterStyle is enabled

Definition at line 295 of file ClusterGraphAttributes.h.

◆ fillPattern() [3/4]

FillPattern& ogdf::GraphAttributes::fillPattern
inline

Returns the fill pattern of node v.

Precondition
nodeStyle is enabled

Definition at line 540 of file GraphAttributes.h.

◆ fillPattern() [4/4]

FillPattern ogdf::GraphAttributes::fillPattern
inline

Returns the fill pattern of node v.

Precondition
nodeStyle is enabled

Definition at line 531 of file GraphAttributes.h.

◆ flipHorizontal() [1/3]

virtual void ogdf::GraphAttributes::flipHorizontal
inline

Flips the layout horizontally within its bounding box.

If preserving the bounding box is not required, the layout can also be flipped horizontally by calling scale(-1.0, 1.0, false).

Definition at line 981 of file GraphAttributes.h.

◆ flipHorizontal() [2/3]

virtual void ogdf::GraphAttributes::flipHorizontal

Flips the (whole) layout horizontally such that the part in box remains in this area.

The whole layout is flipped and then moved such that the part that was in box before flipping is moved to this area.

◆ flipHorizontal() [3/3]

virtual void ogdf::ClusterGraphAttributes::flipHorizontal ( const DRect box)
overridevirtual

Flips the (whole) layout horizontally such that the part in box remains in this area.

The whole layout is flipped and then moved such that the part that was in box before flipping is moved to this area.

Reimplemented from ogdf::GraphAttributes.

◆ flipVertical() [1/3]

virtual void ogdf::GraphAttributes::flipVertical
inline

Flips the layout vertically within its bounding box.

If preserving the bounding box is not required, the layout can also be flipped vertically by calling scale(1.0, -1.0, false).

Definition at line 967 of file GraphAttributes.h.

◆ flipVertical() [2/3]

virtual void ogdf::GraphAttributes::flipVertical

Flips the (whole) layout vertically such that the part in box remains in this area.

The whole layout is flipped and then moved such that the part that was in box before flipping is moved to this area.

◆ flipVertical() [3/3]

virtual void ogdf::ClusterGraphAttributes::flipVertical ( const DRect box)
overridevirtual

Flips the (whole) layout vertically such that the part in box remains in this area.

The whole layout is flipped and then moved such that the part that was in box before flipping is moved to this area.

Reimplemented from ogdf::GraphAttributes.

◆ height() [1/6]

NodeArray<double>& ogdf::GraphAttributes::height
inline

Returns a reference to the node array m_height.

Precondition
nodeGraphics is enabled

Definition at line 446 of file GraphAttributes.h.

◆ height() [2/6]

const NodeArray<double>& ogdf::GraphAttributes::height
inline

Returns a reference to the node array m_height.

Precondition
nodeGraphics is enabled

Definition at line 437 of file GraphAttributes.h.

◆ height() [3/6]

double& ogdf::ClusterGraphAttributes::height ( cluster  c)
inline

Returns the height of cluster c.

Precondition
clusterGraphics is enabled

Definition at line 232 of file ClusterGraphAttributes.h.

◆ height() [4/6]

double ogdf::ClusterGraphAttributes::height ( cluster  c) const
inline

Returns the height of cluster c.

Precondition
clusterGraphics is enabled

Definition at line 223 of file ClusterGraphAttributes.h.

◆ height() [5/6]

double& ogdf::GraphAttributes::height
inline

Returns the height of the bounding box of node v.

Precondition
nodeGraphics is enabled

Definition at line 427 of file GraphAttributes.h.

◆ height() [6/6]

double ogdf::GraphAttributes::height
inline

Returns the height of the bounding box of node v.

Precondition
nodeGraphics is enabled

Definition at line 418 of file GraphAttributes.h.

◆ init() [1/4]

void ogdf::ClusterGraphAttributes::init ( ClusterGraph cg,
long  attr = 0 
)

Initializes the ClusterGraphAttributes for ClusterGraph cg.

Parameters
cgis the new associated ClusterGraph.
attrspecifies the set of attributes that can be accessed.
Warning
All attributes that were allocated before are destroyed by this function! If you wish to extend the set of allocated attributes, use addAttributes.

◆ init() [2/4]

virtual void ogdf::GraphAttributes::init
private

Forbidden initialization, use init(ClusterGraph &cg, long initAttributes) instead!

◆ init() [3/4]

void ogdf::GraphAttributes::init
private

Forbidden initialization, use init(ClusterGraph &cg, long initAttributes) instead!

◆ init() [4/4]

void ogdf::ClusterGraphAttributes::init ( long  attr = 0)

Re-initializes the ClusterGraphAttributes while maintaining the associated CluterGraph.

See also
init(const ClusterGraph&, long)

◆ label() [1/6]

string& ogdf::ClusterGraphAttributes::label ( cluster  c)
inline

Returns the label of cluster c.

Precondition
clusterLabel is enabled

Definition at line 358 of file ClusterGraphAttributes.h.

◆ label() [2/6]

const string& ogdf::ClusterGraphAttributes::label ( cluster  c) const
inline

Returns the label of cluster c.

Precondition
clusterLabel is enabled

Definition at line 349 of file ClusterGraphAttributes.h.

◆ label() [3/6]

string& ogdf::GraphAttributes::label
inline

Returns the label of edge e.

Precondition
edgeLabel is enabled

Definition at line 806 of file GraphAttributes.h.

◆ label() [4/6]

const string& ogdf::GraphAttributes::label
inline

Returns the label of edge e.

Precondition
edgeLabel is enabled

Definition at line 797 of file GraphAttributes.h.

◆ label() [5/6]

string& ogdf::GraphAttributes::label
inline

Returns the label of node v.

Precondition
nodeLabel is enabled

Definition at line 596 of file GraphAttributes.h.

◆ label() [6/6]

const string& ogdf::GraphAttributes::label
inline

Returns the label of node v.

Precondition
nodeLabel is enabled

Definition at line 587 of file GraphAttributes.h.

◆ scale() [1/3]

virtual void ogdf::GraphAttributes::scale
inline

Definition at line 950 of file GraphAttributes.h.

◆ scale() [2/3]

virtual void ogdf::GraphAttributes::scale

◆ scale() [3/3]

virtual void ogdf::ClusterGraphAttributes::scale ( double  sx,
double  sy,
bool  scaleNodes = true 
)
overridevirtual

Scales the layout by (sx,sy).

If scaleNodes is true, node sizes are scaled as well.

Parameters
sxis the scaling factor for x-coordinates.
syis the scaling factor for y-coordinates.
scaleNodesdetermines if nodes size are scaled as well (true) or not.

Reimplemented from ogdf::GraphAttributes.

◆ strokeColor() [1/6]

Color& ogdf::ClusterGraphAttributes::strokeColor ( cluster  c)
inline

Returns the stroke color of cluster c.

Precondition
clusterStyle is enabled

Definition at line 268 of file ClusterGraphAttributes.h.

◆ strokeColor() [2/6]

const Color& ogdf::ClusterGraphAttributes::strokeColor ( cluster  c) const
inline

Returns the stroke color of cluster c.

Precondition
clusterStyle is enabled

Definition at line 259 of file ClusterGraphAttributes.h.

◆ strokeColor() [3/6]

Color& ogdf::GraphAttributes::strokeColor
inline

Returns the stroke color of edge e.

Precondition
edgeStyle is enabled

Definition at line 768 of file GraphAttributes.h.

◆ strokeColor() [4/6]

const Color& ogdf::GraphAttributes::strokeColor
inline

Returns the stroke color of edge e.

Precondition
edgeStyle is enabled

Definition at line 759 of file GraphAttributes.h.

◆ strokeColor() [5/6]

Color& ogdf::GraphAttributes::strokeColor
inline

Returns the stroke color of node v.

Precondition
nodeStyle is enabled

Definition at line 503 of file GraphAttributes.h.

◆ strokeColor() [6/6]

const Color& ogdf::GraphAttributes::strokeColor
inline

Returns the stroke color of node v.

Precondition
nodeStyle is enabled

Definition at line 494 of file GraphAttributes.h.

◆ strokeType() [1/6]

StrokeType& ogdf::ClusterGraphAttributes::strokeType ( cluster  c)
inline

Returns the stroke type of cluster c.

Precondition
clusterStyle is enabled

Definition at line 250 of file ClusterGraphAttributes.h.

◆ strokeType() [2/6]

const StrokeType& ogdf::ClusterGraphAttributes::strokeType ( cluster  c) const
inline

Returns the stroke type of cluster c.

Precondition
clusterStyle is enabled

Definition at line 241 of file ClusterGraphAttributes.h.

◆ strokeType() [3/6]

StrokeType& ogdf::GraphAttributes::strokeType
inline

Returns the stroke type of edge e.

Precondition
edgeStyle is enabled

Definition at line 749 of file GraphAttributes.h.

◆ strokeType() [4/6]

StrokeType ogdf::GraphAttributes::strokeType
inline

Returns the stroke type of edge e.

Precondition
edgeStyle is enabled

Definition at line 740 of file GraphAttributes.h.

◆ strokeType() [5/6]

StrokeType& ogdf::GraphAttributes::strokeType
inline

Returns the stroke type of node v.

Precondition
nodeStyle is enabled

Definition at line 484 of file GraphAttributes.h.

◆ strokeType() [6/6]

StrokeType ogdf::GraphAttributes::strokeType
inline

Returns the stroke type of node v.

Precondition
nodeStyle is enabled

Definition at line 475 of file GraphAttributes.h.

◆ strokeWidth() [1/6]

float& ogdf::ClusterGraphAttributes::strokeWidth ( cluster  c)
inline

Returns the stroke width of cluster c.

Precondition
clusterStyle is enabled

Definition at line 286 of file ClusterGraphAttributes.h.

◆ strokeWidth() [2/6]

const float& ogdf::ClusterGraphAttributes::strokeWidth ( cluster  c) const
inline

Returns the stroke width of cluster c.

Precondition
clusterStyle is enabled

Definition at line 277 of file ClusterGraphAttributes.h.

◆ strokeWidth() [3/6]

float& ogdf::GraphAttributes::strokeWidth
inline

Returns the stroke width of edge e.

Precondition
edgeStyle is enabled

Definition at line 787 of file GraphAttributes.h.

◆ strokeWidth() [4/6]

float ogdf::GraphAttributes::strokeWidth
inline

Returns the stroke width of edge e.

Precondition
edgeStyle is enabled

Definition at line 778 of file GraphAttributes.h.

◆ strokeWidth() [5/6]

float& ogdf::GraphAttributes::strokeWidth
inline

Returns the stroke width of node v.

Precondition
nodeStyle is enabled

Definition at line 522 of file GraphAttributes.h.

◆ strokeWidth() [6/6]

float ogdf::GraphAttributes::strokeWidth
inline

Returns the stroke width of node v.

Precondition
nodeStyle is enabled

Definition at line 513 of file GraphAttributes.h.

◆ templateCluster() [1/2]

string& ogdf::ClusterGraphAttributes::templateCluster ( cluster  c)
inline

Returns the template of cluster c.

Precondition
clusterTemplate is enabled

Definition at line 376 of file ClusterGraphAttributes.h.

◆ templateCluster() [2/2]

const string& ogdf::ClusterGraphAttributes::templateCluster ( cluster  c) const
inline

Returns the template of cluster c.

Precondition
clusterTemplate is enabled

Definition at line 367 of file ClusterGraphAttributes.h.

◆ translate()

virtual void ogdf::ClusterGraphAttributes::translate ( double  dx,
double  dy 
)
overridevirtual

Translates the layout by (dx,dy).

Parameters
dxis the translation in x-direction.
dyis the translation in y-direction.

Reimplemented from ogdf::GraphAttributes.

◆ updateClusterPositions()

void ogdf::ClusterGraphAttributes::updateClusterPositions ( double  boundaryDist = 1.0)

Updates positions of cluster boundaries wrt to children and child clusters.

◆ width() [1/6]

NodeArray<double>& ogdf::GraphAttributes::width
inline

Returns a reference to the node array #m_width.

Precondition
nodeGraphics is enabled

Definition at line 408 of file GraphAttributes.h.

◆ width() [2/6]

const NodeArray<double>& ogdf::GraphAttributes::width
inline

Returns a reference to the node array m_width.

Precondition
nodeGraphics is enabled

Definition at line 399 of file GraphAttributes.h.

◆ width() [3/6]

double& ogdf::ClusterGraphAttributes::width ( cluster  c)
inline

Returns the width of cluster c.

Precondition
clusterGraphics is enabled

Definition at line 214 of file ClusterGraphAttributes.h.

◆ width() [4/6]

double ogdf::ClusterGraphAttributes::width ( cluster  c) const
inline

Returns the width of cluster c.

Precondition
clusterGraphics is enabled

Definition at line 205 of file ClusterGraphAttributes.h.

◆ width() [5/6]

double& ogdf::GraphAttributes::width
inline

Returns the width of the bounding box of node v.

Precondition
nodeGraphics is enabled

Definition at line 389 of file GraphAttributes.h.

◆ width() [6/6]

double ogdf::GraphAttributes::width
inline

Returns the width of the bounding box of node v.

Precondition
nodeGraphics is enabled

Definition at line 380 of file GraphAttributes.h.

◆ x() [1/4]

double& ogdf::ClusterGraphAttributes::x ( cluster  c)
inline

Returns the x-position of cluster c's cage (lower left corner).

Precondition
clusterGraphics is enabled

Definition at line 178 of file ClusterGraphAttributes.h.

◆ x() [2/4]

double ogdf::ClusterGraphAttributes::x ( cluster  c) const
inline

Returns the x-position of cluster c's cage (lower left corner).

Precondition
clusterGraphics is enabled

Definition at line 169 of file ClusterGraphAttributes.h.

◆ x() [3/4]

double& ogdf::GraphAttributes::x
inline

Returns the x-coordinate of node v.

Precondition
nodeGraphics is enabled

Definition at line 271 of file GraphAttributes.h.

◆ x() [4/4]

double ogdf::GraphAttributes::x
inline

Returns the x-coordinate of node v.

Precondition
nodeGraphics is enabled

Definition at line 261 of file GraphAttributes.h.

◆ y() [1/4]

double& ogdf::ClusterGraphAttributes::y ( cluster  c)
inline

Returns the y-position of cluster c's cage (lower left corner).

Precondition
clusterGraphics is enabled

Definition at line 196 of file ClusterGraphAttributes.h.

◆ y() [2/4]

double ogdf::ClusterGraphAttributes::y ( cluster  c) const
inline

Returns the y-position of cluster c's cage (lower left corner).

Precondition
clusterGraphics is enabled

Definition at line 187 of file ClusterGraphAttributes.h.

◆ y() [3/4]

double& ogdf::GraphAttributes::y
inline

Returns the y-coordinate of node v.

Precondition
nodeGraphics is enabled

Definition at line 291 of file GraphAttributes.h.

◆ y() [4/4]

double ogdf::GraphAttributes::y
inline

Returns the y-coordinate of node v.

Precondition
nodeGraphics is enabled

Definition at line 281 of file GraphAttributes.h.

Member Data Documentation

◆ all

const long ogdf::ClusterGraphAttributes::all
static

Enables all available flags.

Definition at line 83 of file ClusterGraphAttributes.h.

◆ clusterGraphics

const long ogdf::ClusterGraphAttributes::clusterGraphics
static

Corresponds to cluster attributes x(cluster), y(cluster), width(cluster), height(cluster).

Definition at line 69 of file ClusterGraphAttributes.h.

◆ clusterLabel

const long ogdf::ClusterGraphAttributes::clusterLabel
static

Corresponds to cluster attribute label(cluster).

Definition at line 77 of file ClusterGraphAttributes.h.

◆ clusterStyle

const long ogdf::ClusterGraphAttributes::clusterStyle
static

◆ clusterTemplate

const long ogdf::ClusterGraphAttributes::clusterTemplate
static

Corresponds to cluster attribute templateCluster(cluster).

Definition at line 80 of file ClusterGraphAttributes.h.

◆ m_clusterTemplate

ClusterArray<string> ogdf::ClusterGraphAttributes::m_clusterTemplate
protected

Name of cluster template.

Definition at line 59 of file ClusterGraphAttributes.h.

◆ m_fill

ClusterArray<Fill> ogdf::ClusterGraphAttributes::m_fill
protected

Fill (style of interior)

Definition at line 58 of file ClusterGraphAttributes.h.

◆ m_height

ClusterArray<double> ogdf::ClusterGraphAttributes::m_height
protected

Cluster height.

Definition at line 55 of file ClusterGraphAttributes.h.

◆ m_label

ClusterArray<string> ogdf::ClusterGraphAttributes::m_label
protected

Cluster label.

Definition at line 56 of file ClusterGraphAttributes.h.

◆ m_pClusterGraph

const ClusterGraph* ogdf::ClusterGraphAttributes::m_pClusterGraph
protected

Only points to existing graphs.

Definition at line 50 of file ClusterGraphAttributes.h.

◆ m_stroke

ClusterArray<Stroke> ogdf::ClusterGraphAttributes::m_stroke
protected

Stroke (style of boundary)

Definition at line 57 of file ClusterGraphAttributes.h.

◆ m_width

ClusterArray<double> ogdf::ClusterGraphAttributes::m_width
protected

Cluster width.

Definition at line 54 of file ClusterGraphAttributes.h.

◆ m_x

ClusterArray<double> ogdf::ClusterGraphAttributes::m_x
protected

X-position of lower left corner.

Definition at line 52 of file ClusterGraphAttributes.h.

◆ m_y

ClusterArray<double> ogdf::ClusterGraphAttributes::m_y
protected

Y-position of lower left corner.

Definition at line 53 of file ClusterGraphAttributes.h.


The documentation for this class was generated from the following file: