Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::SimDrawColorizer Class Reference

Adds color to a graph. More...

#include <ogdf/simultaneous/SimDrawColorizer.h>

+ Inheritance diagram for ogdf::SimDrawColorizer:

Classes

class  SimDrawColorScheme
 Manages the various color schemes. More...
 

Public Types

enum  colorScheme { colorScheme::none, colorScheme::bluYel, colorScheme::redGre, colorScheme::bluOra, colorScheme::teaLil, colorScheme::redBluYel, colorScheme::greLilOra }
 types for colorschemes More...
 

Public Member Functions

 SimDrawColorizer (SimDraw &SD)
 constructor assigns default color scheme More...
 
void addColor ()
 adds some color to a graph More...
 
void addColorNodeVersion ()
 adds color to a graph including nodes More...
 
colorSchemeColorScheme ()
 assigns a new color scheme More...
 
const colorSchemeColorScheme () const
 returns current color scheme More...
 
- Public Member Functions inherited from ogdf::SimDrawManipulatorModule
 SimDrawManipulatorModule ()
 default constructor More...
 
 SimDrawManipulatorModule (SimDraw &SD)
 constructor More...
 
const SimDrawconstSimDraw () const
 returns base instance More...
 
void init (SimDraw &SD)
 initializing base instance More...
 

Private Attributes

colorScheme m_colorScheme
 stores the current colorscheme More...
 

Additional Inherited Members

- Protected Attributes inherited from ogdf::SimDrawManipulatorModule
Graphm_G
 pointer to current graph More...
 
GraphAttributesm_GA
 pointer to current graphattributes More...
 
SimDrawm_SD
 pointer to current simdraw instance More...
 

Detailed Description

Adds color to a graph.

SimDrawColorizer adds colors to the edges (and nodes) of a simdraw instance. The underlying color scheme sets the used colors. Some color schemes are only usable for a small number of basic graphs.

A typical use of SimDrawColorizer involves a predefined SimDraw instance on which SimDrawColorizer works.

SimDraw SD;
[...]
SDC.addColor();
[...]

Definition at line 54 of file SimDrawColorizer.h.

Member Enumeration Documentation

◆ colorScheme

types for colorschemes

Enumerator
none 

<= 32 different colors

bluYel 

blue and yellow <= 2 colors

redGre 

red and green <= 2 colors

bluOra 

blue and orange <= 2 colors

teaLil 

teal and purple <= 2 colors

redBluYel 

red, blue and yellow <= 3 colors

greLilOra 

green, purple and orange <= 3 colors

Definition at line 59 of file SimDrawColorizer.h.

Constructor & Destructor Documentation

◆ SimDrawColorizer()

ogdf::SimDrawColorizer::SimDrawColorizer ( SimDraw SD)
inlineexplicit

constructor assigns default color scheme

Definition at line 76 of file SimDrawColorizer.h.

Member Function Documentation

◆ addColor()

void ogdf::SimDrawColorizer::addColor ( )

adds some color to a graph

◆ addColorNodeVersion()

void ogdf::SimDrawColorizer::addColorNodeVersion ( )

adds color to a graph including nodes

◆ ColorScheme() [1/2]

colorScheme& ogdf::SimDrawColorizer::ColorScheme ( )
inline

assigns a new color scheme

Definition at line 83 of file SimDrawColorizer.h.

◆ ColorScheme() [2/2]

const colorScheme& ogdf::SimDrawColorizer::ColorScheme ( ) const
inline

returns current color scheme

Definition at line 80 of file SimDrawColorizer.h.

Member Data Documentation

◆ m_colorScheme

colorScheme ogdf::SimDrawColorizer::m_colorScheme
private

stores the current colorscheme

Definition at line 72 of file SimDrawColorizer.h.


The documentation for this class was generated from the following file:
ogdf::SimDrawColorizer::SimDrawColorizer
SimDrawColorizer(SimDraw &SD)
constructor assigns default color scheme
Definition: SimDrawColorizer.h:76