rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvColorStop Class Reference

#include <ilviews/base/port.h>

List of all members.

Public Member Functions

 IlvColorStop (IlvColor *color, IlFloat offset, IlvIntensity alpha=IlvFullIntensity)
 Constructor.
IlvIntensity getAlpha () const
 Gets the alpha value.
IlvColorgetColor () const
 Gets the color.
IlFloat getOffset () const
 Gets the offset.
void setAlpha (IlvIntensity alpha)
 Sets the alpha value.
void setColor (IlvColor *color)
 Sets the color.
void setOffset (IlFloat offset)
 Sets the offset.

Detailed Description

Library: display

Class implementing gradient color stops. A color stop is defined by a color, an alpha value and an offset between 0 and 1. The offset indicates where the color stop should take place along the gradient, 0 being the beginning of the gradient, and 1 the end.

See also:
IlvGradientPattern

Constructor & Destructor Documentation

IlvColorStop::IlvColorStop ( IlvColor color,
IlFloat  offset,
IlvIntensity  alpha = IlvFullIntensity 
)

Constructor.

This constructor initializes a new IlvColorStop instance.

Parameters:
color The color.
offset An offset value in the range [0.0 .. 1.0].
alpha An alpha value.

Member Function Documentation

IlvIntensity IlvColorStop::getAlpha (  )  const

Gets the alpha value.

Returns:
The alpha value of the color stop.
IlvColor* IlvColorStop::getColor (  )  const

Gets the color.

Returns:
The color set on this color stop.
IlFloat IlvColorStop::getOffset (  )  const

Gets the offset.

Returns:
The offset of this color stop.
void IlvColorStop::setAlpha ( IlvIntensity  alpha  ) 

Sets the alpha value.

The alpha value indicates the amount of transparency of this color stop.

Parameters:
alpha The alpha value to set on the color stop.
void IlvColorStop::setColor ( IlvColor color  ) 

Sets the color.

Parameters:
color The color to set on the color stop.
void IlvColorStop::setOffset ( IlFloat  offset  ) 

Sets the offset.

The offset value should be between 0 and 1 and indicates where the color stop should take place along the gradient, 0 being the beginning of the gradient, and 1 the end.

Parameters:
offset The offset to set on the color stop.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.