Gradient
Inherits: Resource < Reference < Object
Category: Core
Brief Description
Color interpolator node.
Properties
PoolColorArray | colors |
PoolRealArray | offsets |
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 ) |
Description
Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color 3, 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 0 and the other (white) at the ramp higher offset 1.
Property Descriptions
- PoolColorArray colors
Setter | set_colors(value) |
Getter | get_colors() |
Gradient’s colors returned as a PoolColorArray.
- PoolRealArray offsets
Setter | set_offsets(value) |
Getter | get_offsets() |
Gradient’s offsets returned as a PoolRealArray.
Method Descriptions
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 offset of the ramp color at index point
- 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
Sets the color of the ramp color at index point
Sets the offset for the ramp color at index point