Inheritance diagram for pcbnew.COLOR4D:

Public Member Functions
"KIGFX::COLOR4D &"	FromCSSRGBA (self, "int" aRed, "int" aGreen, "int" aBlue, "double" aAlpha=1.0)

def	__init__ (self, *args)

"bool"	SetFromWxString (self, "wxString" aColorString)

"wxString"	ToCSSString (self)

"bool"	SetFromHexString (self, "wxString" aColorString)

"wxString"	ToHexString (self)

"wxColour"	ToColour (self)

"KIGFX::COLOR4D"	LegacyMix (self, "COLOR4D" aColor)

"unsigned int"	ToU32 (self)

"void"	FromU32 (self, "unsigned int" aPackedColor)

"void"	ToHSL (self, "double &" aOutHue, "double &" aOutSaturation, "double &" aOutValue)

"void"	FromHSL (self, "double" aInHue, "double" aInSaturation, "double" aInLightness)

"KIGFX::COLOR4D &"	Brighten (self, "double" aFactor)

"KIGFX::COLOR4D &"	Darken (self, "double" aFactor)

"KIGFX::COLOR4D &"	Invert (self)

"KIGFX::COLOR4D &"	Saturate (self, "double" aFactor)

"KIGFX::COLOR4D"	Brightened (self, "double" aFactor)

"KIGFX::COLOR4D"	Darkened (self, "double" aFactor)

"KIGFX::COLOR4D"	Mix (self, "COLOR4D" aColor, "double" aFactor)

"KIGFX::COLOR4D"	WithAlpha (self, "double" aAlpha)

"KIGFX::COLOR4D"	Inverted (self)

"double"	GetBrightness (self)

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

"void"	FromHSV (self, "double" aInH, "double" aInS, "double" aInV)

"double"	Distance (self, "COLOR4D" other)

