FillRamp Class Reference

The base class fill ramp. This class contains common functionality between colour and transparency ramps. Each ramp entry derived from RampItem will contain a selection state and a (float) parameter value. The parameter value usually ranges between 0 and 1 and hence can be used to generate a coordinate from any given fill geometry. More...

#include <fillramp.h>

Inheritance diagram for FillRamp:

List of all members.

Public Member Functions
void	GetSelectionState (BOOL *SelState) const
	Record the selection state of all the ramp blobs in this array.
UINT32	CountSelBlobs () const
	Simply count all the selected items in this list.
INT32	GetSelectedIndex () const
	Return the index of the first selected item in this list. The index is adjusted by FILLRAMP_INDEXBASE i.e. this constant value is always added to an index to give the range [FILLRAMP_INDEXBASE...FILLRAMP_INDEXBASE+n-1]. This is done so one can distinguish between indexes for fill geometry end points (usually 0..7 or thereabouts) and the fill ramp blobs.
BOOL	GetIndexRange (UINT32 *pFirst, UINT32 *pLast) const
	Return the index of the first and last entries in this list. As the list indexes are biased by an unknown value, at least unknown to everyone but the author, one needs to use this class function to find out the values of the first and last indexes. All I'll tell you is that they behaviour linearly between the two extreems.
BOOL	IsSelected (UINT32 index) const
	Find out whether this ramp index is selected or not.
void	DeselectAll () const
	Deselect all selection states in this fill ramp.
FillControl	RotateSelRight (BOOL StartPointSelected, BOOL EndPointSelected, FillControl &OldSelectedBlob) const
	Roll the selection state of the items in the list to the right. That equates to rolling the selection down the list by one element.
BOOL	RotateSelLeft (BOOL StartPointSelected, BOOL EndPointSelected, FillControl &OldSelectedBlob) const
	Roll the selection state of the items in the list to the left. That equates to rolling the selection up the list by one element.
void	SetSelState (UINT32 index, INT32 state)
	Sets the state of a fill ramp blob.
UINT32	SetPosition (UINT32 index, float pos)
	Sets the position of an existing ramp item identified by index. As we keep our list of items ordered on position, the fact that it is being changed will likely result in a shuffling of the item in the list. Hence we return a new index (which obviously may or may not be the same as index). Those who are keeping up amoung you might even be able to spot when an item shuffles by looking at the input and ouput index values.
UINT32	HitBlob (FillGeometryAttribute *pGeom, DocCoord &ClickPos) const
	Check to see if a ramp item was hit by this click. If so return yes. We also set and internal pointer on the result of this check, which can be used to make edits.
DocCoord	GetGeometryCoord (FillGeometryAttribute *pGeom, UINT32 index) const
	Find the absolute coordinate of Blob[index]. The start coordinate will be returned if index is out of range.
void	RenderRampBlobs (FillGeometryAttribute *pGeom, RenderRegion *pRender, BOOL *pSelState=NULL) const
	Render the fill blobs in their positions as they appear on the geometry this fill ramp is associated with. We simply ask the geometry where they are and render appropriately.
void	RenderSelectedBlob (FillGeometryAttribute *pGeom, RenderRegion *pRender)
void	SortRamp ()
	Ensures all positions of all items in the list are in numerical order.
RampItem *	GetValidIndexedItem (UINT32 index) const
	Find the i'th item in this fill ramp. The index is the normal biased index passed into us from the external world. We convert the index and perform some error checking on it before we attempt to find the relevant item.
void	Blend (FillGeometryAttribute *pNewAttr, BlendAttrParam *pBlendParam, FillGeometryAttribute *pOtherFill, BOOL notInvert=FALSE)
	Blends mutistage fill ramps. Well actually its support functions do, but this one works out which blending case we are doing.
Protected Member Functions
RampItem *	GetIndexedItem (INT32 index) const
	Find the i'th item in this fill ramp.
UINT32	InsertNewItem (RampItem *pItem)
	Adds pNewItem to the growing list.
Private Member Functions
RampItem *	FindInsertPosition (float pos, INT32 *pInsert, UINT32 *index) const
	Finds an insert context given a position. The idea is, if you have a new record to add, it needs to be added to the list after all items with a position less than pos. This func finds the insert position and returns a value indicating before or after. The index of your new item will depend on the pInsert value. If 0, then the new index will be (*pIndex) otherwise its (*pIndex)+1;.
UINT32	ShuffleItem (RampItem *pItem, UINT32 index)
	ShuffleItem checks the validity of pItem. If the item's position in the list is invalid, it will be shuffled into a valid position. This needs to be done when the position parameter is changed, as we keep an ascending order of item positions.
void	DoOneToOneBlend (FillGeometryAttribute *pNewAttr, BlendAttrParam *pBlendParam, FillRamp *OtherRamp, BOOL notInvert)
	Blends mutistage fill ramps. This function blends equal numbers of blobs.
