#include <IGradientFill.h>
|
| enum | { kDefaultIID = IID_IGRADIENTFILL } |
| |
A gradient data interface. This is a required data interface for all gradient rednering objects of class kGradientFillRenderObjectBoss.
- See Also
- GradientFillID.h
- GraphicTypes.h
- also IRenderingObject
- also IGradientFillInstall
| virtual void IGradientFill::ClearAll | ( | | ) | |
| pure virtual |
Remove all gradient data and set it back to the default gradient.
| virtual IColorData* IGradientFill::CreateNthColorData | ( | int16 | at | ) | const |
| pure virtual |
Return the IColorData corresponding the nth gradient color stop.
- Parameters
| at | the nth color stop starting from 0. |
- Returns
- the requested IColorData*. This could be nil if nth color UID is no longer valid.
| virtual bool16 IGradientFill::Equals | ( | IGradientFill * | pMatch | ) | const |
| pure virtual |
Return kTrue if both sets of gradient data are equal.
- Parameters
| pMatch | the gradient data to compare with. |
- Returns
- kTrue if equal otherwise kFalse.
| virtual IDataBase* IGradientFill::GetDataBase | ( | void | | ) | |
| pure virtual |
Return the data base associated with this gradient data.
- Returns
- the data base associated with this gradient data. IDataBase* can be nil if gradient object does not have a assoicated database or if a data base cannot be identified.
| virtual GradientType IGradientFill::GetGradientFillType | ( | | ) | const |
| pure virtual |
Return the gradient type. This is either kAxial or kRadial.
- Returns
- the gradient type.
- See Also
- GraphicTypes.h
| virtual UID IGradientFill::GetNthGradientColorUID | ( | int16 | index | ) | const |
| pure virtual |
Return the color swatch UID corresponding the nth gradient color stop.
- Parameters
| at | the nth color stop starting from 0. |
- Returns
- the requested color UID.
| virtual PMReal IGradientFill::GetNthGradientMidPoint | ( | int16 | index | ) | const |
| pure virtual |
Return the nth midpoint position.
- Parameters
| index | the nth color stop position starting from 0. |
- Returns
- the midpoint position.
| virtual PMReal IGradientFill::GetNthMidPointRelativeLocation | ( | int16 | index | ) | const |
| pure virtual |
Return the nth relative midpoint position.
- Parameters
| index | the nth color stop position starting from 0. |
- Returns
- the relative midpoint position.
| virtual PMReal IGradientFill::GetNthStopPosition | ( | int16 | index | ) | const |
| pure virtual |
Return the nth color stop position.
- Parameters
| index | the nth color stop position starting from 0. |
- Returns
- the color stop position.
| virtual int16 IGradientFill::GetNumberOfStop | ( | | ) | const |
| pure virtual |
Return the number of gradient stops.
- Returns
- the number of gradient stops.
| virtual void IGradientFill::InsertGradientColorUID | ( | int16 | index, | | | UID | colorUID | | ) | | |
| pure virtual |
Insert the specified color UID at the nth position.
- Parameters
| index | the nth color stop to insert starting from 0. |
| colorUID | the new color UID to insert. This colorUID is any color rendering objects, kPMColorBoss. |
- See Also
- ColorSystemsID.h
- IColorData
Return the list of IColorData corresponding to the list of gradient color stops.
- Parameters
- See Also
- IColorData
| virtual void IGradientFill::RemoveNthGradientColorUID | ( | int16 | index | ) | |
| pure virtual |
Remove the specified color UID from the nth position.
- Parameters
| index | the nth color stop to remove starting from 0. |
| virtual void IGradientFill::SetGradientFillType | ( | const GradientType & | gradType | ) | |
| pure virtual |
Set gradient type. Gradient type is either kAxial or kRadial.
- Parameters
| gradType | the new gradient type to set. |
- See Also
- GraphicTypes.h
| virtual void IGradientFill::SetNthGradientColorUID | ( | int16 | index, | | | UID | colorUID | | ) | | |
| pure virtual |
Set the nth color stop color UID.
- Parameters
| index | the nth color stop to set starting from 0. |
| colorUID | the new color UID to set. This colorUID is any color rendering objects, kPMColorBoss. |
- See Also
- ColorSystemsID.h
- IColorData
| virtual void IGradientFill::SetNthGradientMidPoint | ( | int16 | index, | | | PMReal | midPoint | | ) | | |
| pure virtual |
Set the nth midpoint position. The minimum mid point position is 0.13, the maximum is 0.87, and the default value is 0.5.
- Parameters
| index | the nth midpoint to set starting from 0. |
| boundValue | the new midpoint position. |
| virtual void IGradientFill::SetNthMidPointRelativeLocation | ( | int16 | index, | | | PMReal | value | | ) | | |
| pure virtual |
Set the nth relative midpoint position.
- Parameters
| index | the nth color stop to set starting from 0. |
| value | the new relative mid point position. |
| virtual void IGradientFill::SetNthStopPosition | ( | int16 | index, | | | PMReal | boundValue | | ) | | |
| pure virtual |
Set the nth color stop position. This value should be a number between 0 and 1.
- Parameters
| index | the nth stop position to set starting from 0. |
| boundValue | the new color position. |
| virtual void IGradientFill::SetNumberOfStop | ( | int16 | gradColorNum | ) | |
| pure virtual |
Initialize the nubmer color stops this gradient will have.
- Parameters
| gradColorNum | the number of color stops to set.. |
Public Member Functions inherited from IPMUnknown
1.8.3.1 