Static Public Member Functions
"EDA_COLOR_T"	FindNearestLegacyColor ("int" aR, "int" aG, "int" 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 2272 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 2282 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Brighten()

"KIGFX.COLOR4D &" pcbnew.COLOR4D.Brighten	(		self,
		"double"	aFactor
	)

Brighten(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2332 of file pcbnew.py.

◆ Brightened()

"KIGFX.COLOR4D" pcbnew.COLOR4D.Brightened	(		self,
		"double"	aFactor
	)

Brightened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2348 of file pcbnew.py.

◆ Darken()

"KIGFX.COLOR4D &" pcbnew.COLOR4D.Darken	(		self,
		"double"	aFactor
	)

Darken(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2336 of file pcbnew.py.

◆ Darkened()

"KIGFX.COLOR4D" pcbnew.COLOR4D.Darkened	(		self,
		"double"	aFactor
	)

Darkened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2352 of file pcbnew.py.

◆ Distance()

"double" pcbnew.COLOR4D.Distance	(		self,
		"COLOR4D"	other
	)

Distance(COLOR4D self, COLOR4D other) -> double

Definition at line 2380 of file pcbnew.py.

◆ FindNearestLegacyColor()

"EDA_COLOR_T" pcbnew.COLOR4D.FindNearestLegacyColor	(	"int"	aR,
		"int"	aG,
		"int"	aB
	)

static

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

Definition at line 2385 of file pcbnew.py.

◆ FromCSSRGBA()

"KIGFX.COLOR4D &" pcbnew.COLOR4D.FromCSSRGBA	(		self,
		"int"	aRed,
		"int"	aGreen,
		"int"	aBlue,
		"double"	aAlpha = `1.0`
	)

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

Definition at line 2278 of file pcbnew.py.

◆ FromHSL()

"void" pcbnew.COLOR4D.FromHSL	(		self,
		"double"	aInHue,
		"double"	aInSaturation,
		"double"	aInLightness
	)

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

Definition at line 2328 of file pcbnew.py.

◆ FromHSV()

"void" pcbnew.COLOR4D.FromHSV	(		self,
		"double"	aInH,
		"double"	aInS,
		"double"	aInV
	)

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

Definition at line 2376 of file pcbnew.py.

◆ FromU32()

"void" pcbnew.COLOR4D.FromU32	(		self,
		"unsigned int"	aPackedColor
	)

FromU32(COLOR4D self, unsigned int aPackedColor)

Definition at line 2320 of file pcbnew.py.

◆ GetBrightness()

"double" pcbnew.COLOR4D.GetBrightness ( self )

GetBrightness(COLOR4D self) -> double

Definition at line 2368 of file pcbnew.py.

◆ Invert()

"KIGFX.COLOR4D &" pcbnew.COLOR4D.Invert ( self )

Invert(COLOR4D self) -> COLOR4D

Definition at line 2340 of file pcbnew.py.

◆ Inverted()

"KIGFX.COLOR4D" pcbnew.COLOR4D.Inverted ( self )

Inverted(COLOR4D self) -> COLOR4D

Definition at line 2364 of file pcbnew.py.

◆ LegacyMix()

"KIGFX.COLOR4D" pcbnew.COLOR4D.LegacyMix	(		self,
		"COLOR4D"	aColor
	)

LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D

Definition at line 2312 of file pcbnew.py.

◆ Mix()

"KIGFX.COLOR4D" pcbnew.COLOR4D.Mix	(		self,
		"COLOR4D"	aColor,
		"double"	aFactor
	)

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

Definition at line 2356 of file pcbnew.py.

◆ Saturate()

"KIGFX.COLOR4D &" pcbnew.COLOR4D.Saturate	(		self,
		"double"	aFactor
	)

Saturate(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2344 of file pcbnew.py.

◆ SetFromHexString()

"bool" pcbnew.COLOR4D.SetFromHexString	(		self,
		"wxString"	aColorString
	)

SetFromHexString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2300 of file pcbnew.py.

◆ SetFromWxString()

"bool" pcbnew.COLOR4D.SetFromWxString	(		self,
		"wxString"	aColorString
	)

SetFromWxString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2292 of file pcbnew.py.

◆ ToColour()

"wxColour" pcbnew.COLOR4D.ToColour ( self )

ToColour(COLOR4D self) -> wxColour

Definition at line 2308 of file pcbnew.py.

◆ ToCSSString()

"wxString" pcbnew.COLOR4D.ToCSSString ( self )

ToCSSString(COLOR4D self) -> wxString

Definition at line 2296 of file pcbnew.py.

◆ ToHexString()

"wxString" pcbnew.COLOR4D.ToHexString ( self )

ToHexString(COLOR4D self) -> wxString

Definition at line 2304 of file pcbnew.py.

◆ ToHSL()

"void" pcbnew.COLOR4D.ToHSL	(		self,
		"double &"	aOutHue,
		"double &"	aOutSaturation,
		"double &"	aOutValue
	)

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

Definition at line 2324 of file pcbnew.py.

◆ ToHSV()

"void" pcbnew.COLOR4D.ToHSV	(		self,
		"double &"	aOutHue,
		"double &"	aOutSaturation,
		"double &"	aOutValue,
		"bool"	aAlwaysDefineHue = `False`
	)

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

Definition at line 2372 of file pcbnew.py.

◆ ToU32()

"unsigned int" pcbnew.COLOR4D.ToU32 ( self )

ToU32(COLOR4D self) -> unsigned int

Definition at line 2316 of file pcbnew.py.

◆ WithAlpha()

"KIGFX.COLOR4D" pcbnew.COLOR4D.WithAlpha	(		self,
		"double"	aAlpha
	)

WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D

Definition at line 2360 of file pcbnew.py.

Property Documentation

◆ a

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

static

Definition at line 2391 of file pcbnew.py.

◆ b

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

static

Definition at line 2390 of file pcbnew.py.

◆ g

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

static

Definition at line 2389 of file pcbnew.py.

◆ r

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

static

Definition at line 2388 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 2275 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()

◆ Darken()

◆ Darkened()

◆ Distance()

◆ FindNearestLegacyColor()

◆ FromCSSRGBA()

◆ FromHSL()

◆ FromHSV()

◆ FromU32()

◆ GetBrightness()

◆ Invert()

◆ Inverted()

◆ LegacyMix()

◆ Mix()

◆ Saturate()

◆ SetFromHexString()

◆ SetFromWxString()

◆ ToColour()

◆ ToCSSString()

◆ ToHexString()

◆ ToHSL()

◆ ToHSV()

◆ ToU32()

◆ WithAlpha()

Property Documentation

◆ a

◆ b

◆ g

◆ r

◆ thisown

◆ init()