Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
DOM::Utils::IRadialColorGradient Class Referenceabstract

This interface represents the radial color gradient. More...

#include <IRadialColorGradient.h>

Inheritance diagram for DOM::Utils::IRadialColorGradient:

Public Member Functions

virtual FCM::Result _FCMCALL GetKeyColorCount (FCM::U_Int8 &nColors)=0
 This function gets the number of key points in the gradient ramp. Each key point contains a color and its position in the gradient. More...
 
virtual FCM::Result _FCMCALL GetKeyColorAtIndex (FCM::U_Int8 index, GRADIENT_COLOR_POINT &colorpoint)=0
 This function gets a specific key point in a color ramp. Each key point contains a color and its position in the gradient. More...
 
virtual Result _FCMCALL GetFocalPoint (FCM::S_Int32 &focalPoint)=0
 This function gets the focal point (meaningful only for radial interpolation). Focal point specifies the horizontal offset of the focal point from the transformation point. More...
 

Detailed Description

This interface represents the radial color gradient.

Member Function Documentation

virtual Result _FCMCALL DOM::Utils::IRadialColorGradient::GetFocalPoint ( FCM::S_Int32 &  focalPoint)
pure virtual

This function gets the focal point (meaningful only for radial interpolation). Focal point specifies the horizontal offset of the focal point from the transformation point.

Parameters
focalPoint(OUT) Horizontal offset of the focal point from the transformation point.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL DOM::Utils::IRadialColorGradient::GetKeyColorAtIndex ( FCM::U_Int8  index,
GRADIENT_COLOR_POINT &  colorpoint 
)
pure virtual

This function gets a specific key point in a color ramp. Each key point contains a color and its position in the gradient.

Parameters
index(IN) The index of a particular key color. It can vary from 0 to GetKeyColorCount() - 1
colorpoint(OUT) The value of a color and its position in the color ramp.
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
virtual FCM::Result _FCMCALL DOM::Utils::IRadialColorGradient::GetKeyColorCount ( FCM::U_Int8 &  nColors)
pure virtual

This function gets the number of key points in the gradient ramp. Each key point contains a color and its position in the gradient.

Parameters
nColors(OUT) Number of points in the color ramp
Returns
On success, FCM_SUCCESS is returned, else an error code is returned.
The documentation for this class was generated from the following file: