QgsRandomColorRamp Class Reference

Totally random color ramp. More...

#include <qgscolorramp.h>

Inheritance diagram for QgsRandomColorRamp:

Public Member Functions
	QgsRandomColorRamp ()=default
	Constructor for QgsRandomColorRamp. More...
QgsRandomColorRamp *	clone () const override
	Creates a clone of the color ramp. More...
QColor	color (double value) const override
	Returns the color corresponding to a specified value. More...
int	count () const override
	Returns number of defined colors, or -1 if undefined. More...
QVariantMap	properties () const override
	Returns a string map containing all the color ramp's properties. More...
virtual void	setTotalColorCount (int colorCount)
	Sets the desired total number of unique colors for the resultant ramp. More...
QString	type () const override
	Returns a string representing the color ramp type. More...
double	value (int index) const override
	Returns relative value between [0,1] of color at specified index. More...
Public Member Functions inherited from QgsColorRamp
virtual	~QgsColorRamp ()=default
virtual void	invert ()
	Inverts the ordering of the color ramp. More...

Static Public Member Functions
static QString	typeString ()
	Returns the string identifier for QgsRandomColorRamp. More...
Static Public Member Functions inherited from QgsColorRamp
static QList< QPair< QString, QString > >	rampTypes ()
	Returns a list of available ramp types, where the first value in each item is the QgsColorRamp::type() string and the second is a user friendly, translated name for the color ramp type. More...

Protected Attributes
QList< QColor >	mPrecalculatedColors
int	mTotalColorCount = 0

Detailed Description

Totally random color ramp.

Returns colors generated at random, but constrained to some hardcoded saturation and value ranges to prevent ugly color generation.

Since

QGIS 3.0

Definition at line 454 of file qgscolorramp.h.

Constructor & Destructor Documentation

QgsRandomColorRamp()

QgsRandomColorRamp::QgsRandomColorRamp ( )

default

Constructor for QgsRandomColorRamp.

Member Function Documentation

clone()

QgsRandomColorRamp * QgsRandomColorRamp::clone ( ) const

overridevirtual

Creates a clone of the color ramp.

Implements QgsColorRamp.

Definition at line 497 of file qgscolorramp.cpp.

color()

QColor QgsRandomColorRamp::color ( double  value ) const

overridevirtual

Returns the color corresponding to a specified value.

Parameters

value

value between [0, 1] inclusive

Returns

color for value

Implements QgsColorRamp.

Definition at line 440 of file qgscolorramp.cpp.

count()

int QgsRandomColorRamp::count ( ) const

overridevirtual

Returns number of defined colors, or -1 if undefined.

Implements QgsColorRamp.

Definition at line 429 of file qgscolorramp.cpp.

properties()

QVariantMap QgsRandomColorRamp::properties ( ) const

overridevirtual

Returns a string map containing all the color ramp's properties.

Implements QgsColorRamp.

Definition at line 502 of file qgscolorramp.cpp.

setTotalColorCount()

void QgsRandomColorRamp::setTotalColorCount ( int  colorCount )

virtual

Sets the desired total number of unique colors for the resultant ramp.

Calling this method pregenerates a set of visually distinct colors which are returned by subsequent calls to color().

Parameters

colorCount

number of unique colors

Since

QGIS 2.5

Definition at line 460 of file qgscolorramp.cpp.

type()

QString QgsRandomColorRamp::type ( ) const

overridevirtual

Returns a string representing the color ramp type.

Implements QgsColorRamp.

Definition at line 492 of file qgscolorramp.cpp.

typeString()

static QString QgsRandomColorRamp::typeString ( )

inlinestatic

Returns the string identifier for QgsRandomColorRamp.

Since

QGIS 3.16

Definition at line 483 of file qgscolorramp.h.

value()

double QgsRandomColorRamp::value ( int  index ) const

overridevirtual

Returns relative value between [0,1] of color at specified index.

Implements QgsColorRamp.

Definition at line 434 of file qgscolorramp.cpp.

Member Data Documentation

mPrecalculatedColors

QList<QColor> QgsRandomColorRamp::mPrecalculatedColors

protected

Definition at line 494 of file qgscolorramp.h.

mTotalColorCount

int QgsRandomColorRamp::mTotalColorCount = 0

protected

Definition at line 493 of file qgscolorramp.h.

---

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

• /build/qgis-3.18.1+99unstable/src/core/qgscolorramp.h
• /build/qgis-3.18.1+99unstable/src/core/qgscolorramp.cpp