Class: Sketchup::Color

Relationships
Inherits:	Object

Overview

The Color class is used to create and manipulate colors within SketchUp Models. The class can also be used the same way with LayOut documents.

For methods that accept a Color object, such as the face.material method, you can pass in an actual Color object, or an object that can be converted to a Color. For example:

SketchUp ships with several built in colors in the Materials Browser. These colors are listed in the following table.

Name	RGB Values	Swatch
AliceBlue	240,248,255
AntiqueWhite	250,235,215
Aqua	0,255,255
Aquamarine	127,255,212
Azure	240,255,255
Beige	245,245,220
Bisque	255,228,196
Black	0,0,0
BlanchedAlmond	255,235,205
Blue	0,0,255
BlueViolet	138,43,226
Brown	165,42,42
BurlyWood	222,184,135
CadetBlue	95,158,160
Chartreuse	127,255,0
Chocolate	210,105,30
Coral	255,127,80
CornflowerBlue	100,149,237
Cornsilk	255,248,220
Crimson	220,20,60
Cyan	0,255,255
DarkBlue	0,0,139
DarkCyan	0,139,139
DarkGoldenrod	184,134,11
DarkGray	169,169,169
DarkGreen	0,100,0
DarkKhaki	189,183,107
DarkMagenta	139,0,139
DarkOliveGreen	85,107,47
DarkOrange	255,140,0
DarkOrchid	153,50,204
DarkRed	139,0,0
DarkSalmon	233,150,122
DarkSeaGreen	143,188,143
DarkSlateBlue	72,61,139
DarkSlateGray	47,79,79
DarkTurquoise	0,206,209
DarkViolet	148,0,211
DeepPink	255,20,147
DeepSkyBlue	0,191,255
DimGray	105,105,105
DodgerBlue	30,144,255
FireBrick	178,34,34
FloralWhite	255,250,240
ForestGreen	34,139,34
Fuchsia	255,0,255
Gainsboro	220,220,220
GhostWhite	248,248,255
Gold	255,215,0
Goldenrod	218,165,32
Gray	128,128,128
Green	0,128,0
GreenYellow	173,255,47
Honeydew	240,255,240
HotPink	255,105,180
IndianRed	205,92,92
Indigo	75,0,130
Ivory	255,255,240
Khaki	240,230,140
Lavender	230,230,250
LavenderBlush	255,240,245
LawnGreen	124,252,0
LemonChiffon	255,250,205
LightBlue	173,216,230
LightCoral	240,128,128
LightCyan	224,255,255
LightGoldenrodYellow	250,250,210
LightGreen	144,238,144
LightGrey	211,211,211
LightPink	255,182,193
LightSalmon	255,160,122
LightSeaGreen	32,178,170
LightSkyBlue	135,206,250
LightSlateGray	119,136,153
LightSteelBlue	176,196,222
LightYellow	255,255,224
Lime	0,255,0
LimeGreen	50,205,50
Linen	250,240,230
Magenta	255,0,255
Maroon	128,0,0
MediumAquamarine	102,205,170
MediumBlue	0,0,205
MediumOrchid	186,85,211
MediumPurple	147,112,219
MediumSeaGreen	60,179,113
MediumSlateBlue	123,104,238
MediumSpringGreen	0,250,154
MediumTurquoise	72,209,204
MediumVioletRed	199,21,133
MidnightBlue	25,25,112
MintCream	245,255,250
MistyRose	255,228,225
Moccasin	255,228,181
NavajoWhite	255,222,173
Navy	0,0,128
OldLace	253,245,230
Olive	128,128,0
OliveDrab	107,142,35
Orange	255,165,0
OrangeRed	255,69,0
Orchid	218,112,214
PaleGoldenrod	238,232,170
PaleGreen	152,251,152
PaleTurquoise	175,238,238
PaleVioletRed	219,112,147
PapayaWhip	255,239,213
PeachPuff	255,218,185
Peru	205,133,63
Pink	255,192,203
Plum	221,160,221
PowderBlue	176,224,230
Purple	128,0,128
Red	255,0,0
RosyBrown	188,143,143
RoyalBlue	65,105,225
SaddleBrown	139,69,19
Salmon	250,128,114
SandyBrown	244,164,96
SeaGreen	46,139,87
Seashell	255,245,238
Sienna	160,82,45
Silver	192,192,192
SkyBlue	135,206,235
SlateBlue	106,90,205
SlateGray	112,128,144
Snow	255,250,250
SpringGreen	0,255,127
SteelBlue	70,130,180
Tan	210,180,140
Teal	0,128,128
Thistle	216,191,216
Tomato	255,99,71
Turquoise	64,224,208
Violet	238,130,238
Wheat	245,222,179
White	255,255,255
WhiteSmoke	245,245,245
Yellow	255,255,0
YellowGreen	154,205,50

