KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.COLOR4D Class Reference
Inheritance diagram for pcbnew.COLOR4D:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args)
 
def SetFromWxString (self, aColorString)
 
def ToWxString (self, flags)
 
def ToColour (self)
 
def LegacyMix (self, aColor)
 
def SetToLegacyHighlightColor (self)
 
def SetToNearestLegacyColor (self)
 
def AsLegacyColor (self)
 
def ToU32 (self)
 
def FromU32 (self, aPackedColor)
 
def GetNearestLegacyColor (aColor)
 
def Brighten (self, aFactor)
 
def Darken (self, aFactor)
 
def Invert (self)
 
def Saturate (self, aFactor)
 
def Brightened (self, aFactor)
 
def Darkened (self, 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)
 

Public Attributes

 this
 

Static Public Attributes

 GetNearestLegacyColor = staticmethod(GetNearestLegacyColor)
 
 r = _swig_property(_pcbnew.COLOR4D_r_get, _pcbnew.COLOR4D_r_set)
 
 g = _swig_property(_pcbnew.COLOR4D_g_get, _pcbnew.COLOR4D_g_set)
 
 b = _swig_property(_pcbnew.COLOR4D_b_get, _pcbnew.COLOR4D_b_set)
 
 a = _swig_property(_pcbnew.COLOR4D_a_get, _pcbnew.COLOR4D_a_set)
 

Detailed Description

Proxy of C++ KIGFX::COLOR4D class.

Definition at line 2197 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.COLOR4D.__init__ (   self,
  args 
)
__init__(KIGFX::COLOR4D self) -> COLOR4D
__init__(KIGFX::COLOR4D self, double aRed, double aGreen, double aBlue, double aAlpha) -> COLOR4D
__init__(KIGFX::COLOR4D self, EDA_COLOR_T aColor) -> COLOR4D
__init__(KIGFX::COLOR4D self, wxColour const & aColor) -> COLOR4D

Definition at line 2206 of file pcbnew.py.

Member Function Documentation

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

Definition at line 2249 of file pcbnew.py.

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

Definition at line 2272 of file pcbnew.py.

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

Definition at line 2292 of file pcbnew.py.

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

Definition at line 2277 of file pcbnew.py.

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

Definition at line 2297 of file pcbnew.py.

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.

def pcbnew.COLOR4D.FromU32 (   self,
  aPackedColor 
)
FromU32(COLOR4D self, unsigned int aPackedColor)

Definition at line 2259 of file pcbnew.py.

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

Definition at line 2312 of file pcbnew.py.

def pcbnew.COLOR4D.GetNearestLegacyColor (   aColor)
GetNearestLegacyColor(COLOR4D aColor) -> EDA_COLOR_T

Definition at line 2264 of file pcbnew.py.

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

Definition at line 2282 of file pcbnew.py.

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

Definition at line 2307 of file pcbnew.py.

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

Definition at line 2234 of file pcbnew.py.

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

Definition at line 2287 of file pcbnew.py.

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

Definition at line 2219 of file pcbnew.py.

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

Definition at line 2239 of file pcbnew.py.

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

Definition at line 2244 of file pcbnew.py.

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

Definition at line 2229 of file pcbnew.py.

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

Definition at line 2317 of file pcbnew.py.

def pcbnew.COLOR4D.ToU32 (   self)
ToU32(COLOR4D self) -> unsigned int

Definition at line 2254 of file pcbnew.py.

def pcbnew.COLOR4D.ToWxString (   self,
  flags 
)
ToWxString(COLOR4D self, long flags) -> wxString

Definition at line 2224 of file pcbnew.py.

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

Definition at line 2302 of file pcbnew.py.

Member Data Documentation

pcbnew.COLOR4D.a = _swig_property(_pcbnew.COLOR4D_a_get, _pcbnew.COLOR4D_a_set)
static

Definition at line 2344 of file pcbnew.py.

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

Definition at line 2340 of file pcbnew.py.

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

Definition at line 2336 of file pcbnew.py.

pcbnew.COLOR4D.GetNearestLegacyColor = staticmethod(GetNearestLegacyColor)
static

Definition at line 2269 of file pcbnew.py.

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

Definition at line 2332 of file pcbnew.py.

pcbnew.COLOR4D.this

Definition at line 2217 of file pcbnew.py.


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