Inheritance diagram for pcbnew.COLOR4D:

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

def	__init__ (self, *args)

def	SetFromWxString (self, aColorString)

def	ToCSSString (self)

def	SetFromHexString (self, aColorString)

def	ToHexString (self)

def	ToColour (self)

def	LegacyMix (self, aColor)

def	ToHSL (self, aOutHue, aOutSaturation, aOutValue)

def	FromHSL (self, aInHue, aInSaturation, aInLightness)

def	Brighten (self, aFactor)

def	Darken (self, aFactor)

def	Invert (self)

def	Saturate (self, aFactor)

def	Desaturate (self)

def	Brightened (self, aFactor)

def	Darkened (self, aFactor)

def	Mix (self, aColor, aFactor)

def	WithAlpha (self, aAlpha)

def	Inverted (self)

def	GetBrightness (self)

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

def	FromHSV (self, aInH, aInS, aInV)

def	Distance (self, other)

def	Compare (self, aRhs)

Static Public Member Functions
def	FindNearestLegacyColor (aR, aG, aB)

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=)

Detailed Description

Proxy of C++ KIGFX::COLOR4D class.

Definition at line 2423 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def 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 2433 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Brighten()

def pcbnew.COLOR4D.Brighten	(	self,
		aFactor
	)

Brighten(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2475 of file pcbnew.py.

◆ Brightened()

def pcbnew.COLOR4D.Brightened	(	self,
		aFactor
	)

Brightened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2495 of file pcbnew.py.

◆ Compare()

def pcbnew.COLOR4D.Compare	(	self,
		aRhs
	)

Compare(COLOR4D self, COLOR4D aRhs) -> int

Definition at line 2531 of file pcbnew.py.

◆ Darken()

def pcbnew.COLOR4D.Darken	(	self,
		aFactor
	)

Darken(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2479 of file pcbnew.py.

◆ Darkened()

def pcbnew.COLOR4D.Darkened	(	self,
		aFactor
	)

Darkened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2499 of file pcbnew.py.

◆ Desaturate()

def pcbnew.COLOR4D.Desaturate ( self )

Desaturate(COLOR4D self) -> COLOR4D

Definition at line 2491 of file pcbnew.py.

◆ Distance()

def pcbnew.COLOR4D.Distance	(	self,
		other
	)

Distance(COLOR4D self, COLOR4D other) -> double

Definition at line 2527 of file pcbnew.py.

◆ FindNearestLegacyColor()

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

static

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

Definition at line 2536 of file pcbnew.py.

◆ FromCSSRGBA()

def 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 2429 of file pcbnew.py.

◆ FromHSL()

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

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

Definition at line 2471 of file pcbnew.py.

◆ FromHSV()

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

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

Definition at line 2523 of file pcbnew.py.

◆ GetBrightness()

def pcbnew.COLOR4D.GetBrightness ( self )

GetBrightness(COLOR4D self) -> double

Definition at line 2515 of file pcbnew.py.

◆ Invert()

def pcbnew.COLOR4D.Invert ( self )

Invert(COLOR4D self) -> COLOR4D

Definition at line 2483 of file pcbnew.py.

◆ Inverted()

def pcbnew.COLOR4D.Inverted ( self )

Inverted(COLOR4D self) -> COLOR4D

Definition at line 2511 of file pcbnew.py.

◆ LegacyMix()

def pcbnew.COLOR4D.LegacyMix	(	self,
		aColor
	)

LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D

Definition at line 2463 of file pcbnew.py.

◆ Mix()

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

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

Definition at line 2503 of file pcbnew.py.

◆ Saturate()

def pcbnew.COLOR4D.Saturate	(	self,
		aFactor
	)

Saturate(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2487 of file pcbnew.py.

◆ SetFromHexString()

def pcbnew.COLOR4D.SetFromHexString	(	self,
		aColorString
	)

SetFromHexString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2451 of file pcbnew.py.

◆ SetFromWxString()

def pcbnew.COLOR4D.SetFromWxString	(	self,
		aColorString
	)

SetFromWxString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2443 of file pcbnew.py.

◆ ToColour()

def pcbnew.COLOR4D.ToColour ( self )

ToColour(COLOR4D self) -> wxColour

Definition at line 2459 of file pcbnew.py.

◆ ToCSSString()

def pcbnew.COLOR4D.ToCSSString ( self )

ToCSSString(COLOR4D self) -> wxString

Definition at line 2447 of file pcbnew.py.

◆ ToHexString()

def pcbnew.COLOR4D.ToHexString ( self )

ToHexString(COLOR4D self) -> wxString

Definition at line 2455 of file pcbnew.py.

◆ ToHSL()

def pcbnew.COLOR4D.ToHSL	(	self,
		aOutHue,
		aOutSaturation,
		aOutValue
	)

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

Definition at line 2467 of file pcbnew.py.

◆ ToHSV()

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

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

Definition at line 2519 of file pcbnew.py.

◆ WithAlpha()

def pcbnew.COLOR4D.WithAlpha	(	self,
		aAlpha
	)

WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D

Definition at line 2507 of file pcbnew.py.

Property Documentation

◆ a

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

static

Definition at line 2542 of file pcbnew.py.

◆ b

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

static

Definition at line 2541 of file pcbnew.py.

◆ g

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

static

Definition at line 2540 of file pcbnew.py.

◆ r

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

static

Definition at line 2539 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 2426 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ Brighten()

◆ Brightened()

◆ Compare()

◆ Darken()

◆ Darkened()

◆ Desaturate()

◆ Distance()

◆ FindNearestLegacyColor()

◆ FromCSSRGBA()

◆ FromHSL()

◆ FromHSV()

◆ GetBrightness()

◆ Invert()

◆ Inverted()

◆ LegacyMix()

◆ Mix()

◆ Saturate()

◆ SetFromHexString()

◆ SetFromWxString()

◆ ToColour()

◆ ToCSSString()

◆ ToHexString()

◆ ToHSL()

◆ ToHSV()

◆ WithAlpha()

Property Documentation

◆ a

◆ b

◆ g

◆ r

◆ thisown

◆ init()