KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.COLOR4D Class Reference
Inheritance diagram for pcbnew.COLOR4D:
Inheritance graph
[legend]

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 2392 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 2402 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 2444 of file pcbnew.py.

◆ Brightened()

def pcbnew.COLOR4D.Brightened (   self,
  aFactor 
)
Brightened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2464 of file pcbnew.py.

◆ Compare()

def pcbnew.COLOR4D.Compare (   self,
  aRhs 
)
Compare(COLOR4D self, COLOR4D aRhs) -> int

Definition at line 2500 of file pcbnew.py.

◆ ContrastRatio()

def pcbnew.COLOR4D.ContrastRatio (   aLeft,
  aRight 
)
static
ContrastRatio(COLOR4D aLeft, COLOR4D aRight) -> double

Definition at line 2509 of file pcbnew.py.

◆ Darken()

def pcbnew.COLOR4D.Darken (   self,
  aFactor 
)
Darken(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2448 of file pcbnew.py.

◆ Darkened()

def pcbnew.COLOR4D.Darkened (   self,
  aFactor 
)
Darkened(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2468 of file pcbnew.py.

◆ Desaturate()

def pcbnew.COLOR4D.Desaturate (   self)
Desaturate(COLOR4D self) -> COLOR4D

Definition at line 2460 of file pcbnew.py.

◆ Distance()

def pcbnew.COLOR4D.Distance (   self,
  other 
)
Distance(COLOR4D self, COLOR4D other) -> double

Definition at line 2496 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 2514 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 2398 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 2440 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 2492 of file pcbnew.py.

◆ GetBrightness()

def pcbnew.COLOR4D.GetBrightness (   self)
GetBrightness(COLOR4D self) -> double

Definition at line 2484 of file pcbnew.py.

◆ Invert()

def pcbnew.COLOR4D.Invert (   self)
Invert(COLOR4D self) -> COLOR4D

Definition at line 2452 of file pcbnew.py.

◆ Inverted()

def pcbnew.COLOR4D.Inverted (   self)
Inverted(COLOR4D self) -> COLOR4D

Definition at line 2480 of file pcbnew.py.

◆ LegacyMix()

def pcbnew.COLOR4D.LegacyMix (   self,
  aColor 
)
LegacyMix(COLOR4D self, COLOR4D aColor) -> COLOR4D

Definition at line 2432 of file pcbnew.py.

◆ Mix()

def pcbnew.COLOR4D.Mix (   self,
  aColor,
  aFactor 
)
Mix(COLOR4D self, COLOR4D aColor, double aFactor) -> COLOR4D

Definition at line 2472 of file pcbnew.py.

◆ RelativeLuminance()

def pcbnew.COLOR4D.RelativeLuminance (   self)
RelativeLuminance(COLOR4D self) -> double

Definition at line 2504 of file pcbnew.py.

◆ Saturate()

def pcbnew.COLOR4D.Saturate (   self,
  aFactor 
)
Saturate(COLOR4D self, double aFactor) -> COLOR4D

Definition at line 2456 of file pcbnew.py.

◆ SetFromHexString()

def pcbnew.COLOR4D.SetFromHexString (   self,
  aColorString 
)
SetFromHexString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2420 of file pcbnew.py.

◆ SetFromWxString()

def pcbnew.COLOR4D.SetFromWxString (   self,
  aColorString 
)
SetFromWxString(COLOR4D self, wxString aColorString) -> bool

Definition at line 2412 of file pcbnew.py.

◆ ToColour()

def pcbnew.COLOR4D.ToColour (   self)
ToColour(COLOR4D self) -> wxColour

Definition at line 2428 of file pcbnew.py.

◆ ToCSSString()

def pcbnew.COLOR4D.ToCSSString (   self)
ToCSSString(COLOR4D self) -> wxString

Definition at line 2416 of file pcbnew.py.

◆ ToHexString()

def pcbnew.COLOR4D.ToHexString (   self)
ToHexString(COLOR4D self) -> wxString

Definition at line 2424 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 2436 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 2488 of file pcbnew.py.

◆ WithAlpha()

def pcbnew.COLOR4D.WithAlpha (   self,
  aAlpha 
)
WithAlpha(COLOR4D self, double aAlpha) -> COLOR4D

Definition at line 2476 of file pcbnew.py.

Member Data Documentation

◆ BLACK

pcbnew.COLOR4D.BLACK
static

Definition at line 2527 of file pcbnew.py.

◆ CLEAR

pcbnew.COLOR4D.CLEAR
static

Definition at line 2528 of file pcbnew.py.

◆ UNSPECIFIED

pcbnew.COLOR4D.UNSPECIFIED
static

Definition at line 2525 of file pcbnew.py.

◆ WHITE

pcbnew.COLOR4D.WHITE
static

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

◆ b

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

Definition at line 2519 of file pcbnew.py.

◆ g

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

Definition at line 2518 of file pcbnew.py.

◆ r

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

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


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