IC Python API:RLPy RRgb

From Reallusion Wiki!
Jump to: navigation, search

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

Description

Primary color class that stores data for red (R), green (G), and blue (B). The value stored in 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 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:

 1 # create color
 2 color_red1 = RLPy.RRgb(1, 0, 0)
 3 color_red2 = RLPy.RRgb()
 4 color_red2.From(255, 0, 0)
 5 color_red3 = RLPy.RRgb.RED
 6  
 7 # print color
 8 print( color_red1.R() )         # 1
 9 print( color_red1.Red() )       # 255
10  
11 # convert different format
12 print(hex(color1.ToXRGB()))     # 0xff0000
13 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
1 color1 = RLPy.RRgb(0, 0, 1)
2 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
1 color1 = RLPy.RRgb(0, 0, 1)
2 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
1 color1 = [[IC_Python_API:RLPy_RRgb|RRgb]]
2 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
1 color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
2 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
1 color_red2 = [[IC_Python_API:RLPy_RRgb|RRgb]]
2 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
1 color1 = RLPy.RRgb(0, 1, 0)
2 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
1 color1 = RLPy.RRgb(0, 1, 0)
2 print(color1.Green())           # 255

Normalize ( self )

Normalize RGB values so that their sum equals 1.

Returns

Normalized color - RRgb
1 color1 = RLPy.RRgb(1, 1, 0)
2 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
1 color1 = RLPy.RRgb(1, 0, 0)
2 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
1 color1 = RLPy.RRgb(1, 0, 0)
2 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
1 color1 = RLPy.RRgb(1.2, -0.3, 0.5)
2 color1.Saturate()              # (1, 0, 0.5)

ToCOLORREF ( self )

Output COLORREF data from this color (0xbbggrr).

See Also: FromCOLORREF

Returns

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

ToVector3f ( self )

Output 3D vector data from this color.

Returns

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

ToXRGB ( self )

Output hexadecimal data from this color (0xrrggbb)

See Also: FromXRGB

Returns

Hexadecimal color data - int
1 color1 = RLPy.RRgb(0, 0, 1)
2 print(int(color1.ToXRGB()))              # 0xff