Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvLinearGradientGeometry Class Reference

Resource class. More...

#include <ilviews/base/port.h>

Inheritance diagram for IlvLinearGradientGeometry:
IlvGradientGeometry

Public Member Functions

 IlvLinearGradientGeometry (IlvPoint startPoint, IlvPoint endPoint, IlvGradientTransformMode mode=IlvGradientTransformGraphic, IlvGradientAspectRatio aspectRatio=IlvGradientAspectRatioInside)
 Constructor. More...
 
IlvPoint getEndPoint () const
 Gets the end point of this gradient geometry. More...
 
IlvPoint getStartPoint () const
 Gets the start point of this gradient geometry. More...
 
void setEndPoint (IlvPoint end)
 Sets the end point of this gradient geometry. More...
 
void setStartPoint (IlvPoint start)
 Sets the start point of this gradient geometry. 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 IlvLinearGradientPattern class enables you specify geometrical properties dedicated to linear gradients. A linear gradient geometry is defined by a start and an end point. The coordinates of the 2 points must be contained within the IlvGradientPattern area defined by its width and height. The abscissas of these points must be set between 0 and IlvPattern::width. The ordinates of these points must be set between 0 and IlvPattern::height.

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

Constructor & Destructor Documentation

IlvLinearGradientGeometry::IlvLinearGradientGeometry ( IlvPoint  startPoint,
IlvPoint  endPoint,
IlvGradientTransformMode  mode = IlvGradientTransformGraphic,
IlvGradientAspectRatio  aspectRatio = IlvGradientAspectRatioInside 
)

Constructor.

This constructor initializes a new IlvLinearGradientGeometry instance.

Parameters
startPointThe start point.
endPointThe end point.
modeThe gradient transform mode.
aspectRatioThe gradient aspect ratio.

Member Function Documentation

IlvPoint IlvLinearGradientGeometry::getEndPoint ( ) const

Gets the end point of this gradient geometry.

Returns
The end point of the gradient geometry.
IlvPoint IlvLinearGradientGeometry::getStartPoint ( ) const

Gets the start point of this gradient geometry.

Returns
The start point of the gradient geometry.
void IlvLinearGradientGeometry::setEndPoint ( IlvPoint  end)

Sets the end point of this gradient geometry.

Parameters
endThe new end point.
void IlvLinearGradientGeometry::setStartPoint ( IlvPoint  start)

Sets the start point of this gradient geometry.

Parameters
startThe new start point.

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