Examples:

face.material = Sketchup::Color.new(255, 0, 0)
face.material = 255
face.material = 0xff
face.material = "red"
face.material = "#ff0000"
face.material = [1.0, 0.0, 0.0]
face.material = [255, 0, 0]

Version:

SketchUp 6.0

Class Method Summary

.names ⇒ Array

The .names method is used to retrieve an array of all color names recognized by SketchUp.
.new(red, green, blue, alpha = 255) ⇒ Sketchup::Color constructor

The new method is used to create a new Color object.

Instance Attribute Summary

#alpha ⇒ Integer rw

The #alpha method is used to retrieve the opacity of the color.
#alpha=(alpha) ⇒ Integer, Float rw

The #alpha= method is used to set the opacity of the color.
#blue ⇒ Integer rw

The #blue method is used to retrieve the blue value of a color.
#blue=(blue) ⇒ Integer, Float rw

The #blue= method is used to set the blue value of a color.
#green ⇒ Integer rw

The #green method is used to retrieve the green value of a color.
#green=(green) ⇒ Integer, Float rw

The #green= method is used to set the green component of a RGB Color.
#red ⇒ Integer rw

The #red method is used to retrieve the red component of a RGB Color.
#red=(red) ⇒ Integer, Float rw

The #red= method is used to set the red component of a RGB Color.

Instance Method Summary

#==(other) ⇒ Boolean

The #== method checks to see if the two Colors are equal.
#blend(color2, weight) ⇒ Sketchup::Color

The #blend method is used to blend two colors.
#to_a ⇒ Array

The #to_a method is used to convert a Color object to an ::Array object.
#to_i ⇒ Integer

The #to_i method is used to convert a Color object to an 32 bit integer.
#to_s ⇒ String

The #to_s method returns a string representation of the Color object, in the form of “Color(255, 255, 255, 255)”.

Constructor Details

.new(red, green, blue, alpha = 255) ⇒ `Color` .new(red, green, blue, alpha = 1.0) ⇒ `Color` .new(name) ⇒ `Color` .new(hex) ⇒ `Color`

The new method is used to create a new Color object.

Examples:

color_from_name = Sketchup::Color.new "OldLace"
color_from_rgb = Sketchup::Color.new(0, 128, 255)
color_from_rgba = Sketchup::Color.new(0, 128, 255, 128)
color_from_hex = Sketchup::Color.new(0xFF0000)

# You can then assign colors to the material of DrawingElements.
# Note that this creates a new Material object, and the alpha value
# of the color does NOT get applied to the new Material. You must
# manually set the alpha to get transparent materials.
face.material = color_from_rgba
face.material.alpha = 0.5

Overloads:

.new(red, green, blue, alpha = 255) ⇒ Color
Parameters:
- red (Integer) —
  
  A red value between 0 and 255.
- green (Integer) —
  
  A green value between 0 and 255.
- blue (Integer) —
  
  A blue value between 0 and 255.
- alpha (Integer) (defaults to: 255) —
  
  A alpha value between 0 and 255.
.new(red, green, blue, alpha = 1.0) ⇒ Color
Parameters:
- red (Float) —
  
  A red value between 0.0 and 1.0.
- green (Float) —
  
  A green value between 0.0 and 1.0.
- blue (Float) —
  
  A blue value between 0.0 and 1.0.
- alpha (Float) (defaults to: 1.0) —
  
  A alpha value between 0.0 and 1.0.
.new(name) ⇒ Color
Parameters:
- name (String) —
  
  A string name of a color that currently exists in SketchUp. See the table at the start of this class description for more info.
.new(hex) ⇒ Color

Note:

When assigning colors via a hexadecimal, R and B will be flipped.

Note:

When assigning colors via a hexadecimal, Alpha is not supported.
Parameters:
- hex (Integer) —
  
  A hexadecimal color code.

Version:

SketchUp 6.0

Class Method Details

.names ⇒ Array

The .names method is used to retrieve an array of all color names recognized by SketchUp.

In general, whenever a method wants a color, you can pass in a ::String with one of these names.

Examples:

array = Sketchup::Color.names

Version:

SketchUp 6.0

Instance Attribute Details

#alpha ⇒ `Integer` (rw)

The #alpha method is used to retrieve the opacity of the color. A value of 0 is transparent, 255 is opaque.

Examples:

color = Sketchup::Color.new "OldLace"
alpha = color.alpha

Version:

SketchUp 6.0

#alpha=(alpha) ⇒ `Integer`, `Float` (rw)

The #alpha= method is used to set the opacity of the color. A value of 0 is transparent, 255 is opaque.

Examples:

color = Sketchup::Color.new "AliceBlue"
alpha = color.alpha = 255

