Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions | Friends
IlvGradientGeometry Class Reference

Resource class. More...

#include <ilviews/base/port.h>

Inheritance diagram for IlvGradientGeometry:
IlvLinearGradientGeometry IlvRadialGradientGeometry

Public Member Functions

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

Protected Member Functions

 IlvGradientGeometry (IlvGradientTransformMode mode, IlvGradientAspectRatio aspectRatio)
 Constructor. More...
 

Friends

class IlvGradientPattern
 

Detailed Description

Resource class.

Library: xviews or winviews or mviews (mutually exclusive)

Base class for gradient geometries. This class is common to all types of gradient and manages the transform mode and aspect ratio to apply when drawing the gradient pattern.

See also
IlvLinearGradientGeometry, IlvRadialGradientGeometry, IlvGradientPattern::setGeometry

Constructor & Destructor Documentation

◆ IlvGradientGeometry()

IlvGradientGeometry::IlvGradientGeometry ( IlvGradientTransformMode  mode,
IlvGradientAspectRatio  aspectRatio 
)
protected

Constructor.

This constructor initializes a new IlvGradientGeometry.

Parameters
modeThe gradient transform mode.
aspectRatioThe gradient aspect ratio.

Member Function Documentation

◆ getAspectRatio()

IlvGradientAspectRatio IlvGradientGeometry::getAspectRatio ( ) const

Gets the aspect ratio of this gradient geometry.

Returns
The aspect ratio of the gradient geometry.

◆ getTransformMode()

IlvGradientTransformMode IlvGradientGeometry::getTransformMode ( ) const

Gets the transform mode of this gradient geometry.

Returns
The transform mode of the gradient geometry.

◆ setAspectRatio()

void IlvGradientGeometry::setAspectRatio ( IlvGradientAspectRatio  aspectRatio)

Sets the aspect ratio of this gradient geometry.

Parameters
aspectRatioThe new aspect ratio.

◆ setTransformMode()

void IlvGradientGeometry::setTransformMode ( IlvGradientTransformMode  mode)

Sets the transform mode of this gradient geometry.

Parameters
modeThe new transform mode.