Difference between revisions of "IC Python API:RLPy RRgb"

From Reallusion Wiki!
Jump to: navigation, search
m
m
Line 5: Line 5:
 
== Description ==
 
== Description ==
  
−
Primary color class that stores data for red (R), green (G), and blue (B).  The value stored in RRgb ranges from 0 to 1, which represents 0 to 255 in color value.  You can swtich between these two representations in different ways;  For example, the range of values retrieved by RRgb.R() is 0 to 1, and the range of values retrieved by RRgb.Red() is 0 to 255.  In addition, preset colors are provided for direct usage:
+
Primary color class that stores data for red (R), green (G), and blue (B).  The value stored in [[IC_Python_API:RLPy_RRgb|RRgb]]ranges from 0-1, which represents 0 to 255 in color value.  You can swtich between these two representations in different ways;  For example, the range of values retrieved by [[#R ( self, args )|R]] is 0 to 1, and the range of values retrieved by [[#Red ( self )|Red]] is 0 to 255.  In addition, preset colors are provided for direct usage:
  
 
{|class="wikitable"
 
{|class="wikitable"
Line 36: Line 36:
 
|}
 
|}
  
−
RRgb does not include alpha data.  Use [https://wiki.reallusion.com/IC_Python_API:RLPy_RColor RLPy.RColor()] instead if alpha channel is needed.  This class also provides conversions to other color formats:
+
[[IC_Python_API:RLPy_RRgb|RRgb]] does not include alpha data.  Use [[IC_Python_API:RLPy_RColor|RColor]] instead if alpha channel is needed.  This class also provides ways to convert to other color formats:
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
# create color
 
# create color
 
color_red1 = RLPy.RRgb(1, 0, 0)
 
color_red1 = RLPy.RRgb(1, 0, 0)
Line 54: Line 54:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
See Also: [https://wiki.reallusion.com/IC_Python_API:RLPy_RColor RLPy.RColor()]
+
See Also: [[IC_Python_API:RLPy_RColor|RColor]]]
  
 
== Member Functions ==
 
== Member Functions ==
Line 60: Line 60:
 
=== B ( self, args ) ===
 
=== B ( self, args ) ===
  
−
Get the blue value of this color (0 to 1).
+
Get the blue value of this color (0-1).
  
−
See Also: [[#RLPy.RRgb.Blue | RLPy.RRgb.Blue()]]
+
See Also: [[#Blue ( self )|Blue]]
  
 
==== Returns ====
 
==== Returns ====
−
:Value for the blue channel (0 to 1) - float
+
:Value for the blue channel (0-1) - float
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 0, 1)
 
color1 = RLPy.RRgb(0, 0, 1)
 
print(color1.B())              # 1
 
print(color1.B())              # 1
Line 74: Line 74:
 
=== Blue ( self ) ===
 
=== Blue ( self ) ===
  
−
Get the blue value of this color (0 to 255).
+
Get the blue value of this color (0-255).
  
−
See Also: [[#RLPy.RRgb.B | RLPy.RRgb.B()]]
+
See Also: [[#B ( self, args )|B]]
  
 
==== Returns ====
 
==== Returns ====
 
:Value for the blue channel (0-255) - int
 
:Value for the blue channel (0-255) - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 0, 1)
 
color1 = RLPy.RRgb(0, 0, 1)
 
print(color1.Blue())            # 255
 
print(color1.Blue())            # 255
Line 88: Line 88:
 
=== From ( self, r, g, b ) ===
 
=== From ( self, r, g, b ) ===
  
−
Change this color using 32 bit format (0 to 255).
+
Adjust color using 32 bit (0-255).
  
 
==== Parameters ====
 
==== Parameters ====
Line 96: Line 96:
  
 
==== Returns ====
 
==== Returns ====
−
:Newly set RRgb - RLPy.RRgb
+
:(0-255) color - [[IC_Python_API:RLPy_RRgb|RRgb]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
−
color1 = RLPy.RRgb()
+
color1 = [[IC_Python_API:RLPy_RRgb|RRgb]]
 
color1.From(255, 0, 0)
 
color1.From(255, 0, 0)
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 105: Line 105:
 
=== FromCOLORREF ( self, arg2 ) ===
 
=== FromCOLORREF ( self, arg2 ) ===
  
−
Change this color using COLORREF format (0xbbggrr).
+
Adjust color using COLORREF (0xbbggrr).
  
−
See Also: [[#RLPy.RRgb.ToCOLORREF | RLPy.RRgb.ToCOLORREF()]]
+
See Also: [[#ToCOLORREF ( self )|ToCOLORREF]]
  
 
==== Parameters ====
 
==== Parameters ====
Line 113: Line 113:
  
 
==== Returns ====
 
==== Returns ====
−
:Newly set RRgb - RLPy.RRgb
+
:Changed color - [[IC_Python_API:RLPy_RRgb|RRgb]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
−
color_red2 = RLPy.RRgb()
+
color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
 
color_red2.FromCOLORREF(int(‘ff0000’, 16))
 
color_red2.FromCOLORREF(int(‘ff0000’, 16))
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 122: Line 122:
 
=== FromXRGB ( self, arg2 ) ===
 
=== FromXRGB ( self, arg2 ) ===
  
−
Assign this color using hexadecimal format (0xrrggbb).
+
Assign this color using hexadecimal (0xrrggbb).
  
−
See Also: [[#RLPy.RRgb.ToXRGB | RLPy.RRgb.ToXRGB()]]
+
See Also: [[#ToXRGB ( self )|ToXRGB]]
  
 
==== Parameters ====
 
==== Parameters ====
Line 130: Line 130:
  
 
==== Returns ====
 
==== Returns ====
−
:Newly set RRgb - RLPy.RRgb
+
:Changed color - [[IC_Python_API:RLPy_RRgb|RRgb]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
−
color_red2 = RLPy.RRgb()
+
color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
 
color_red2.FromXRGB(int(‘0000ff’, 16))
 
color_red2.FromXRGB(int(‘0000ff’, 16))
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 141: Line 141:
 
Get the green value of this color (0-1).
 
Get the green value of this color (0-1).
  
−
See Also: [[#RLPy.RRgb.Green | RLPy.RRgb.Green()]]
+
See Also: [[#Green ( self )|Green]]
  
 
==== Returns ====
 
==== Returns ====
−
:Green value of this color - float (0-1)
+
:Green value of this color (0-1) - float
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 1, 0)
 
color1 = RLPy.RRgb(0, 1, 0)
 
print(color1.G())              # 1
 
print(color1.G())              # 1
Line 155: Line 155:
 
Get the green value of this color (0-255).
 
Get the green value of this color (0-255).
  
−
See Also: [[#RLPy.RRgb.G | RLPy.RRgb.G()]]
+
See Also: [[#G ( self, args )|G]]
  
 
==== Returns ====
 
==== Returns ====
 
:Green value of this color (0-255) - int
 
:Green value of this color (0-255) - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 1, 0)
 
color1 = RLPy.RRgb(0, 1, 0)
 
print(color1.Green())          # 255
 
print(color1.Green())          # 255
Line 170: Line 170:
  
 
==== Returns ====
 
==== Returns ====
−
:Normalized RRgb - RLPy.RRgb
+
:Normalized color - [[IC_Python_API:RLPy_RRgb|RRgb]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(1, 1, 0)
 
color1 = RLPy.RRgb(1, 1, 0)
 
color1.Normalize()              # (0.5, 0.5, 0)
 
color1.Normalize()              # (0.5, 0.5, 0)
Line 181: Line 181:
 
Get the red value of this color (0-1).
 
Get the red value of this color (0-1).
  
−
See Also: [[#RLPy.RRgb.Red | RLPy.RRgb.Red()]]
+
See Also: [[#Red ( self )|Red]]
  
 
==== Returns ====
 
==== Returns ====
 
:Red value of this color (0-1) - float
 
:Red value of this color (0-1) - float
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(1, 0, 0)
 
color1 = RLPy.RRgb(1, 0, 0)
 
print(color1.R())              # 1
 
print(color1.R())              # 1
Line 195: Line 195:
 
Get the red value of this color (0-255).
 
Get the red value of this color (0-255).
  
−
See Also: [[#RLPy.RRgb.Red | RLPy.RRgb.R()]]
+
See Also: [[#R ( self, args )|R]]
  
 
==== Returns ====
 
==== Returns ====
 
:Red value of this color (0-255) - int
 
:Red value of this color (0-255) - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(1, 0, 0)
 
color1 = RLPy.RRgb(1, 0, 0)
 
print(color1.Red())            # 255
 
print(color1.Red())            # 255
Line 210: Line 210:
  
 
==== Returns ====
 
==== Returns ====
−
:This color saturated (RRgb) - RLPy.RRgb
+
:This color saturated (RRgb) - [[IC_Python_API:RLPy_RRgb|RRgb]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(1.2, -0.3, 0.5)
 
color1 = RLPy.RRgb(1.2, -0.3, 0.5)
 
color1.Saturate()              # (1, 0, 0.5)
 
color1.Saturate()              # (1, 0, 0.5)
Line 219: Line 219:
 
=== ToCOLORREF ( self ) ===
 
=== ToCOLORREF ( self ) ===
  
−
Output COLORREF data from this color (0xbbggrr).  
+
Output COLORREF data from this color (0xbbggrr).
  
−
See Also: [[#RLPy.RRgb.FromCOLORREF | RLPy.RRgb.FromCOLORREF()]]
+
See Also: [[#FromCOLORREF ( self, arg2 )|FromCOLORREF]]
  
 
==== Returns ====
 
==== Returns ====
−
:COLORREF data - int
+
:COLORREF color data - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 0, 1)
 
color1 = RLPy.RRgb(0, 0, 1)
 
print(int(color1.ToCOLORREF()))          # 0xff0000
 
print(int(color1.ToCOLORREF()))          # 0xff0000
Line 233: Line 233:
 
=== ToVector3f ( self ) ===
 
=== ToVector3f ( self ) ===
  
−
Output 3D vector data from this color (RVector3f)
+
Output 3D vector data from this color.
  
 
==== Returns ====
 
==== Returns ====
−
:3D vector color data - RLPy.RVector3f
+
:3D vector color data - [[IC_Python_API:RLPy_RVector3|RVector3]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 0, 1)
 
color1 = RLPy.RRgb(0, 0, 1)
 
print(color1.ToVector3f())
 
print(color1.ToVector3f())
Line 247: Line 247:
 
Output hexadecimal data from this color (0xrrggbb)
 
Output hexadecimal data from this color (0xrrggbb)
  
−
See Also: [[#RLPy_RRgb#FromXRGB | RLPy.RRgb.FromXRGB()]]
+
See Also: [[#FromXRGB ( self, arg2 )|FromXRGB]]
  
 
==== Returns ====
 
==== Returns ====
 
:Hexadecimal color data - int
 
:Hexadecimal color data - int
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
color1 = RLPy.RRgb(0, 0, 1)
 
color1 = RLPy.RRgb(0, 0, 1)
 
print(int(color1.ToXRGB()))              # 0xff
 
print(int(color1.ToXRGB()))              # 0xff
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 01:36, 8 April 2020

Main article: Modules.
Last modified: 04/8/2020

Description

Primary color class that stores data for red (R), green (G), and blue (B). The value stored in RRgbranges from 0-1, which represents 0 to 255 in color value. You can swtich between these two representations in different ways; For example, the range of values retrieved by R is 0 to 1, and the range of values retrieved by Red is 0 to 255. In addition, preset colors are provided for direct usage:

Constant Value
RLPy.RRgb.BLACK RLPy.RRgb(0, 0, 0)
RLPy.RRgb.WHITE RLPy.RRgb(1, 1, 1)
RLPy.RRgb.RED RLPy.RRgb(1, 0, 0)
RLPy.RRgb.GREEN RLPy.RRgb(0, 1, 0)
RLPy.RRgb.BLUE RLPy.RRgb(0, 0, 1)
RLPy.RRgb.YELLOW RLPy.RRgb(1, 1, 0)
RLPy.RRgb.CYAN RLPy.RRgb(0, 1, 1)
RLPy.RRgb.MAGENTA RLPy.RRgb(1, 0, 1)

RRgb does not include alpha data. Use RColor instead if alpha channel is needed. This class also provides ways to convert to other color formats: 

# create color
color_red1 = RLPy.RRgb(1, 0, 0)
color_red2 = RLPy.RRgb()
color_red2.From(255, 0, 0)
color_red3 = RLPy.RRgb.RED
 
# print color
print( color_red1.R() )         # 1
print( color_red1.Red() )       # 255
 
# convert different format
print(hex(color1.ToXRGB()))     # 0xff0000
print(hex(color1.ToCOLORREF())) # 0xff

See Also: RColor]

Member Functions

B ( self, args )

Get the blue value of this color (0-1).

See Also: Blue

Returns

Value for the blue channel (0-1) - float
color1 = RLPy.RRgb(0, 0, 1)
print(color1.B())               # 1

Blue ( self )

Get the blue value of this color (0-255).

See Also: B

Returns

Value for the blue channel (0-255) - int
color1 = RLPy.RRgb(0, 0, 1)
print(color1.Blue())            # 255

From ( self, r, g, b )

Adjust color using 32 bit (0-255).

Parameters

r [IN] Red value (0-255) - int
g [IN] Green value (0-255) - int
b [IN] Blue value (0-255) - int

Returns

(0-255) color - RRgb
color1 = [[IC_Python_API:RLPy_RRgb|RRgb]]
color1.From(255, 0, 0)

FromCOLORREF ( self, arg2 )

Adjust color using COLORREF (0xbbggrr).

See Also: ToCOLORREF

Parameters

arg2 [IN] COLORREF data

Returns

Changed color - RRgb
color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
color_red2.FromCOLORREF(int(‘ff0000’, 16))

FromXRGB ( self, arg2 )

Assign this color using hexadecimal (0xrrggbb).

See Also: ToXRGB

Parameters

arg2 [IN] RGB hexadecimal value - HEX

Returns

Changed color - RRgb
color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
color_red2.FromXRGB(int(‘0000ff’, 16))

G ( self, args )

Get the green value of this color (0-1).

See Also: Green

Returns

Green value of this color (0-1) - float
color1 = RLPy.RRgb(0, 1, 0)
print(color1.G())               # 1

Green ( self )

Get the green value of this color (0-255).

See Also: G

Returns

Green value of this color (0-255) - int
color1 = RLPy.RRgb(0, 1, 0)
print(color1.Green())           # 255

Normalize ( self )

Normalize RGB values so that their sum equals 1.

Returns

Normalized color - RRgb
color1 = RLPy.RRgb(1, 1, 0)
color1.Normalize()              # (0.5, 0.5, 0)

R ( self, args )

Get the red value of this color (0-1).

See Also: Red

Returns

Red value of this color (0-1) - float
color1 = RLPy.RRgb(1, 0, 0)
print(color1.R())               # 1

Red ( self )

Get the red value of this color (0-255).

See Also: R

Returns

Red value of this color (0-255) - int
color1 = RLPy.RRgb(1, 0, 0)
print(color1.Red())            # 255

Saturate ( self )

Clamp the RGB values to a range of 0 and 1. Values under 0 will become 0, and values over 1 will become 1.

Returns

This color saturated (RRgb) - RRgb
color1 = RLPy.RRgb(1.2, -0.3, 0.5)
color1.Saturate()              # (1, 0, 0.5)

ToCOLORREF ( self )

Output COLORREF data from this color (0xbbggrr).

See Also: FromCOLORREF

Returns

COLORREF color data - int
color1 = RLPy.RRgb(0, 0, 1)
print(int(color1.ToCOLORREF()))          # 0xff0000

ToVector3f ( self )

Output 3D vector data from this color.

Returns

3D vector color data - RVector3
color1 = RLPy.RRgb(0, 0, 1)
print(color1.ToVector3f())

ToXRGB ( self )

Output hexadecimal data from this color (0xrrggbb)

See Also: FromXRGB

Returns

Hexadecimal color data - int
color1 = RLPy.RRgb(0, 0, 1)
print(int(color1.ToXRGB()))              # 0xff
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RRgb&oldid=4455"