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, aOutLightness)

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)

def	RelativeLuminance (self)

Static Public Member Functions
def	ContrastRatio (aLeft, aRight)

def	FindNearestLegacyColor (aR, aG, aB)

Static Public Attributes
	UNSPECIFIED

	WHITE

	BLACK

	CLEAR

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

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

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

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

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

Detailed Description

Proxy of C++ KIGFX::COLOR4D class.

Definition at line 2225 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 2235 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 2277 of file pcbnew.py.

◆ Brightened()

def pcbnew.COLOR4D.Brightened	(	self,
		aFactor
	)

Brightened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2297 of file pcbnew.py.

◆ Compare()

def pcbnew.COLOR4D.Compare	(	self,
		aRhs
	)

Compare(COLOR4D self, COLOR4D aRhs) -> int

Definition at line 2333 of file pcbnew.py.

◆ ContrastRatio()

def pcbnew.COLOR4D.ContrastRatio	(	aLeft,
		aRight
	)

static

ContrastRatio(COLOR4D aLeft, COLOR4D aRight) -> double

Definition at line 2342 of file pcbnew.py.

◆ Darken()

def pcbnew.COLOR4D.Darken	(	self,
		aFactor
	)

Darken(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2281 of file pcbnew.py.

◆ Darkened()

def pcbnew.COLOR4D.Darkened	(	self,
		aFactor
	)

Darkened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2301 of file pcbnew.py.

◆ Desaturate()

def pcbnew.COLOR4D.Desaturate ( self )

Desaturate(COLOR4D self) -> COLOR4D

Definition at line 2293 of file pcbnew.py.

◆ Distance()

def pcbnew.COLOR4D.Distance	(	self,
		other
	)

Distance(COLOR4D self, COLOR4D other) -> double

Definition at line 2329 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 2347 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 2231 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 2273 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 2325 of file pcbnew.py.

◆ GetBrightness()

def pcbnew.COLOR4D.GetBrightness ( self )

GetBrightness(COLOR4D self) -> double

Definition at line 2317 of file pcbnew.py.

◆ Invert()

def pcbnew.COLOR4D.Invert ( self )

Invert(COLOR4D self) -> COLOR4D

Definition at line 2285 of file pcbnew.py.

◆ Inverted()

def pcbnew.COLOR4D.Inverted ( self )

Inverted(COLOR4D self) -> COLOR4D

Definition at line 2313 of file pcbnew.py.

◆ LegacyMix()

def pcbnew.COLOR4D.LegacyMix	(	self,
		aColor
	)

LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D

Definition at line 2265 of file pcbnew.py.

◆ Mix()

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

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

Definition at line 2305 of file pcbnew.py.

◆ RelativeLuminance()

def pcbnew.COLOR4D.RelativeLuminance ( self )

RelativeLuminance(COLOR4D self) -> double

Definition at line 2337 of file pcbnew.py.

◆ Saturate()

def pcbnew.COLOR4D.Saturate	(	self,
		aFactor
	)

Saturate(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2289 of file pcbnew.py.

◆ SetFromHexString()

def pcbnew.COLOR4D.SetFromHexString	(	self,
		aColorString
	)

SetFromHexString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2253 of file pcbnew.py.

◆ SetFromWxString()

def pcbnew.COLOR4D.SetFromWxString	(	self,
		aColorString
	)

SetFromWxString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2245 of file pcbnew.py.

◆ ToColour()

def pcbnew.COLOR4D.ToColour ( self )

ToColour(COLOR4D self) -> wxColour

Definition at line 2261 of file pcbnew.py.

◆ ToCSSString()

def pcbnew.COLOR4D.ToCSSString ( self )

ToCSSString(COLOR4D self) -> wxString

Definition at line 2249 of file pcbnew.py.

◆ ToHexString()

def pcbnew.COLOR4D.ToHexString ( self )

ToHexString(COLOR4D self) -> wxString

Definition at line 2257 of file pcbnew.py.

◆ ToHSL()

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

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

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

◆ WithAlpha()

def pcbnew.COLOR4D.WithAlpha	(	self,
		aAlpha
	)

WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D

Definition at line 2309 of file pcbnew.py.

Member Data Documentation

◆ BLACK

pcbnew.COLOR4D.BLACK

static

Definition at line 2360 of file pcbnew.py.

◆ CLEAR

pcbnew.COLOR4D.CLEAR

static

Definition at line 2361 of file pcbnew.py.

◆ UNSPECIFIED

pcbnew.COLOR4D.UNSPECIFIED

static

Definition at line 2358 of file pcbnew.py.

◆ WHITE

pcbnew.COLOR4D.WHITE

static

Definition at line 2359 of file pcbnew.py.

Property Documentation

◆ a

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

static

Definition at line 2353 of file pcbnew.py.

◆ b

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

static

Definition at line 2352 of file pcbnew.py.

◆ g

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

static

Definition at line 2351 of file pcbnew.py.

◆ r

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

static

Definition at line 2350 of file pcbnew.py.

◆ thisown

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

static

Definition at line 2228 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

◆ r

◆ thisown

◆ init()