void	DoNoneToManyBlend (FillGeometryAttribute *pNewAttr, BlendAttrParam *pBlendParam, FillRamp *OtherRamp, BOOL notInvert)
	Blends mutistage fill ramps. This function blends none to many blobs.
void	DoManyToNoneBlend (FillGeometryAttribute *pNewAttr, BlendAttrParam *pBlendParam, FillGeometryAttribute *pOtherFill, BOOL notInvert)
	Blends mutistage fill ramps. This function blends many to no none fill blobs.
void	DoManyToManyBlend (FillGeometryAttribute *pNewAttr, BlendAttrParam *pBlendParam, FillRamp *OtherRamp, BOOL notInvert)
	Blends mutistage fill ramps. This function handles the many to many case.

---

Detailed Description

The base class fill ramp. This class contains common functionality between colour and transparency ramps. Each ramp entry derived from RampItem will contain a selection state and a (float) parameter value. The parameter value usually ranges between 0 and 1 and hence can be used to generate a coordinate from any given fill geometry.

Author:

Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>

Date:

05/02/97

Definition at line 241 of file fillramp.h.

---

Member Function Documentation

void FillRamp::Blend (  FillGeometryAttribute *  pNewAttr, BlendAttrParam *  pBlendParam, FillGeometryAttribute *  pOtherFill, BOOL  notInvert = FALSE )

Blends mutistage fill ramps. Well actually its support functions do, but this one works out which blending case we are doing. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 17/4/2000 Parameters: [INPUTS]  [OUTPUTS]  CGS: I've added the ability to avoid inverting ratios (by passing notInvert as TRUE). (only DoManyToNoneBlend () makes use of this at the moment) Definition at line 520 of file fillramp.cpp. { //ERRORIF (!pOtherFill, "Dodgy entry params!", NULL); FillRamp* OtherRamp = pOtherFill->GetColourRamp (); // if neither contains a fill ramp - then return if ((this == NULL) && (OtherRamp == NULL)) { return; } // ok we've got at least one fillramp - so proceed .... // now decide the type of blending that we need to do .... enum MappingType { MT_ONETOONE, // equal numbers of fill blobs MT_NONETOMANY, // no fill blobs to many MT_MANYTONONE, // many fill blobs to none MT_MANYTOMANY, // many fills blobs to many fills blobs // (but different numbers of fill blobs) //MT_MANYTOMANYLESS, // less fill blobs to more fill blobs //MT_MANYTOMANYMORE, // more fill blobs to less fill blobs MT_NONE }; // sensible default MappingType FunctionMapper = MT_NONE; if (this == NULL) { if (OtherRamp != NULL) { FunctionMapper = MT_NONETOMANY; } // else - nothing (this is impossible) } else if (OtherRamp == NULL) { if (this != NULL) { FunctionMapper = MT_MANYTONONE; } // else - nothing (this is impossible) } else { if (GetCount () == OtherRamp->GetCount ()) { FunctionMapper = MT_ONETOONE; } else { // were in the dreaded many-to-many case .... FunctionMapper = MT_MANYTOMANY; } } // invoke the appropriate support function .... switch (FunctionMapper) { case MT_ONETOONE: { DoOneToOneBlend (pNewAttr, pBlendParam, OtherRamp, notInvert); } break; case MT_NONETOMANY: { DoNoneToManyBlend (pNewAttr, pBlendParam, OtherRamp, notInvert); } break; case MT_MANYTONONE: { DoManyToNoneBlend (pNewAttr, pBlendParam, pOtherFill, notInvert); } break; case MT_MANYTOMANY: { DoManyToManyBlend (pNewAttr, pBlendParam, OtherRamp, notInvert); } break; default: return; // um ..... break; } }

UINT32 FillRamp::CountSelBlobs (   )  const

