ColourRamp Class Reference

This class holds a list of colour records, each of which describe a colour position in a colour ramp. The list contains the usual add/delete entry members and other suitable interfaces to allow colour ramps to be edited. The list is used inside GradFillAttribute to describe multicoloured fills. More...

#include <fillramp.h>

Inheritance diagram for ColourRamp:

List of all members.

Public Member Functions
virtual	~ColourRamp ()
	This class holds a list of colour records, each of which describe a colour position in a colour ramp. The list contains the usual add/delete entry members and other suitable interfaces to allow colour ramps to be edited. The list is used inside GradFillAttribute to describe multicoloured fills.
ColRampItem *	AddEntry (float pos, DocColour *pCol)
	Add a new colour ramp entry. Its selected state is FALSE.
ColRampItem *	GetFirstCol () const
ColRampItem *	GetLastCol () const
ColRampItem *	GetNextCol (ColRampItem *pItem) const
ColRampItem *	GetPrevCol (ColRampItem *pItem) const
ColourRamp &	operator= (const ColourRamp &other)
	Assign this colour ramp the same values as those refered to in other.
DocColour *	GetFirstSelectedColour ()
	Set all selected items in the colour ramp to the colour specified.
DocColour *	EnumerateColourFields (UINT32 index)
	Enumerates all colour fields in the colour ramp. This linear searching is not so quick. We might need to keep a static context pointer here.
BOOL	IsDifferentTo (ColourRamp *pRamp)
	Another matching function. See if this colour ramp is different to that pointed to by pRamp See Also: ColourRamp::operator==.
INT32	operator== (const ColourRamp &other) const
	Dumps the data held in the fill ramp to the debug outputTry to match this colour ramp with another colour ramp. We simply check the numbers in the list, and if the same call the colour ramp entry eqivalence operator agains each list entry.
void	DeleteAll ()
	Deletes all members of the colour ramp list. This is an internal private function which is used by other operations in this class.
BOOL	SetItemColour (UINT32 index, DocColour *pCol)
	Set the colour of an existing colour ramp entry to a new value.
INT32	SetSelectedColours (DocColour *pCol)
	Set all selected items in the colour ramp to the colour specified.
BOOL	CopyComponentData (BaseDocument *SrcDoc, BaseDocument *NodesDoc)
	If the attribute contains any DocColours which are indexed then a copy of the indexed colour is made and added to the NodesDoc ColourListComponent.
BOOL	WriteColourDefinitions (BaseCamelotFilter *pFilter)
	Writes out colour definitions for this fill.
void	Dump ()

---

Detailed Description

This class holds a list of colour records, each of which describe a colour position in a colour ramp. The list contains the usual add/delete entry members and other suitable interfaces to allow colour ramps to be edited. The list is used inside GradFillAttribute to describe multicoloured fills.

Author:

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

Date:

02/02/97

Definition at line 334 of file fillramp.h.

---

Constructor & Destructor Documentation

ColourRamp::~ColourRamp (   )  [virtual]

This class holds a list of colour records, each of which describe a colour position in a colour ramp. The list contains the usual add/delete entry members and other suitable interfaces to allow colour ramps to be edited. The list is used inside GradFillAttribute to describe multicoloured fills. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Definition at line 1698 of file fillramp.cpp. { DeleteAll(); }

---

Member Function Documentation

ColRampItem * ColourRamp::AddEntry (  float  pos, DocColour *  pCol )

