Inheritance diagram for pcbnew.COLOR4D:

Public Member Functions
	FromCSSRGBA (self, aRed, aGreen, aBlue, aAlpha=1.0)

	__init__ (self, *args)

	SetFromWxString (self, aColorString)

	ToCSSString (self)

	SetFromHexString (self, aColorString)

	ToHexString (self)

	ToColour (self)

	LegacyMix (self, aColor)

	ToHSL (self, aOutHue, aOutSaturation, aOutLightness)

	FromHSL (self, aInHue, aInSaturation, aInLightness)

	Brighten (self, aFactor)

	Darken (self, aFactor)

	Invert (self)

	Saturate (self, aFactor)

	Desaturate (self)

	Brightened (self, aFactor)

	Darkened (self, aFactor)

	Mix (self, aColor, aFactor)

	WithAlpha (self, aAlpha)

	Inverted (self)

	GetBrightness (self)

	ToHSV (self, aOutHue, aOutSaturation, aOutValue, aAlwaysDefineHue=False)

	FromHSV (self, aInH, aInS, aInV)

	Distance (self, other)

	Compare (self, aRhs)

	RelativeLuminance (self)

Static Public Member Functions
	ContrastRatio (aLeft, aRight)

	FindNearestLegacyColor (aR, aG, aB)

Static Public Attributes
	UNSPECIFIED

	WHITE

	BLACK

	CLEAR

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

	r = property(_pcbnew.COLOR4D_r_get, _pcbnew.COLOR4D_r_set, doc=)

	g = property(_pcbnew.COLOR4D_g_get, _pcbnew.COLOR4D_g_set, doc=)

	b = property(_pcbnew.COLOR4D_b_get, _pcbnew.COLOR4D_b_set, doc=)

	a = property(_pcbnew.COLOR4D_a_get, _pcbnew.COLOR4D_a_set, doc=)

	m_text = property(_pcbnew.COLOR4D_m_text_get, _pcbnew.COLOR4D_m_text_set, doc=)

Detailed Description

Proxy of C++ KIGFX::COLOR4D class.

Definition at line 2328 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

pcbnew.COLOR4D.__init__	(		self,
		*	args )

    __init__(COLOR4D self) -> COLOR4D
    __init__(COLOR4D self, double aRed, double aGreen, double aBlue, double aAlpha) -> COLOR4D
    __init__(COLOR4D self, EDA_COLOR_T aColor) -> COLOR4D
    __init__(COLOR4D self, wxString aColorStr) -> COLOR4D
    __init__(COLOR4D self, wxColour const & aColor) -> COLOR4D

Definition at line 2338 of file pcbnew.py.

Member Function Documentation

◆ Brighten()

pcbnew.COLOR4D.Brighten	(		self,
			aFactor )

