Color

class

• Introduction
• Methods
• • alpha
  • alpha=
  • blend
  • blue
  • blue=
  • green
  • green=
  • names
  • new
  • red
  • red=
  • to_a
  • to_i
  • to_s

Introduction

     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]

Methods

Color.alphaSketchUp 6.0+

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

Returns:

alpha

the opacity of the color if successful

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

Color.alpha=SketchUp 6.0+

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

NOTE: Though documented historically in the Ruby API, this method has never been implemented.

Arguments:

alpha

The new opacity value.

Returns:

alpha

the newly set opacity value if successful

 # NOTE: Assigning an alpha does not actually work.
 color = Sketchup::Color.new "AliceBlue"
 alpha = color.alpha = 255 

Color.blendSketchUp 6.0+

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.

Arguments:

color2

The second color to be blended (with this color).

weight

A Float between 0.0 and 1.0

Returns:

color3

the newly blended Color object if successful

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

Color.blueSketchUp 6.0+

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

Value range is 0 to 255.

Returns:

blue

the blue value for the color if successful

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

Color.blue=SketchUp 6.0+

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

Value range is 0 to 255.

Arguments:

blue

The blue value for the color.

Returns:

blue

the new blue value for the color if successful

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

Color.greenSketchUp 6.0+

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

Value range is 0 to 255.

Returns:

green

the green value for the color if successful

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

Color.green=SketchUp 6.0+

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

Value range is 0 to 255.

Arguments:

green

The green value for the color.

Returns:

green

the new green value for the color if successful

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

Color.namesSketchUp 6.0+

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.

Returns:

names

an array of all SketchUp color names if successful

 array = Sketchup::Color.names

Color.newSketchUp 6.0+

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

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.

Returns:

color

a Color object if successful

 color = Sketchup::Color.new "OldLace" 

Color.redSketchUp 6.0+

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

Value range is 0 to 255.

Returns:

red

the red value for the color if successful

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

Color.red=SketchUp 6.0+

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

Value range is 0 to 255.

Arguments:

red

The red value for the color.

Returns:

red

the new red value for the color if successful

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

Color.to_aSketchUp 6.0+

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.

Returns:

array

an Array object if successful

 color = Sketchup::Color.new "AliceBlue"
 color_array = color.to_a
 if (color_array)
   UI.messagebox color_array.to_s
 else
   UI.messagebox "Failure"
 end

Color.to_iSketchUp 6.0+

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

Returns:

integer

a 32 bit integer if successful

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

Color.to_sSketchUp 6.0+

Returns a string representation of a Color object, in the form of "Color(255, 255, 255, 255)".

Returns:

string

a String name for the Color.

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