Simply count all the selected items in this list. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: -  [INPUTS] Returns: The number of selected items in this list Definition at line 1168 of file fillramp.cpp. { // perform a ROL on the selection in this fill ramp UINT32 count=0; RampItem *pItem = (RampItem*)GetHead(); while (pItem) { count += ((pItem->GetSelState()==TRUE) ? 1 : 0); pItem = (RampItem*)GetNext(pItem); } return count; }

void FillRamp::DeselectAll (   )  const

Deselect all selection states in this fill ramp. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: -  [INPUTS] Definition at line 443 of file fillramp.cpp. { RampItem *pItem = (RampItem*)GetHead(); while (pItem) { pItem->SetSelState(FALSE); pItem = (RampItem*)GetNext(pItem); } }

void FillRamp::DoManyToManyBlend (  FillGeometryAttribute *  pNewAttr, BlendAttrParam *  pBlendParam, FillRamp *  OtherRamp, BOOL  notInvert )  [private]

Blends mutistage fill ramps. This function handles the many to many case. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 18/4/2000 Parameters: [INPUTS]  [OUTPUTS]  Definition at line 842 of file fillramp.cpp. { // find what point along the blend we are at double Ratio = pBlendParam->GetBlendRatio (); DocColour BlendedColour; ColourContext *cc = ColourManager::GetColourContext (COLOURMODEL_RGBT); RampItem* pItem = (RampItem*) GetHead (); RampItem* pOtherItem = (RampItem*) OtherRamp->GetHead (); ColourRamp* NewColourRamp1 = new ColourRamp (); *NewColourRamp1 = *((ColourRamp*) this); ColourRamp* NewColourRamp2 = new ColourRamp (); *NewColourRamp2 = *((ColourRamp*) OtherRamp); ColourRamp* NewColourRamp3 = new ColourRamp (); ColRampItem* pFirstItem = (ColRampItem*) GetHead (); ColRampItem* pSecondItem = (ColRampItem*) OtherRamp->GetHead (); DocColour* StartCol = NULL;//pNewAttr->GetStartColour (); DocColour* EndCol = NULL;//&pFirstItem->GetColour (); DocColour tempStartCol; DocColour tempEndCol; // these avoid taking the address of a temporary // now insert the first blobs into the second .... float PrevPos = -1, NextPos = -1; while (pSecondItem) { ColRampItem* pNewItem = new ColRampItem (*pSecondItem); NewColourRamp1->InsertNewItem (pNewItem); ColRampItem* pPrevItem = (ColRampItem*) NewColourRamp1->GetPrev (pNewItem); ColRampItem* pNextItem = (ColRampItem*) NewColourRamp1->GetNext (pNewItem); if (!pPrevItem) { StartCol = pNewAttr->GetStartColour (); PrevPos = 0.0; } else { tempStartCol = pPrevItem->GetColour (); StartCol = &tempStartCol; PrevPos = pPrevItem->GetPosition (); } if (!pNextItem) { EndCol = pNewAttr->GetEndColour (); NextPos = 1.0; } else { tempEndCol = pNextItem->GetColour (); EndCol = &tempEndCol; NextPos = pNextItem->GetPosition (); } BlendedColour.Mix ( StartCol, // start blend colour EndCol, // end blend colour NextPos - PrevPos, // the blend ratio cc // RGB space please ); pNewItem->SetColour (&BlendedColour); pSecondItem = (ColRampItem*) GetNext (pSecondItem); } pFirstItem = (ColRampItem*) GetHead (); pSecondItem = (ColRampItem*) OtherRamp->GetHead (); // now insert the first blobs into the second .... PrevPos = -1, NextPos = -1; while (pFirstItem) { ColRampItem* pNewItem = new ColRampItem (*pFirstItem); NewColourRamp2->InsertNewItem (pNewItem); ColRampItem* pPrevItem = (ColRampItem*) NewColourRamp2->GetPrev (pNewItem); ColRampItem* pNextItem = (ColRampItem*) NewColourRamp2->GetNext (pNewItem); if (!pPrevItem) { StartCol = pNewAttr->GetStartColour (); PrevPos = 0.0; } else { tempStartCol = pPrevItem->GetColour (); StartCol = &tempStartCol; PrevPos = pPrevItem->GetPosition (); } if (!pNextItem) { EndCol = pNewAttr->GetEndColour (); NextPos = 1.0; } else { tempEndCol = pNextItem->GetColour (); EndCol = &tempEndCol; NextPos = pNextItem->GetPosition (); } BlendedColour.Mix ( StartCol, // start blend colour EndCol, // end blend colour NextPos - PrevPos, // the blend ratio cc // RGB space please ); pNewItem->SetColour (&BlendedColour); pFirstItem = (ColRampItem*) GetNext (pFirstItem); } // simply interpolate between the respective colour ramp blobs .... pItem = (RampItem*) NewColourRamp1->GetHead (); pOtherItem = (RampItem*) NewColourRamp2->GetHead (); while (pItem && pOtherItem) { ColRampItem* pNewItem = new ColRampItem (*((ColRampItem*) pItem)); NewColourRamp3->InsertNewItem (pNewItem); tempStartCol = ((ColRampItem*) pItem->GetItem ())->GetColour (); tempEndCol = ((ColRampItem*) pOtherItem->GetItem ())->GetColour (); BlendedColour.Mix ( &tempStartCol, // start blend colour &tempEndCol, // end blend colour Ratio, // the blend ratio cc // RGB space please ); pNewItem->SetColour (&BlendedColour); pItem = (RampItem*) NewColourRamp1->GetNext (pItem); pOtherItem = (RampItem*) NewColourRamp2->GetNext (pOtherItem); } pNewAttr->SetColourRamp (NewColourRamp3); delete (NewColourRamp1); delete (NewColourRamp2); delete (NewColourRamp3); }

void FillRamp::DoManyToNoneBlend (  FillGeometryAttribute *  pNewAttr, BlendAttrParam *  pBlendParam, FillGeometryAttribute *  pOtherFill, BOOL  notInvert )  [private]

Blends mutistage fill ramps. This function blends many to no none fill blobs. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 17/4/2000 Parameters: [INPUTS]  [OUTPUTS]  Definition at line 744 of file fillramp.cpp. { // find what point along the blend we are at double Ratio = 1; if (!notInvert) { Ratio = 1 - pBlendParam->GetBlendRatio (); } else { Ratio = pBlendParam->GetBlendRatio (); } DocColour* StartCol = pOtherFill->GetStartColour ();//pNewAttr->GetStartColour (); DocColour* EndCol = pOtherFill->GetEndColour ();//pNewAttr->GetEndColour (); if (!EndCol) { EndCol = StartCol; } if ((EndCol == NULL) && (StartCol == NULL)) { // do nothing return; } ColourRamp* NewColourRamp = new ColourRamp (); DocColour BlendedColour; DocColour BlendedColour2; ColourContext *cc = ColourManager::GetColourContext (COLOURMODEL_RGBT); if (NewColourRamp) { ColRampItem* pItem = (ColRampItem*) GetHead (); while (pItem) { ColRampItem* pNewItem = new ColRampItem (*pItem); // first mix the two endpoints based upon the other fillramp blob positions .... BlendedColour.Mix ( StartCol, // start blend colour EndCol, // end blend colour ((ColRampItem*) pItem->GetItem ())->GetPosition (), // the blend ratio cc // RGB space please ); // then mix this new colour with the other fillramp blob colours .... DocColour EndColour = ((ColRampItem*) pItem->GetItem ())->GetColour (); BlendedColour2.Mix ( &BlendedColour, &EndColour, Ratio, // the blend ratio cc // RGB space please ); pNewItem->SetColour (&BlendedColour2); NewColourRamp->InsertNewItem (pNewItem); pItem = (ColRampItem*) GetNext (pItem); } pNewAttr->SetColourRamp (NewColourRamp); } delete (NewColourRamp); }

void FillRamp::DoNoneToManyBlend (  FillGeometryAttribute *  pNewAttr, BlendAttrParam *  pBlendParam, FillRamp *  OtherRamp, BOOL  notInvert )  [private]

Blends mutistage fill ramps. This function blends none to many blobs. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 17/4/2000 Parameters: [INPUTS]  [OUTPUTS]  Definition at line 666 of file fillramp.cpp. { // find what point along the blend we are at double Ratio = pBlendParam->GetBlendRatio (); DocColour* StartCol = pNewAttr->GetStartColour (); DocColour* EndCol = pNewAttr->GetEndColour (); // first see if weve got something that we can safely blend with // if either colour is NULL, then forget it; just set the colour ramp to NULL .... if (!((StartCol == NULL) && (EndCol == NULL))) { ColourRamp* NewColourRamp = new ColourRamp (); DocColour BlendedColour; DocColour BlendedColour2; ColourContext *cc = ColourManager::GetColourContext (COLOURMODEL_RGBT); if (NewColourRamp) { ColRampItem* pOtherItem = (ColRampItem*) OtherRamp->GetHead (); while (pOtherItem) { ColRampItem* pNewItem = new ColRampItem (*pOtherItem); // first mix the two endpoints based upon the other fillramp blob positions .... BlendedColour.Mix ( StartCol, // start blend colour EndCol, // end blend colour ((ColRampItem*) pOtherItem->GetItem ())->GetPosition (), // the blend ratio cc // RGB space please ); // then mix this new colour with the other fillramp blob colours .... DocColour EndColour = ((ColRampItem*) pOtherItem->GetItem ())->GetColour (); BlendedColour2.Mix ( &BlendedColour, &EndColour, Ratio, // the blend ratio cc // RGB space please ); pNewItem->SetColour (&BlendedColour2); NewColourRamp->InsertNewItem (pNewItem); pOtherItem = (ColRampItem*) OtherRamp->GetNext (pOtherItem); } pNewAttr->SetColourRamp (NewColourRamp); } delete (NewColourRamp); } else { pNewAttr->SetColourRamp (NULL); } }

void FillRamp::DoOneToOneBlend (  FillGeometryAttribute *  pNewAttr, BlendAttrParam *  pBlendParam, FillRamp *  OtherRamp, BOOL  notInvert )  [private]

Blends mutistage fill ramps. This function blends equal numbers of blobs. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 17/4/2000 Parameters: [INPUTS]  [OUTPUTS]  Definition at line 620 of file fillramp.cpp. { // find what point along the blend we are at double Ratio = pBlendParam->GetBlendRatio (); RampItem* pItem = (RampItem*) GetHead (); RampItem* pOtherItem = (RampItem*) OtherRamp->GetHead (); // simply interpolate between the respective colour ramp blobs .... DocColour BlendedColour; ColourContext *cc = ColourManager::GetColourContext (COLOURMODEL_RGBT); while (pItem && pOtherItem) { DocColour StartColour = ((ColRampItem*) pItem->GetItem ())->GetColour (); DocColour EndColour = ((ColRampItem*) pOtherItem->GetItem ())->GetColour (); BlendedColour.Mix ( &StartColour, // start blend colour &EndColour, // end blend colour Ratio, // the blend ratio cc // RGB space please ); ((ColRampItem*) pItem->GetItem ())->SetColour (&BlendedColour); pItem = (RampItem*) GetNext (pItem); pOtherItem = (RampItem*) OtherRamp->GetNext (pOtherItem); } }

RampItem * FillRamp::FindInsertPosition (  float  pos, INT32 *  pInsert, UINT32 *  pIndex )  const [private]

Finds an insert context given a position. The idea is, if you have a new record to add, it needs to be added to the list after all items with a position less than pos. This func finds the insert position and returns a value indicating before or after. The index of your new item will depend on the pInsert value. If 0, then the new index will be (*pIndex) otherwise its (*pIndex)+1;. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: pos  = position of the current entry [INPUTS] pInsert  = 0, then insert the entry before ColRampItem* [OUTPUTS] = 1, then insert the entry after ColRampItem* index = then index of the returned item. Returns: RampItem* , a pointer to an item to place pos before or after, NULL if the list is empty. Definition at line 372 of file fillramp.cpp. { ERROR3IF(pInsert==NULL, "NULL insert pointer passed to FillRamp::FindInsertPosition()"); // need to search for RampItem *pLastItem=NULL, *pItem = (RampItem*)GetHead(); (*pInsert) = 1; (*pIndex) = FILLRAMP_INDEXBASE-1; while (pItem) { (*pIndex)++; if (pItem->GetPosition() > pos) { (*pInsert) = 0; return pItem; } pLastItem = pItem; pItem = (RampItem*)GetNext(pItem); } return pLastItem; }

DocCoord FillRamp::GetGeometryCoord (  FillGeometryAttribute *  pGeom, UINT32  index )  const

Find the absolute coordinate of Blob[index]. The start coordinate will be returned if index is out of range. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: geom  = the geometry, we currently support linear and circular [INPUTS] index = the index of an item in our list. Returns: The absolute doc coord on the geometry pGeom of Blob[index] Definition at line 1458 of file fillramp.cpp. { if (pGeom==NULL) { ERROR3("NULL geometry passed to FillRamp::GetGeometryCoord"); return DocCoord(0,0); } RampItem* pItem = GetValidIndexedItem(index); if (pItem==NULL) return DocCoord(0,0); return pGeom->GetGeometryCoord(pItem->GetPosition()); }

RampItem * FillRamp::GetIndexedItem (  INT32  index  )  const [protected]

Find the i'th item in this fill ramp. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: index  = the ramp index [INPUTS] Returns: A pointer to the item at this index position in the ramp, or NULL if none Definition at line 1356 of file fillramp.cpp. { if (index>=0) { RampItem *pItem = (RampItem*)GetHead(); while (pItem) { if (index==0) return pItem; index--; pItem = (RampItem*)GetNext(pItem); } } return NULL; }

BOOL FillRamp::GetIndexRange (  UINT32 *  pFirst, UINT32 *  pLast )  const

Return the index of the first and last entries in this list. As the list indexes are biased by an unknown value, at least unknown to everyone but the author, one needs to use this class function to find out the values of the first and last indexes. All I'll tell you is that they behaviour linearly between the two extreems. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: -  [INPUTS] pFirst  = assigned the index of the first ramp item [OUTPUTS] pLast = assigned the index of the last ramp item Returns: FALSE if the list is actually empty TRUE if there are entries in this list Definition at line 1234 of file fillramp.cpp. { INT32 c=GetCount(); if (pFirst!=NULL) *pFirst = FILLRAMP_INDEXBASE; if (pLast!=NULL) *pLast = FILLRAMP_INDEXBASE+c-1; return (c>0); }

INT32 FillRamp::GetSelectedIndex (   )  const

Return the index of the first selected item in this list. The index is adjusted by FILLRAMP_INDEXBASE i.e. this constant value is always added to an index to give the range [FILLRAMP_INDEXBASE...FILLRAMP_INDEXBASE+n-1]. This is done so one can distinguish between indexes for fill geometry end points (usually 0..7 or thereabouts) and the fill ramp blobs. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: -  [INPUTS] Returns: The index of the first selected item in the ramp list [0..n-1] the index is adjusted by FILLRAMP_INDEXBASE -1 if there are no selected items in this ramp Definition at line 1200 of file fillramp.cpp. { UINT32 index=FILLRAMP_INDEXBASE; RampItem *pItem = (RampItem*)GetHead(); while (pItem) { if (pItem->GetSelState()) return index; index++; pItem = (RampItem*)GetNext(pItem); } return -1; }

void FillRamp::GetSelectionState (  BOOL *  SelState  )  const

Record the selection state of all the ramp blobs in this array. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: SelState  = a pointer to an array of BOOLs [INPUTS] Definition at line 1312 of file fillramp.cpp. { RampItem *pItem = (RampItem*)GetHead(); while (pItem) { *SelState++ = (pItem->GetSelState()); pItem = (RampItem*)GetNext(pItem); } }

RampItem * FillRamp::GetValidIndexedItem (  UINT32  index  )  const

Find the i'th item in this fill ramp. The index is the normal biased index passed into us from the external world. We convert the index and perform some error checking on it before we attempt to find the relevant item. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: index  = the ramp index [INPUTS] Returns: A pointer to the item at this index position in the ramp, or NULL if none Definition at line 1386 of file fillramp.cpp. { INT32 i = ((INT32)(index)) - FILLRAMP_INDEXBASE; if (i<0) { ERROR3("Illegal index passed to FillRamp::GetValidIndexedItem()"); return NULL; } RampItem *pItem = GetIndexedItem(i); if (pItem==NULL) { ERROR3("Index out of range in FillRamp::GetValidIndexedItem()"); return NULL; } return pItem; }

UINT32 FillRamp::HitBlob (  FillGeometryAttribute *  pAttrValue, DocCoord &  ClickPos )  const

Check to see if a ramp item was hit by this click. If so return yes. We also set and internal pointer on the result of this check, which can be used to make edits. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 5/2/97 Parameters: geom  = the geometry, we currently support linear and circular [INPUTS] p0,p1 depend on geom geom = GEOM_LINEAR p0 = a coord describing the start of a line p1 = a coord describing the start of a line or a point on the cir geom = GEOM_CIRCULAR p0 = a coord describing the centre of a circle p1 = a coord describing the start of a line or a point on the cir Returns: TRUE if a blob was hit FALSE if no blob was hit Effects: LastItemOfInterest is set to NULL if no blob was hit, or points to the item hit Definition at line 1271 of file fillramp.cpp. { DocRect BlobRect; DocCoord point; float pos; if (pAttrValue!=NULL) { // search from the last first RampItem *pItem = (RampItem*)GetHead(); UINT32 i = FILLRAMP_INDEXBASE; // find a suitable blob rect around this point (GetApplication()->GetBlobManager())->GetBlobRect(ClickPos, &BlobRect, TRUE); while (pItem) { pos = pItem->GetPosition(); point = pAttrValue->GetGeometryCoord(pos); // See if the Click Position is within the rectangle if ( BlobRect.ContainsCoord(point) ) return i; // otherwise continue onwards i++; pItem = (RampItem*)GetNext(pItem); } } // nothing was under this click position return FILLRAMP_ILLEGALINDEX; }

UINT32 FillRamp::InsertNewItem (  RampItem *  pNewItem  )  [protected]

Adds pNewItem to the growing list. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: pNewItem  = a new item to insert in the list. [INPUTS] -  [OUTPUTS] Returns: the index of the inserted item Definition at line 409 of file fillramp.cpp. { ERROR3IF(pNewItem==NULL, "NULL pointer passed to FillRamp::InsertNewItem"); // keep an ordered list on pos please! INT32 insert; UINT32 index; RampItem *pContext = FindInsertPosition(pNewItem->GetPosition(),&insert,&index); if (pContext==NULL) { AddTail(pNewItem); return FILLRAMP_INDEXBASE; } if (insert==0) { InsertBefore(pContext, pNewItem); return index; } InsertAfter(pContext, pNewItem); return (index+1); }

BOOL FillRamp::IsSelected (  UINT32  index  )  const

Find out whether this ramp index is selected or not. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: index  = the ramp index [INPUTS] Definition at line 1334 of file fillramp.cpp. { RampItem* pItem = GetValidIndexedItem(index); if (pItem) return pItem->IsSelected(); return FALSE; }

void FillRamp::RenderRampBlobs (  FillGeometryAttribute *  pGeom, RenderRegion *  pRender, BOOL *  pSelState = NULL )  const

Render the fill blobs in their positions as they appear on the geometry this fill ramp is associated with. We simply ask the geometry where they are and render appropriately. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: geom  = the geometry, we currently support linear and circular [INPUTS] pRender = the render region to plot the blobs into pSelState = a selection state array which describes an alternate selection state (other than that in this ramp) to use to render the blobs Returns: - Definition at line 1491 of file fillramp.cpp. { BOOL Selected; DocCoord coord; RampItem* pItem = (RampItem*)GetHead(); INT32 i=0; while (pItem!=NULL) { if (pSelState!=NULL) Selected=pSelState[i]; else Selected=pItem->GetSelState(); coord = pGeom->GetGeometryCoord(pItem->GetPosition()); // Draw a blob at the end point if (Selected) { // Draw Selected Blob pRender->SetLineColour (COLOUR_SELECTEDBLOB); pRender->SetFillColour (COLOUR_SELECTEDBLOB); pRender->DrawBlob (coord, BT_MSTAGEFILLSELECTED); } else { // Draw Unselected Blob pRender->SetLineColour (COLOUR_NONE); pRender->SetFillColour (COLOUR_BLUE); pRender->DrawBlob (coord, BT_MSTAGEFILLUNSELECTED); } i++; pItem = (RampItem*)GetNext(pItem); } }

void FillRamp::RenderSelectedBlob (  FillGeometryAttribute *  pGeom, RenderRegion *  pRender )

Definition at line 1527 of file fillramp.cpp. { DocCoord coord; RampItem* pItem = (RampItem*) GetHead(); while (pItem) { if (pItem->IsSelected ()) { coord = pGeom->GetGeometryCoord(pItem->GetPosition()); pRender->SetLineColour (COLOUR_SELECTEDBLOB); pRender->SetFillColour (COLOUR_SELECTEDBLOB); pRender->DrawBlob (coord, BT_MSTAGEFILLSELECTED); return; } pItem = (RampItem*)GetNext(pItem); } }

BOOL FillRamp::RotateSelLeft (  BOOL  StartPointSelected, BOOL  EndPointSelected, FillControl &  OldSelectedBlob )  const

Roll the selection state of the items in the list to the left. That equates to rolling the selection up the list by one element. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: RollIn  = a boolean value rolled in from the previous item on the right [INPUTS] A  bool, the state of the last item rolled out of the left [OUTPUTS] Definition at line 1086 of file fillramp.cpp. { if (StartPointSelected) { OldSelectedBlob = FILLCONTROL_STARTPOINT; return (FILLCONTROL_ENDPOINT); } if (EndPointSelected) { // select first blob in list .... RampItem *pItem = (RampItem*) GetTail(); pItem->SetSelState (TRUE); FillControl Ret = GetSelectedIndex (); pItem->SetSelState (FALSE); OldSelectedBlob = FILLCONTROL_NULL; return (Ret); } // if we haven't returned yet, then the selection will within our ramp .... RampItem* pItem = (RampItem*) GetTail(); RampItem* pSelectedBlob = NULL; while (pItem) { if (pItem->IsSelected ()) { pSelectedBlob = pItem; break; } pItem = (RampItem*)GetPrev(pItem); } RampItem* pSelNext = (RampItem*) GetPrev (pSelectedBlob); if (pSelNext != NULL) { OldSelectedBlob = GetSelectedIndex (); pSelectedBlob->SetSelState (FALSE); pSelNext->SetSelState (TRUE); FillControl Ret = GetSelectedIndex (); pSelNext->SetSelState (FALSE); return (Ret); } else { OldSelectedBlob = GetSelectedIndex (); pSelectedBlob->SetSelState (FALSE); return (FILLCONTROL_STARTPOINT); } /* perform a ROL on the selection in this fill ramp BOOL Temp; RampItem *pItem = (RampItem*)GetTail(); while (pItem) { Temp = pItem->GetSelState(); pItem->SetSelState(RollIn); RollIn = Temp; pItem = (RampItem*)GetPrev(pItem); } return RollIn;*/ }

FillControl FillRamp::RotateSelRight (  BOOL  StartPointSelected, BOOL  EndPointSelected, FillControl &  OldSelectedBlob )  const

Roll the selection state of the items in the list to the right. That equates to rolling the selection down the list by one element. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: RollIn  = a boolean value rolled in from the previous item on the left [INPUTS] A  bool, the state of the last item rolled out of the right [OUTPUTS] Definition at line 1016 of file fillramp.cpp. { if (StartPointSelected) { // select first blob in list .... RampItem *pItem = (RampItem*) GetHead(); pItem->SetSelState (TRUE); FillControl Ret = GetSelectedIndex (); pItem->SetSelState (FALSE); OldSelectedBlob = FILLCONTROL_NULL; return (Ret); } if (EndPointSelected) { OldSelectedBlob = FILLCONTROL_ENDPOINT; return (FILLCONTROL_STARTPOINT); } // if we haven't returned yet, then the selection will within our ramp .... RampItem* pItem = (RampItem*) GetHead(); RampItem* pSelectedBlob = NULL; while (pItem) { if (pItem->IsSelected ()) { pSelectedBlob = pItem; break; } pItem = (RampItem*)GetNext(pItem); } RampItem* pSelNext = (RampItem*) GetNext (pSelectedBlob); if (pSelNext != NULL) { OldSelectedBlob = GetSelectedIndex (); pSelectedBlob->SetSelState (FALSE); pSelNext->SetSelState (TRUE); FillControl Ret = GetSelectedIndex (); pSelNext->SetSelState (FALSE); return (Ret); } else { OldSelectedBlob = GetSelectedIndex (); pSelectedBlob->SetSelState (FALSE); return (FILLCONTROL_ENDPOINT); } }

UINT32 FillRamp::SetPosition (  UINT32  index, float  pos )

Sets the position of an existing ramp item identified by index. As we keep our list of items ordered on position, the fact that it is being changed will likely result in a shuffling of the item in the list. Hence we return a new index (which obviously may or may not be the same as index). Those who are keeping up amoung you might even be able to spot when an item shuffles by looking at the input and ouput index values. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: index  = the index of the item whose position we're setting [INPUTS] pos = the new parametric position Returns: a new index. Definition at line 1570 of file fillramp.cpp. { RampItem *pItem = GetValidIndexedItem(index); if (pItem==NULL) return FILLRAMP_ILLEGALINDEX; pItem->SetPosition(pos); //SortRamp (TRUE); index = ShuffleItem(pItem,index); return index; }

void FillRamp::SetSelState (  UINT32  index, INT32  NewState )

Sets the state of a fill ramp blob. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: HitControl,the  FillControl that is to be selected. [INPUTS] state = 0 = deselect blob 1 = select blob 2 = toggle blob selection Definition at line 1420 of file fillramp.cpp. { INT32 i = ((INT32)(index)) - FILLRAMP_INDEXBASE; ERROR3IF(i<0, "Illegal index passed to FillRamp::ChangeBlobState()"); if (i>=0) { RampItem* pItem = GetIndexedItem(i); if (pItem) { BOOL CurrState = pItem->GetSelState(); switch (NewState) { case 0: CurrState=FALSE; break; case 1: CurrState=TRUE; break; case 2: CurrState=!CurrState; } pItem->SetSelState(CurrState); } } }

UINT32 FillRamp::ShuffleItem (  RampItem *  pItem, UINT32  index )  [private]

ShuffleItem checks the validity of pItem. If the item's position in the list is invalid, it will be shuffled into a valid position. This needs to be done when the position parameter is changed, as we keep an ascending order of item positions. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: pItem  = a pointer to a ramp item [INPUTS] index = the ramp items list index Returns: a new index. (The same if no shuffle occured, otherwise err, not the same) Definition at line 1599 of file fillramp.cpp. { float curpos = pItem->GetPosition(); RampItem *pPrevContext = (RampItem*)GetPrev(pItem); RampItem *pNextContext = (RampItem*)GetNext(pItem); RampItem *pContext = NULL; if (pPrevContext == pNextContext) // I don't know why this occurs, BUT it does sometimes! { pContext = pPrevContext; } else { if ((pPrevContext != NULL) && (pNextContext == NULL)) { pContext = pPrevContext; } else if ((pNextContext != NULL) && (pPrevContext == NULL)) { pContext = NULL; } else { float prevCurpos = pPrevContext->GetPosition (); float nextCurpos = pNextContext->GetPosition (); float diffPrev = curpos - prevCurpos; if (diffPrev < 0) diffPrev = -diffPrev; float diffNext = curpos - nextCurpos; if (diffNext < 0) diffNext = -diffNext; if (diffPrev < diffNext) { pContext = pPrevContext; } else { pContext = NULL; } } } if (pContext) { if (!(pContext->IsSelected ())) { float contextPos = pContext->GetPosition(); BOOL shuffle = (curpos < contextPos); // do we need to shuffle this item to keep order? if (shuffle) { RampItem *pRemoved = (RampItem*)RemoveItem(pItem); pRemoved->ClearPointers (); return InsertNewItem(pRemoved); } } } else { pContext = (RampItem*)GetNext(pItem); if (pContext) { if (!(pContext->IsSelected ())) { float contextPos = pContext->GetPosition(); BOOL shuffle = (curpos > contextPos); // do we need to shuffle this item to keep order? if (shuffle) { RampItem *pRemoved = (RampItem*)RemoveItem(pItem); pRemoved->ClearPointers (); return InsertNewItem(pRemoved); } } } } return index; }

void FillRamp::SortRamp (   )

Ensures all positions of all items in the list are in numerical order. Author: David_McClarnon (Xara Group Ltd) <camelotdev@xara.com> Date: 24/10/99 Parameters: [INPUTS]  [OUTPUTS]  Definition at line 464 of file fillramp.cpp. { // bubble sort algorithm - not fast but should be fast enough for our purposes RampItem * pPrevItem = (RampItem *)GetHead(); RampItem * pThisItem = (RampItem *)GetNext(pPrevItem); while (pThisItem) { if (pPrevItem->GetPosition() > pThisItem->GetPosition()) { // swap the values around, and then restart the list // first, remove this item RampItem * pRemovedItem = (RampItem *)RemoveItem(pThisItem); if (InsertBefore(pPrevItem, pRemovedItem) == NULL) { ERROR3("Insert before failed"); return; } pPrevItem = (RampItem *)GetHead(); pThisItem = (RampItem *)GetNext(pPrevItem); } // now, check for multiple points else if (pPrevItem->GetPosition() == pThisItem->GetPosition()) { pThisItem->SetPosition(pPrevItem->GetPosition() + 0.01f); pThisItem = (RampItem *)GetNext(pThisItem); pPrevItem = (RampItem *)GetNext(pPrevItem); } else { pThisItem = (RampItem *)GetNext(pThisItem); pPrevItem = (RampItem *)GetNext(pPrevItem); } } }

---

The documentation for this class was generated from the following files:

• Kernel/fillramp.h (r1785/r1282)
• Kernel/fillramp.cpp (r1785/r1282)

---