ColorRamp

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Color interpolator node

Member Functions

void add_point ( float offset, Color color )
Color get_color ( int point ) const
ColorArray get_colors ( ) const
float get_offset ( int point ) const
RealArray get_offsets ( ) const
int get_point_count ( ) const
Color interpolate ( float offset )
void remove_point ( int offset )
void set_color ( int point, Color color )
void set_colors ( ColorArray colors )
void set_offset ( int point, float offset )
void set_offsets ( RealArray offsets )

Description

Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1.

Member Function Description

Adds the specified color to the end of the ramp, with the specified offset

Returns the color of the ramp color at index point

Returns the colors in the ramp

Returns the offset of the ramp color at index point

Returns the offsets for the colors in this ramp

  • int get_point_count ( ) const

Returns the number of colors in the ramp

Returns the interpolated color specified by offset

  • void remove_point ( int offset )

Removes the color at the index offset

  • void set_color ( int point, Color color )

Sets the color of the ramp color at index point

Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.

  • void set_offset ( int point, float offset )

Sets the offset for the ramp color at index point

Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.