rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members | Public Member Functions
IlvRadialGradientGeometry Class Reference

Resource class. More...

#include <ilviews/base/port.h>

Inheritance diagram for IlvRadialGradientGeometry:
IlvGradientGeometry

Public Member Functions

 IlvRadialGradientGeometry (IlvPoint startCenter, IlvDim startRadius, IlvPoint endCenter, IlvDim endRadius, IlvGradientTransformMode mode=IlvGradientTransformGraphic, IlvGradientAspectRatio aspectRatio=IlvGradientAspectRatioNo)
 Constructor. More...
 
IlvPoint getEndCenter () const
 Gets the center of the end circle. More...
 
IlvDim getEndRadius () const
 Gets the radius of the end circle. More...
 
IlvPoint getStartCenter () const
 Gets the center of the start circle. More...
 
IlvDim getStartRadius () const
 Gets the radius of the start circle. More...
 
void setEndCenter (IlvPoint center)
 Sets the center of the end circle. More...
 
void setEndRadius (IlvDim radius)
 Sets the radius of the end circle. More...
 
void setStartCenter (IlvPoint center)
 Sets the center of the start circle. More...
 
void setStartRadius (IlvDim radius)
 Sets the radius of the start circle. More...
 
- Public Member Functions inherited from IlvGradientGeometry
IlvGradientAspectRatio getAspectRatio () const
 Gets the aspect ratio of this gradient geometry. More...
 
IlvGradientTransformMode getTransformMode () const
 Gets the transform mode of this gradient geometry. More...
 
void setAspectRatio (IlvGradientAspectRatio aspectRatio)
 Sets the aspect ratio of this gradient geometry. More...
 
void setTransformMode (IlvGradientTransformMode mode)
 Sets the transform mode of this gradient geometry. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvGradientGeometry
 IlvGradientGeometry (IlvGradientTransformMode mode, IlvGradientAspectRatio aspectRatio)
 Constructor. More...
 

Detailed Description

Resource class.

Library: xviews or winviews or mviews (mutually exclusive)

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
startCenterThe center of the start circle.
startRadiusThe radius of the start circle.
endCenterThe center of the end circle.
endRadiusThe radius of the end circle.
modeThe gradient transform mode.
aspectRatioThe 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
centerThe new center of the end circle.
void IlvRadialGradientGeometry::setEndRadius ( IlvDim  radius)

Sets the radius of the end circle.

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

Sets the center of the start circle.

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

Sets the radius of the start circle.

Parameters
radiusThe new radius of the start circle.

© Copyright 2015, 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.