rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvRadialGradientGeometry Class Reference

Resource class. More...

#include <ilviews/base/port.h>

Inheritance diagram for IlvRadialGradientGeometry:
IlvGradientGeometry

List of all members.

Public Member Functions

 IlvRadialGradientGeometry (IlvPoint startCenter, IlvDim startRadius, IlvPoint endCenter, IlvDim endRadius, IlvGradientTransformMode mode=IlvGradientTransformGraphic, IlvGradientAspectRatio aspectRatio=IlvGradientAspectRatioNo)
 Constructor.
IlvPoint getEndCenter () const
 Gets the center of the end circle.
IlvDim getEndRadius () const
 Gets the radius of the end circle.
IlvPoint getStartCenter () const
 Gets the center of the start circle.
IlvDim getStartRadius () const
 Gets the radius of the start circle.
void setEndCenter (IlvPoint center)
 Sets the center of the end circle.
void setEndRadius (IlvDim radius)
 Sets the radius of the end circle.
void setStartCenter (IlvPoint center)
 Sets the center of the start circle.
void setStartRadius (IlvDim radius)
 Sets the radius of the start circle.

Detailed Description

Resource class.

Library: display

The IlvRadialGradientGeometry class enables you specify geometrical properties dedicated to radial gradients. A radial gradient geometry is defined by a start and an end circle. The centers of the 2 circles must be contained within the IlvGradientPattern area defined by its width and height. The abscissas of these centers must be set between 0 and IlvPattern::width. The ordinates of these centers must be set between 0 and IlvPattern::height. The start circle must be contained within the end circle, otherwise the rendering becomes unpredictable, depending on whether you are drawing using Cairo or GDI+.

See also:
IlvGradientGeometry, IlvLinearGradientGeometry, IlvGradientPattern::setGeometry IlvPattern::width, IlvGradientPattern::setWidth, IlvPattern::height and IlvGradientPattern::setHeight.

Constructor & Destructor Documentation

IlvRadialGradientGeometry::IlvRadialGradientGeometry ( IlvPoint  startCenter,
IlvDim  startRadius,
IlvPoint  endCenter,
IlvDim  endRadius,
IlvGradientTransformMode  mode = IlvGradientTransformGraphic,
IlvGradientAspectRatio  aspectRatio = IlvGradientAspectRatioNo 
)

Constructor.

This constructor initializes a new IlvRadialGradientGeometry instance.

Parameters:
startCenter The center of the start circle.
startRadius The radius of the start circle.
endCenter The center of the end circle.
endRadius The radius of the end circle.
mode The gradient transform mode.
aspectRatio The gradient aspect ratio.

Member Function Documentation

IlvPoint IlvRadialGradientGeometry::getEndCenter (  )  const

Gets the center of the end circle.

Returns:
The center of the end circle of the gradient geometry.
IlvDim IlvRadialGradientGeometry::getEndRadius (  )  const

Gets the radius of the end circle.

Returns:
The radius of the end circle of the gradient geometry.
IlvPoint IlvRadialGradientGeometry::getStartCenter (  )  const

Gets the center of the start circle.

Returns:
The center of the start circle of the gradient geometry.
IlvDim IlvRadialGradientGeometry::getStartRadius (  )  const

Gets the radius of the start circle.

Returns:
The radius of the start circle of the gradient geometry.
void IlvRadialGradientGeometry::setEndCenter ( IlvPoint  center  ) 

Sets the center of the end circle.

Parameters:
center The new center of the end circle.
void IlvRadialGradientGeometry::setEndRadius ( IlvDim  radius  ) 

Sets the radius of the end circle.

Parameters:
radius The new radius of the end circle.
void IlvRadialGradientGeometry::setStartCenter ( IlvPoint  center  ) 

Sets the center of the start circle.

Parameters:
center The new center of the start circle.
void IlvRadialGradientGeometry::setStartRadius ( IlvDim  radius  ) 

Sets the radius of the start circle.

Parameters:
radius The new radius of the start circle.

© 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.