Gradient

Inherits: Resource < Reference < Object

A color interpolator resource which can be used to generate colors between user-defined color points.

Description

Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the ramp will interpolate from color 1 to color 2 and from color 2 to color 3. The ramp will initially have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1.

Properties

PoolColorArray	colors	PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )
PoolRealArray	offsets	PoolRealArray( 0, 1 )

Methods

void	add_point ( float offset, Color color )
Color	get_color ( int point ) const
float	get_offset ( int point ) const
int	get_point_count ( ) const
Color	interpolate ( float offset )
void	remove_point ( int offset )
void	set_color ( int point, Color color )
void	set_offset ( int point, float offset )

Property Descriptions

PoolColorArray colors

Default	PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )
Setter	set_colors(value)
Getter	get_colors()

Gradient's colors returned as a PoolColorArray.

PoolRealArray offsets

Default	PoolRealArray( 0, 1 )
Setter	set_offsets(value)
Getter	get_offsets()

Gradient's offsets returned as a PoolRealArray.

Method Descriptions

void add_point ( float offset, Color color )

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

Color get_color ( int point ) const

Returns the color of the ramp color at index point.

float get_offset ( int point ) const

Returns the offset of the ramp color at index point.

int get_point_count ( ) const

Returns the number of colors in the ramp.

Color interpolate ( float offset )

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.

void set_offset ( int point, float offset )

Sets the offset for the ramp color at index point.