Add a new colour ramp entry. Its selected state is FALSE. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: pos  = the position this doc colour occupies in the colour ramp 0..1 [INPUTS] pCol = the doc colour to add -  [OUTPUTS] Returns: ColRampItem* , a pointer to the list entry created or NULL if out of memory Definition at line 1738 of file fillramp.cpp. { ERROR2IF(((pos<0.0)||(pos>1.0)), NULL, "position out of range!"); ERROR2IF(pCol==NULL, NULL, "no colour passed to ColourRamp::AddEntry()"); // create ourselves a new colour ramp item ColRampItem *pNewItem = new ColRampItem(pos,pCol); if (pNewItem) // insert it in the list InsertNewItem(pNewItem); // return the item pointer return pNewItem; }

BOOL ColourRamp::CopyComponentData (  BaseDocument *  SrcDoc, BaseDocument *  NodesDoc )

If the attribute contains any DocColours which are indexed then a copy of the indexed colour is made and added to the NodesDoc ColourListComponent. Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 1/9/2000 Parameters: SrcDoc,:  The document from where this node was copied [INPUTS] NodesDoc: The document where this node lives -  [OUTPUTS] Returns: FALSE if unable to copy data Errors: - See also: AttrFillGeometry::CopyComponentData NOTE: This is the companion function to the one in AttrFillGeometry. Definition at line 1967 of file fillramp.cpp. { // Get the colour list component ColourListComponent *pComponent = (ColourListComponent *) NodesDoc->GetDocComponent(CC_RUNTIME_CLASS(ColourListComponent)); ENSURE (pComponent != NULL, "Could not find ColourListComponent"); ColRampItem *pItem = GetFirstCol(); // Copy across all DocColours while (pItem!=NULL) { DocColour* pDocCol = pItem->GetColourAddr (); if (pDocCol) if (pComponent->CopyColourAcross(pDocCol) == CCCOPY_FAILED) { return (FALSE); } pItem = GetNextCol(pItem); } return (TRUE); }

void ColourRamp::DeleteAll (   )  [virtual]

Deletes all members of the colour ramp list. This is an internal private function which is used by other operations in this class. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: -  [INPUTS] Reimplemented from List. Definition at line 1716 of file fillramp.cpp. { ColRampItem* pItem; while ((pItem=((ColRampItem*)RemoveTail()))!=NULL) delete pItem; }

void ColourRamp::Dump (   )  [inline]

Definition at line 366 of file fillramp.h. { } ;

DocColour * ColourRamp::EnumerateColourFields (  UINT32  real_index  )

Enumerates all colour fields in the colour ramp. This linear searching is not so quick. We might need to keep a static context pointer here. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: real_index  = an unbiased index [0..n-1] [INPUTS] Returns: A pointer to the colour record held in this indexed item or NULL Definition at line 2069 of file fillramp.cpp. { RampItem *pItem = GetIndexedItem(real_index); if (pItem) return ((ColRampItem*)pItem)->GetColourAddr(); return NULL; }

ColRampItem * ColourRamp::GetFirstCol (   )  const [inline]

Definition at line 373 of file fillramp.h. { return (ColRampItem*)GetHead(); }

DocColour * ColourRamp::GetFirstSelectedColour (   )

Set all selected items in the colour ramp to the colour specified. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 10/3/97 Parameters: col  = the doc colour to set [INPUTS] Returns: the number of colours set. Definition at line 2044 of file fillramp.cpp. { ColRampItem *pItem = GetFirstCol(); while (pItem!=NULL) { if (pItem->IsSelected()) return pItem->GetColourAddr(); pItem = GetNextCol(pItem); } return NULL; }

ColRampItem * ColourRamp::GetLastCol (   )  const [inline]

Definition at line 379 of file fillramp.h. { return (ColRampItem*)GetTail(); }

ColRampItem * ColourRamp::GetNextCol (  ColRampItem *  pItem  )  const [inline]

Definition at line 385 of file fillramp.h. { return (ColRampItem*)GetNext(pItem); }

ColRampItem * ColourRamp::GetPrevCol (  ColRampItem *  pItem  )  const [inline]

Definition at line 391 of file fillramp.h. { return (ColRampItem*)GetPrev(pItem); }

BOOL ColourRamp::IsDifferentTo (  ColourRamp *  pRamp  )

Another matching function. See if this colour ramp is different to that pointed to by pRamp See Also: ColourRamp::operator==. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: pRamp  = the ramp to check against [INPUTS] -  [OUTPUTS] Returns: TRUE if other is different to this Definition at line 1840 of file fillramp.cpp. { ERROR3IF(this==NULL, "NULL 'this' object in ColourRamp::IsDifferentTo()"); if (pRamp==NULL) return TRUE; return (!((*this)==(*pRamp))); }

ColourRamp & ColourRamp::operator= (  const ColourRamp &  other  )

Assign this colour ramp the same values as those refered to in other. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: other  = a colour ramp reference [INPUTS] -  [OUTPUTS] Returns: A reference to this colour ramp Definition at line 1862 of file fillramp.cpp. { // the main problem we need to deal with here is 'what happens // when we fail to copy the entire list? Well, it makes no sense // to keep the old list as we've not then assigned anything // i.e. C=A=B not assigning A and C anything is a bit weird. // so we go ahead and toast whatever was in list A and copy B to // it (as much as we can at least). If afterwards A!=B then we // know we're out of memory // toast all colours in our list DeleteAll(); BOOL ok = TRUE; ColRampItem *pThisItem, *pOtherItem = other.GetFirstCol(); while (pOtherItem && ok) { pThisItem = new ColRampItem(*pOtherItem); ok = (pThisItem != NULL); if (ok) { // Add the new colour to our list AddTail(pThisItem); pOtherItem = other.GetNextCol(pOtherItem); } } // run a debug check. ERROR3IF(!ok, "ColourRamp::operator= failed to copy the complete ColourRamp"); return (*this); }

INT32 ColourRamp::operator== (  const ColourRamp &  other  )  const

Dumps the data held in the fill ramp to the debug outputTry to match this colour ramp with another colour ramp. We simply check the numbers in the list, and if the same call the colour ramp entry eqivalence operator agains each list entry. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 2/2/97 Parameters: other  = a colour ramp reference [INPUTS] -  [OUTPUTS] Returns: TRUE if other is equivalent to this Definition at line 1805 of file fillramp.cpp. { if (GetCount() != other.GetCount()) return FALSE; ColRampItem *pThisItem = GetFirstCol(); ColRampItem *pThatItem = other.GetFirstCol(); BOOL ok=TRUE; while (pThisItem && ok) { ok = ((*pThisItem)==(*pThatItem)); pThisItem = GetNextCol(pThisItem); pThatItem = other.GetNextCol(pThatItem); } return ok; }

BOOL ColourRamp::SetItemColour (  UINT32  index, DocColour *  pCol )

Set the colour of an existing colour ramp entry to a new value. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/97 Parameters: index  = the index of the ramp entry [INPUTS] pCol = the doc colour to set Returns: TRUE if the colour has been set Definition at line 1909 of file fillramp.cpp. { RampItem *pItem = GetValidIndexedItem(index); if (pItem!=NULL) ((ColRampItem*)pItem)->SetColour(pCol); return (pItem!=NULL); }

INT32 ColourRamp::SetSelectedColours (  DocColour *  pCol  )

Set all selected items in the colour ramp to the colour specified. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 9/3/97 Parameters: col  = the doc colour to set [INPUTS] Returns: the number of colours set. Definition at line 1929 of file fillramp.cpp. { INT32 c=0; ColRampItem *pItem = GetFirstCol(); while (pItem!=NULL) { if (pItem->IsSelected()) { pItem->SetColour(pCol); c++; } pItem = GetNextCol(pItem); } return c; }

BOOL ColourRamp::WriteColourDefinitions (  BaseCamelotFilter *  pFilter  )

Writes out colour definitions for this fill. > virtual BOOL ColourRamp::WriteColourDefinitions (BaseCamelotFilter* pFilter) Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 14/9/2000 Parameters: pFilter  = ptr to the filter [INPUTS] Returns: TRUE if record is written, FALSE if not See also: BaseCamelotFilter::WriteRemainingAtomicTagDefinitions () Layer::WriteAtomicNodesColourRefs () Definition at line 2006 of file fillramp.cpp. { BOOL ok = TRUE; ColRampItem *pItem = GetFirstCol(); while (pItem!=NULL) { DocColour* pDocCol = pItem->GetColourAddr (); INT32 ColRef = pFilter->WriteRecord(pDocCol); ok = (ColRef != 0); if (ok) { pItem = GetNextCol(pItem); } else { pItem = NULL; } } return (ok); }

---

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

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

---