Parameters:

alpha (Integer, Float) —

The new opacity value.

Version:

SketchUp 8.0 M1

#blue ⇒ `Integer` (rw)

The #blue method is used to retrieve the blue value of a color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
blue = color.blue

Version:

SketchUp 6.0

#blue=(blue) ⇒ `Integer`, `Float` (rw)

The #blue= method is used to set the blue value of a color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
blue = color.blue = 200

Parameters:

blue (Integer, Float) —

The blue value for the color.

Version:

SketchUp 6.0

#green ⇒ `Integer` (rw)

The #green method is used to retrieve the green value of a color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
green = color.green

Version:

SketchUp 6.0

#green=(green) ⇒ `Integer`, `Float` (rw)

The #green= method is used to set the green component of a RGB Color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
green = color.green = 200

Parameters:

green (Integer, Float) —

The green value for the color.

Version:

SketchUp 6.0

#red ⇒ `Integer` (rw)

The #red method is used to retrieve the red component of a RGB Color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
red = color.red

Version:

SketchUp 6.0

#red=(red) ⇒ `Integer`, `Float` (rw)

The #red= method is used to set the red component of a RGB Color.

Value range is 0 to 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
red = color.red=200

Parameters:

red (Integer, Float) —

The red value for the color.

Version:

SketchUp 6.0

Instance Method Details

#==(other) ⇒ `Boolean`

The #== method checks to see if the two Colors are equal. This checks whether the RGBA values are the same. In versions prior to SketchUp 2018 two color objects with the same values would be considered different.

Examples:

SketchUp::Color.new(255, 255, 255) == Sketchup::Color.new(1.0, 1.0, 1.0)

Parameters:

other (Object)

Version:

SketchUp 2018

#blend(color2, weight) ⇒ `Color`

The #blend method is used to blend two colors.

The blended color will be the result of taking (1 - weight) * color1 + weight * color2. If weight = 0, you will get color2. If weight = 1 you will get color1.

Examples:

color1 = Sketchup::Color.new "OldLace"
color2 = Sketchup::Color.new "AliceBlue"
color3 = color1.blend color2, 0.5

Parameters:

color2 (Color) —

The second color to be blended (with this color).
weight (Float) —

A Float between 0.0 and 1.0

Version:

SketchUp 6.0

#to_a ⇒ Array

The #to_a method is used to convert a Color object to an ::Array object. The returned array will contain 4 integer values (RGBA) between 0 and 255.

Examples:

color = Sketchup::Color.new "AliceBlue"
color_array = color.to_a

Version:

SketchUp 6.0

#to_i ⇒ `Integer`

The #to_i method is used to convert a Color object to an 32 bit integer.

Examples:

color = Sketchup::Color.new "AliceBlue"
integer = color.to_i

Version:

SketchUp 6.0

#to_s ⇒ String

The #to_s method returns a string representation of the Color object, in the form of “Color(255, 255, 255, 255)”.

Examples:

color = Sketchup::Color.new(255, 255, 255, 255)
color_str = color.to_s

Version:

SketchUp 6.0

Class: Sketchup::Color

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(red, green, blue, alpha = 255) ⇒ Color .new(red, green, blue, alpha = 1.0) ⇒ Color .new(name) ⇒ Color .new(hex) ⇒ Color

Class Method Details

.names ⇒ Array

Instance Attribute Details

#alpha ⇒ Integer (rw)

#alpha=(alpha) ⇒ Integer, Float (rw)

#blue ⇒ Integer (rw)

#blue=(blue) ⇒ Integer, Float (rw)

#green ⇒ Integer (rw)

#green=(green) ⇒ Integer, Float (rw)

#red ⇒ Integer (rw)

#red=(red) ⇒ Integer, Float (rw)

Instance Method Details

#==(other) ⇒ Boolean

#blend(color2, weight) ⇒ Color

#to_a ⇒ Array

#to_i ⇒ Integer

#to_s ⇒ String

.new(red, green, blue, alpha = 255) ⇒ `Color` .new(red, green, blue, alpha = 1.0) ⇒ `Color` .new(name) ⇒ `Color` .new(hex) ⇒ `Color`

#alpha ⇒ `Integer` (rw)

#alpha=(alpha) ⇒ `Integer`, `Float` (rw)

#blue ⇒ `Integer` (rw)

#blue=(blue) ⇒ `Integer`, `Float` (rw)

#green ⇒ `Integer` (rw)

#green=(green) ⇒ `Integer`, `Float` (rw)

#red ⇒ `Integer` (rw)

#red=(red) ⇒ `Integer`, `Float` (rw)

#==(other) ⇒ `Boolean`

#blend(color2, weight) ⇒ `Color`

#to_i ⇒ `Integer`