Brighten(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2380 of file pcbnew.py.

◆ Brightened()

pcbnew.COLOR4D.Brightened	(		self,
			aFactor )

Brightened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2400 of file pcbnew.py.

◆ Compare()

pcbnew.COLOR4D.Compare	(		self,
			aRhs )

Compare(COLOR4D self, COLOR4D aRhs) -> int

Definition at line 2436 of file pcbnew.py.

◆ ContrastRatio()

pcbnew.COLOR4D.ContrastRatio	(		aLeft,
			aRight )

static

ContrastRatio(COLOR4D aLeft, COLOR4D aRight) -> double

Definition at line 2445 of file pcbnew.py.

◆ Darken()

pcbnew.COLOR4D.Darken	(		self,
			aFactor )

Darken(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2384 of file pcbnew.py.

◆ Darkened()

pcbnew.COLOR4D.Darkened	(		self,
			aFactor )

Darkened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2404 of file pcbnew.py.

◆ Desaturate()

pcbnew.COLOR4D.Desaturate ( self )

Desaturate(COLOR4D self) -> COLOR4D

Definition at line 2396 of file pcbnew.py.

◆ Distance()

pcbnew.COLOR4D.Distance	(		self,
			other )

Distance(COLOR4D self, COLOR4D other) -> double

Definition at line 2432 of file pcbnew.py.

◆ FindNearestLegacyColor()

pcbnew.COLOR4D.FindNearestLegacyColor	(	aR,
		aG,
		aB )

static

FindNearestLegacyColor(int aR, int aG, int aB) -> EDA_COLOR_T

Definition at line 2450 of file pcbnew.py.

◆ FromCSSRGBA()

pcbnew.COLOR4D.FromCSSRGBA	(	self,
		aRed,
		aGreen,
		aBlue,
		aAlpha = 1.0 )

FromCSSRGBA(COLOR4D self, int aRed, int aGreen, int aBlue, double aAlpha=1.0) -> COLOR4D

Definition at line 2334 of file pcbnew.py.

◆ FromHSL()

pcbnew.COLOR4D.FromHSL	(	self,
		aInHue,
		aInSaturation,
		aInLightness )

FromHSL(COLOR4D self, double aInHue, double aInSaturation, double aInLightness)

Definition at line 2376 of file pcbnew.py.

◆ FromHSV()

pcbnew.COLOR4D.FromHSV	(	self,
		aInH,
		aInS,
		aInV )

FromHSV(COLOR4D self, double aInH, double aInS, double aInV)

Definition at line 2428 of file pcbnew.py.

◆ GetBrightness()

pcbnew.COLOR4D.GetBrightness ( self )

GetBrightness(COLOR4D self) -> double

Definition at line 2420 of file pcbnew.py.

◆ Invert()

pcbnew.COLOR4D.Invert ( self )

Invert(COLOR4D self) -> COLOR4D

Definition at line 2388 of file pcbnew.py.

◆ Inverted()

pcbnew.COLOR4D.Inverted ( self )

Inverted(COLOR4D self) -> COLOR4D

Definition at line 2416 of file pcbnew.py.

◆ LegacyMix()

pcbnew.COLOR4D.LegacyMix	(		self,
			aColor )

LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D

Definition at line 2368 of file pcbnew.py.

◆ Mix()

pcbnew.COLOR4D.Mix	(	self,
		aColor,
		aFactor )

Mix(COLOR4D self, COLOR4D aColor, double aFactor) -> COLOR4D

Definition at line 2408 of file pcbnew.py.

◆ RelativeLuminance()

pcbnew.COLOR4D.RelativeLuminance ( self )

RelativeLuminance(COLOR4D self) -> double

Definition at line 2440 of file pcbnew.py.

◆ Saturate()

pcbnew.COLOR4D.Saturate	(		self,
			aFactor )

Saturate(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2392 of file pcbnew.py.

◆ SetFromHexString()

pcbnew.COLOR4D.SetFromHexString	(		self,
			aColorString )

SetFromHexString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2356 of file pcbnew.py.

◆ SetFromWxString()

pcbnew.COLOR4D.SetFromWxString	(		self,
			aColorString )

SetFromWxString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2348 of file pcbnew.py.

◆ ToColour()

pcbnew.COLOR4D.ToColour ( self )

ToColour(COLOR4D self) -> wxColour

Definition at line 2364 of file pcbnew.py.

◆ ToCSSString()

pcbnew.COLOR4D.ToCSSString ( self )

ToCSSString(COLOR4D self) -> wxString

Definition at line 2352 of file pcbnew.py.

◆ ToHexString()

pcbnew.COLOR4D.ToHexString ( self )

ToHexString(COLOR4D self) -> wxString

Definition at line 2360 of file pcbnew.py.

◆ ToHSL()

pcbnew.COLOR4D.ToHSL	(	self,
		aOutHue,
		aOutSaturation,
		aOutLightness )

ToHSL(COLOR4D self, double & aOutHue, double & aOutSaturation, double & aOutLightness)

Definition at line 2372 of file pcbnew.py.

◆ ToHSV()

pcbnew.COLOR4D.ToHSV	(	self,
		aOutHue,
		aOutSaturation,
		aOutValue,
		aAlwaysDefineHue = False )

ToHSV(COLOR4D self, double & aOutHue, double & aOutSaturation, double & aOutValue, bool aAlwaysDefineHue=False)

Definition at line 2424 of file pcbnew.py.

◆ WithAlpha()

pcbnew.COLOR4D.WithAlpha	(		self,
			aAlpha )

WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D

Definition at line 2412 of file pcbnew.py.

Member Data Documentation

◆ BLACK

pcbnew.COLOR4D.BLACK

static

Definition at line 2464 of file pcbnew.py.

◆ CLEAR

pcbnew.COLOR4D.CLEAR

static

Definition at line 2465 of file pcbnew.py.

◆ UNSPECIFIED

pcbnew.COLOR4D.UNSPECIFIED

static

Definition at line 2462 of file pcbnew.py.

◆ WHITE

pcbnew.COLOR4D.WHITE

static

Definition at line 2463 of file pcbnew.py.

Property Documentation

◆ a

pcbnew.COLOR4D.a = property(_pcbnew.COLOR4D_a_get, _pcbnew.COLOR4D_a_set, doc=)

static

Definition at line 2456 of file pcbnew.py.

◆ b

pcbnew.COLOR4D.b = property(_pcbnew.COLOR4D_b_get, _pcbnew.COLOR4D_b_set, doc=)

static

Definition at line 2455 of file pcbnew.py.

◆ g

pcbnew.COLOR4D.g = property(_pcbnew.COLOR4D_g_get, _pcbnew.COLOR4D_g_set, doc=)

static

Definition at line 2454 of file pcbnew.py.

◆ m_text

pcbnew.COLOR4D.m_text = property(_pcbnew.COLOR4D_m_text_get, _pcbnew.COLOR4D_m_text_set, doc=)

static

Definition at line 2457 of file pcbnew.py.

◆ r

pcbnew.COLOR4D.r = property(_pcbnew.COLOR4D_r_get, _pcbnew.COLOR4D_r_set, doc=)

static

Definition at line 2453 of file pcbnew.py.

◆ thisown

pcbnew.COLOR4D.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 2331 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ Brighten()

◆ Brightened()

◆ Compare()

◆ ContrastRatio()

◆ Darken()

◆ Darkened()

◆ Desaturate()

◆ Distance()

◆ FindNearestLegacyColor()

◆ FromCSSRGBA()

◆ FromHSL()

◆ FromHSV()

◆ GetBrightness()

◆ Invert()

◆ Inverted()

◆ LegacyMix()

◆ Mix()

◆ RelativeLuminance()

◆ Saturate()

◆ SetFromHexString()

◆ SetFromWxString()

◆ ToColour()

◆ ToCSSString()

◆ ToHexString()

◆ ToHSL()

◆ ToHSV()

◆ WithAlpha()

Member Data Documentation

◆ BLACK

◆ CLEAR

◆ UNSPECIFIED

◆ WHITE

Property Documentation

◆ a

◆ b

◆ g

◆ m_text

◆ r

◆ thisown

◆ init()