Color class

The Color class is used to create and manipulate colors within SketchUp models. 

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:

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]

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

Parent: Object

Methods: blend, names, new, alpha, alpha= , blend, blue, blue= , green , green=, red, red= , to_a , to_i , to_s

Example Code: colortests.rb

Class Methods

blend

The blend method is used to blend two colors into one.

Syntax

color3 = Sketchup::Color.blend color1, color2, weight

Arguments

color1 - first color to be blended

color2 - second color to be blended

weight - a value between 0 and 1 that controls how much of each color to use for blending.

Return Value

color3 - the new Color object if successful

Comments

The blended color will be the result of taking (1 - weight)*color1 + weight * color2. For example, a weight of .25 will result in a color where .25 is derived from color1 and .75 from color2. If weight = 0, you will get color2. If weight = 1 you will get color1.

Example

color1 = Sketchup::Color.new "OldLace"
color2 = Sketchup::Color.new "AliceBlue" 




begin
color = Sketchup::Color.blend color1, color2, 1
rescue
UI.messagebox $!.message
end



if (color)
UI.messagebox color
else
UI.messagebox "Failure"
end  

names

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

Syntax

names = Geom::Color.names

Return Value

names - an array of all SketchUp color names if successful

Comments

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

Example

array = Sketchup::Color.names 



if (array)
UI.messagebox array[0]
else
UI.messagebox "Failure"
end

new

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

Syntax

color = Sketchup::Color.new red, green, blue 



color = SketchUp::Color.new "name"

Arguments

red - a red value 

green - a green value

blue - a blue value

"name" - the name of a color that currently exists in SketchUp. See the table at the start of this class description for more information.

Return Value

color - a Color object if successful

Example

color = Sketchup::Color.new "OldLace" 



if (color)
UI.messagebox color
else
UI.messagebox "Failure"
end

Instance Methods

alpha

The alpha method is used to retrieve the opacity of the color.

Syntax

alpha = color.alpha

Return Value

alpha - the opacity of the color if successful

Example

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



if (alpha)
UI.messagebox alpha
else
UI.messagebox "Failure"
end

alpha=

The alpha= method is used to set the opacity of the color.

Syntax

alpha = color.alpha = alpha

Arguments

alpha - the new opacity value

Return Value

alpha - the newly set opacity value if successful

Comments

0 is transparent, 255 is opaque.

Example

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



if (alpha)
UI.messagebox alpha
else
UI.messagebox "Failure"
end

blend

The blend method is used to blend two colors.

Syntax

color3 = color1.blend color2, weight

Arguments

color2 - the second color to be blended (with color1) 

weight - ?

Return Value

color3 - the newly blended Color object if successful

Comments

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.

Example

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



UI.messagebox $!.message      
if (color3)
UI.messagebox color3
else
UI.messagebox "Failure"
end          

blue

The blue method is used to retrieve the blue value of a color. Colors are comprised of red, green, and blue values.

Syntax

blue = color.blue

Return Value

blue - the blue value for the color if successful

Comments

Value range is 0 to 255.

Example

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



if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end

blue=

The blue= method is used to set the blue value of a color. Colors are comprised of red, green, and blue values.

Syntax

blue = color.blue = blue

Arguments

blue - the blue value for the color

Return Value

blue - the new blue value for the color if successful

Comments

Value range is 0 to 255.

Example

color = Sketchup::Color.new "AliceBlue"
setting = color.blue=200
if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end         

green

The green method is used to retrieve the green value of a color. Colors are comprised of red, green, and blue values.

Syntax

green = color.green

Return Value

green - the green value for the color if successful

Comments

Value range is 0 to 255.

Example

color = Sketchup::Color.new "AliceBlue"
setting = color.green
if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end     

green=

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

Syntax

green = color.green = green

Arguments

green - the green value for the color

Return Value

green - the new green value for the color if successful

Comments

Value range is 0 to 255.

Example

color = Sketchup::Color.new "AliceBlue"
setting = color.green=200
if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end

red

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

Syntax

red = color.red

Return Value

red - the red value for the color if successful

Comments

Value range is 0 to 255.

Example

color = Sketchup::Color.new "AliceBlue"
setting = color.red
if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end

red=

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

Syntax

red = color.red = red

Arguments

red - the red value for the color

Return Value

red - the new red value for the color if successful

Comments

Value range is 0 to 255.

Example

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



if (setting)
UI.messagebox setting
else
UI.messagebox "Failure"
end

to_a

The to_a method is used to convert a Color object to an Array object.

Syntax

array = color.to_a

Return Value

array - an Array object if successful

Example

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

if (ascii)
UI.messagebox ascii
else
UI.messagebox "Failure"
end

to_i

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

Syntax

integer = color.to_i

Return Value

integer - a 32 bit integer if successful

Example

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



if (integer)
UI.messagebox integer
else
UI.messagebox "Failure"
end

to_s

The to_s method is used to convert a Color object to a string.

Syntax

string = color.to_s

Return Value

string - a string representation of the Color object if successful

Example

color = Sketchup::Color.new "AliceBlue"
str = color.to_s 


if (str)
UI.messagebox str
else
UI.messagebox "Failure"
end