IndexedColour Class Reference

Definition of a colour, stored to high (128-bit) precision. DocColours in the Document may refer to IndexedColour objects from which they are defined. More...

#include <colourix.h>

Inheritance diagram for IndexedColour:

List of all members.

Public Member Functions
	IndexedColour ()
	Constructor for an IndexedColour object Initialises the colour to the RGBT value for Opaque Black.
	~IndexedColour ()
	Destructor for an IndexedColour object.
	IndexedColour (const IndexedColour &Col)
	Copy constructor for an IndexedColour object.
	IndexedColour (const DocColour &Col)
	Copy constructor for an IndexedColour object.
	IndexedColour (ColourModel ColModel, ColourGeneric *Col)
	Constructor for an IndexedColour object Initialises the colour to the given value in the given colour model NOTE that if you have a ColourABCD structure, you can pass this in as a single parameter, and inline functions will convert the call into a call to this function on your behalf. i.e. you can use IndexedColour((ColourRGBT *)Bob); -- See colour.h.
	IndexedColour (ColourValue Red, ColourValue Green, ColourValue Blue, ColourValue Transparent=0, UINT32 TransType=TRANSTYPE_DEFAULT)
	Constructor for an IndexedColour object Initialises the colour to the given Extended RGBT value.
IndexedColour &	operator= (const IndexedColour &)
	IndexedColour assignment operator Copies the definition of one IndexedColour into another Notes: The name field is copied verbatim - if you want it to say 'Copy of ...' then you'll have to prepend this text yourself.
void	SetName (const StringBase &Name, BOOL ForceNamed=TRUE)
	To set the name of an IndexedColour. The name will be truncated to a maximum length of 63 characters.
void	SetUnnamed (void)
	To UNset the name of an IndexedColour, forcing it back to being Unnamed.
String_64 *	GetName (BOOL ReturnTrueID=FALSE)
	To find the name of an IndexedColour (or the ID of an unnamed indexed colour).
BOOL	IsNamed (void)
	Determines if this colour has been given a name. This cannot be determined using the GetName function, which returns a default name if the colour is unnamed.
void	GetSourceColour (ColourGeneric *Result)
	Gets the definition of the IndexedColour.
BOOL	IsDifferent (const IndexedColour &Other)
	To determine if two indexed colours share a common definition.
BOOL	IsDifferent (const IndexedColour &Other, FIXED24 ErrorLimit)
ColourModel	GetColourModel (void) const
	To determine the colour model in which an IndexedColour is defined.
void	IncrementUsage (void)
	Informs the IndexedColour that yet another thing is referencing it. An IndexedColour should not be deleted if its usage count != 0 A non-zero usage count on exit will generate ENSUREs which usually signal memory leaks or people forgetting to link/delink themselves properly.
BOOL	DecrementUsage (void)
	Informs the IndexedColour that a client is no longer referencing it. An IndexedColour should not be deleted if its usage count != 0.
BOOL	IsInUse (BOOL IgnoreColourGallery=FALSE)
	To determine if anything references this IndexedColour (An IndexedColour must not be deleted if it is in use).
BOOL	IsDeleted (void)
	To determine if this colour has been marked 'deleted'. This is used for undo, to hide colours which have been 'deleted'.
void	SetDeleted (BOOL DeletedFlag)
	This marks/unmarks a colour as 'deleted'. This flag is used for undo, to hide colours which have been 'deleted'. Remember that this constitutes a change to the colour, so you should call ColourManager::ColourListHasChanged, to ensure that the Colour dialogues update all displayed lists to show/not-show this colour. Scope: Only intended for internal ColourManager use Notes: Used by the undoable ColourManager OpColourChange. You should use colour manager calls to delete colours rather than touching them directly. Note that you can 'delete'/'undelete' colours even when they are deemed 'In Use'.
void	InvalidateCache (void)
	Invalidates the IndexedColours output colour cache. This ensures that the colour is re-converted and cached the next time it is used. Scope: Generally private; All public access functions invalidate the cache automatically if it is necessary (if the colour changes).
IndexedColourType	GetType (void) const
	Determines the type of this colour.
BOOL	IsSpotOrTintOfSpot (void) const
	Determines if this colour is either a spot colour or a true tint of a spot colour. (Tints can unfortunately be made from non-spot colour parents, so you need to call this function to determine if a tint really is cleanly derived from a spot colour, or if it must be treated as a simple process colour).
IndexedColour *	FindLinkedParent (void)
	Finds the colour upon which a tint/based-on colour is based, if any. Can also be used to determine if a colour is a tint/basedon colour.
IndexedColour *	FindOldestAncestor (void)
	Finds the colour upon which a tint/based-on colour is based, if any. Can also be used to determine if a colour is a tint/basedon colour.
BOOL	HasLinkedChildren (void)
	To determine if any other IndexedColour references this IndexedColour (An IndexedColour must not be deleted if it is in use).
BOOL	IsADescendantOf (IndexedColour *Parent)
	Recursively backtracks through the chain of LinkedParent links to determine if this colour is in any way (directly or indirectly) linked to the given Parent colour, and might therefore be affected by any change to said colour.
void	LinkedAncestorHasChanged (void)
	Informs an IndexedColour that an ancestor in the linking chain has changed, and that therefore, it may also have changed.
void	SetLinkedParent (IndexedColour *Parent, IndexedColourType NewType=COLOURTYPE_LINKED)
	To make a colour linked to or a tint of another colour. This links the colour to the parent.
IndexedColour *	FindLastLinkedParent (void)
	Finds the last parent colour of this colour. Note that after changing a linked/tint colour back into a normal/spot colour, the parent is remembered. This call thus returns the parent even when the colour is no longer a linked/tint colour. Intended only for use by the colour editor to allow temporary type chnages to not lose the parent link info. The colour editor probably clears the parent colour on exit.
BOOL	SetInheritsComponent (UINT32 ComponentID, BOOL Inherits)
	To set if a given component of a colour is inherited from its linked parent colour.
BOOL	InheritsComponent (UINT32 ComponentID)
	To determine if a given component of a colour is inherited from its linked parent colour. Always returns FALSE if a colour is not linked.
void	SetTintValue (FIXED24 NewTintValue)
	Sets a new tint value for a Tint colour. Will generate ENSURE failures in the debug build if the colour is not a tint.
FIXED24	GetTintValue (void) const
	Gets the current Tint value for the colour.
FIXED24	GetAccumulatedTintValue (void)
	To determine the accumulated tint value of any colour.
void	SetShadeValues (FIXED24 NewShadeValueX, FIXED24 NewShadeValueY)
	Sets new shade values for a Shade colour. Will generate ENSURE failures in the debug build if the colour is not a Tint/Shade.
FIXED24	GetShadeValueX (void) const
	Gets the current Shade Saturation value for the colour.
FIXED24	GetShadeValueY (void) const
	Gets the current Shade Brightness value for the colour.
void	SetTintOrShade (BOOL IsATint)
	Sets a COLOURTYPE_TINT colour to be either a Tint (fade-to-white) or a shade (fade-to-black) colour. The tint/shade fraction is unchnaged (the colour will just toggle between being darker and lighter!).
BOOL	TintIsShade (void) const
	Determines if a COLOURTYPE_TINT colour is really a tint or a shade.
void	SwapWith (IndexedColour *Other)
void	GetDebugDetails (StringBase *Str)
	To get information on this colour for display in the Debug Tree.
Static Public Member Functions
static BOOL	AreSpotsForcedToProcess (void)
static void	ForceSpotsToBeProcess (BOOL ForceOn)
	To set the global colour flag. When the flag is TRUE, all spot colours in the entire program are forced to act as "normal" colours; when set FALSE, all spot colours behave normally.
Protected Member Functions
void	InitialiseInfoFields (ColourModel ColModel)
	Private shared code for construction of IndexedColour objects Initialises the 'Info' structure to default values Scope: private.
void	IncrementChildUsage (void)
	Informs the IndexedColour that yet another thing is referencing it. An IndexedColour must not be deleted if its usage count != 0 Scope: private.
BOOL	DecrementChildUsage (void)
	Informs the IndexedColour that a client is no longer referencing it. An IndexedColour should not be deleted if its usage count != 0 Scope: private.
BOOL	SetType (IndexedColourType NewType)
	Sets the type of this colour: MonoOn COLOURTYPE_NORMAL, COLOURTYPE_SPOT, COLOURTYPE_TINT, COLOURTYPE_LINKED MonoOff.
void	SetSourceColourModel (ColourModel NewModel)
	Sets our colour model number, and invalidates the colour cache Scope: Private, for use by friend classes only.
ColourGeneric *	SourceColourPtr (void)
	Returns a pointer to our source colour. Used to encapsulate our data for external friend users, rather than them poking directly at our data structures. Inlined, so just as efficient anyway. Scope: Private, for use by friend class ColourContext.
Protected Attributes
IndexedColourInfo	Info
ColourGeneric	SourceColour
ColourGeneric	CachedColour
IndexedColour *	ParentColour
DWORD	ChildUsage
DWORD	UsageCount
String_64 *	Name
Static Private Attributes
static BOOL	SpotsAreProcess = FALSE
Friends
class	ColourContext
class	DocColour
class	ColourPicker

---

Detailed Description

Definition of a colour, stored to high (128-bit) precision. DocColours in the Document may refer to IndexedColour objects from which they are defined.

Author:

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

Date:

30/03/94

IndexedColours are used in two forms: Named and Unnamed. The former are held in a list for each document, and appear in the colour line/bar. The latter do not appear in the user interface (except when editing the colour of an object). They are stored in a separate list in the ColourList for the document

NOTE That if an UNNAMED IndexedColour's usage count is decremented to zero, it will automatically delete itself. Named colours must be explicitly deleted.

See also:

DocColour; ColourModel; ColourContext; ColourList Documentation: HowToUse.doc

Definition at line 207 of file colourix.h.

---

Constructor & Destructor Documentation

IndexedColour::IndexedColour (   )

Constructor for an IndexedColour object Initialises the colour to the RGBT value for Opaque Black. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 185 of file colourix.cpp. { InitialiseInfoFields(COLOURMODEL_RGBT); SourceColour.Component1 = 0; // Black & No-colour (in RGBT) SourceColour.Component2 = 0; SourceColour.Component3 = 0; SourceColour.Component4 = 1.0; // 100% transparent }

IndexedColour::~IndexedColour (   )

Destructor for an IndexedColour object. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 212 of file colourix.cpp. { ERROR3IF(UsageCount < 0, "IndexedColour UsageCount is negative"); #ifdef _DEBUG if (UsageCount != 0) { if (IsNamed()) TRACE( _T("\n>> Named IndexedColour %p ('%s') is still referenced %ld times\n"), this, (TCHAR *)(*Name), (INT32)UsageCount); else TRACE( _T("\n>> Unnamed IndexedColour %p is still referenced %ld times\n"), this, (INT32)UsageCount); // Now, ask SimpleCCObject to wugg through all current objects to see if we can find something // that could be the pointer back at us! extern void CheckForUsedPointer(void *ThePointer); TRACE( _T(" References to this object were found in:\n")); CheckForUsedPointer(this); TRACE( _T("\n")); } ERROR3IF(UsageCount > 0, "IndexedColour deleted while still in use"); if (ChildUsage != 0) { if (IsNamed()) { TRACEUSER( "Jason", _T("Jason: Named IndexedColour %p ('%s') is still LINKED %ld times\n"), this, (TCHAR *)(*Name), (INT32)ChildUsage); } else { TRACEUSER( "Jason", _T("Jason: Unnamed IndexedColour %p is still LINKED %ld times\n"), this, (INT32)ChildUsage); } } #endif // If we are linked to another colour, we need to de-reference it if (ParentColour != NULL) ParentColour->DecrementChildUsage(); if (Name != NULL) delete Name; }

IndexedColour::IndexedColour (  const IndexedColour &  Col  )

Copy constructor for an IndexedColour object. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 05/05/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 277 of file colourix.cpp. { Info = Col.Info; memcpy(&SourceColour, &Col.SourceColour, sizeof(ColourGeneric)); memcpy(&CachedColour, &Col.CachedColour, sizeof(ColourGeneric)); // If we are copying a linked/tint colour, we make ourselves linked to their parent ParentColour = Col.ParentColour; if (ParentColour != NULL) ParentColour->IncrementChildUsage(); UsageCount = 0; ChildUsage = 0; Info.IsNamed = FALSE; Name = NULL; // Nasty casting to get around this messy const problem. if (((IndexedColour *)&Col)->IsNamed()) SetName(*(Col.Name)); // Copy the string, not the string-pointer }

IndexedColour::IndexedColour (  const DocColour &  Col  )

Copy constructor for an IndexedColour object. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/94 Parameters: Col  - A DocColour from which to take the definition of this new IndexedCol [INPUTS] -  [OUTPUTS] Returns: - Notes: If the DocColour is immediate (does not reference an IndexedColour) then the indexedcolour uses its colour definition - NOTE that this creates an UNNAMED colour by default (SetName it afterwards). If the DocColour references an IndexedColour, the referenced colour is copied Tints and Linked colours are copied and remain tints/linked (Gosh!) Named/Unnamed colours will be copied as Named/Unnamed colours (Gosh!) The name is copied verbatim (i.e it is not changed to 'Copy of X') Returns: Errors: - See also: IndexedColour::SetName Definition at line 329 of file colourix.cpp. { // Find the parent IndexedColour, if any. Nasty cast to remove compiler warning IndexedColour *Def = ((DocColour *) &Col)->FindParentIndexedColour(); if (Def != NULL) { // The DocColour references an IndexedColour, so copy the parent IndexedColour Info = Def->Info; memcpy(&SourceColour, &Def->SourceColour, sizeof(ColourGeneric)); memcpy(&CachedColour, &Def->CachedColour, sizeof(ColourGeneric)); // If we are copying a linked/tint colour, we need to link ourselves to its parent ParentColour = Def->ParentColour; if (ParentColour != NULL) ParentColour->IncrementChildUsage(); UsageCount = 0; ChildUsage = 0; Info.IsNamed = FALSE; Name = NULL; if (Def->IsNamed()) SetName(*(Def->Name)); // Copy the string, not the string-pointer } else { // This is an immediate DocColour, so copy its definition into our SourceColour InitialiseInfoFields(Col.GetColourModel()); ((DocColour *) &Col)->GetSourceColour(&SourceColour); } }

IndexedColour::IndexedColour (  ColourModel  ColModel, ColourGeneric *  Col )

Constructor for an IndexedColour object Initialises the colour to the given value in the given colour model NOTE that if you have a ColourABCD structure, you can pass this in as a single parameter, and inline functions will convert the call into a call to this function on your behalf. i.e. you can use IndexedColour((ColourRGBT *)Bob); -- See colour.h. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: ColModel  - The colour model in which Col is defined [INPUTS] Col - The definition, in the given colour model, of the colour -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 423 of file colourix.cpp. { InitialiseInfoFields(ColModel); memcpy(&SourceColour, Col, sizeof(ColourGeneric)); }

IndexedColour::IndexedColour (  ColourValue  Red, ColourValue  Green, ColourValue  Blue, ColourValue  Transparent = 0, UINT32  TransType = TRANSTYPE_DEFAULT )

Constructor for an IndexedColour object Initialises the colour to the given Extended RGBT value. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: Red;  Green; Blue - The RGB definition of the colour [INPUTS] Transparent - The transparency of the colour - IGNORED! TransType - The transparency type of the colour - IGNORED! Parameters: -  [OUTPUTS] Returns: - Notes: Colours no longer support transparency. The transparency fields are ignored. Returns: Errors: - See also: - Definition at line 390 of file colourix.cpp. { InitialiseInfoFields(COLOURMODEL_RGBT); SourceColour.Component1 = Red; SourceColour.Component2 = Green; SourceColour.Component3 = Blue; SourceColour.Component4 = Transparent; }

---

Member Function Documentation

static BOOL IndexedColour::AreSpotsForcedToProcess (  void   )  [inline, static]

Definition at line 290 of file colourix.h. { return(SpotsAreProcess); };

BOOL IndexedColour::DecrementChildUsage (  void   )  [inline, protected]

Informs the IndexedColour that a client is no longer referencing it. An IndexedColour should not be deleted if its usage count != 0 Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if the IndexedColour is not in use (can be safely deleted) TRUE if the IndexedColour is in use Errors: - See also: IndexedColour::IncrementChildUsage; IndexedColour::HasLinkedChildren Definition at line 504 of file colourix.h. { ENSURE(IsNamed(), "Attempt to decrement child usage of an UNNAMED colour!"); ENSURE(ChildUsage > 0, "IndexedColour::DecrementChildUsage - UsageCount has gone NEGATIVE!"); return((--ChildUsage) != 0); }

BOOL IndexedColour::DecrementUsage (  void   )  [inline]

Informs the IndexedColour that a client is no longer referencing it. An IndexedColour should not be deleted if its usage count != 0. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if the IndexedColour is not in use (can be safely deleted) TRUE if the IndexedColour is in use Errors: - See also: IndexedColour::IncrementUsage; IndexedColour::IsInUse Definition at line 413 of file colourix.h. { ENSURE(UsageCount > 0, "IndexedColour::DecrementUsage - UsageCount has gone NEGATIVE!"); return((--UsageCount) != 0); }

IndexedColour * IndexedColour::FindLastLinkedParent (  void   )  [inline]

Finds the last parent colour of this colour. Note that after changing a linked/tint colour back into a normal/spot colour, the parent is remembered. This call thus returns the parent even when the colour is no longer a linked/tint colour. Intended only for use by the colour editor to allow temporary type chnages to not lose the parent link info. The colour editor probably clears the parent colour on exit. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/11/94 Returns: The parent 'linked' colour of this colour. This will be NULL if the colour is not linked to another. YOU SHOULD NOT BE USING THIS FUNCTION unless absolutely necessary. Use FindLinkedParent instead. See also: IndexedColour::FindLinkedParent Definition at line 760 of file colourix.h. { return(ParentColour); }

IndexedColour * IndexedColour::FindLinkedParent (  void   )

Finds the colour upon which a tint/based-on colour is based, if any. Can also be used to determine if a colour is a tint/basedon colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Returns: The colour upon which this Tint or Linked colour is based. (If this colour is not a Tint or Linked colour, or if it is a deleted (hidden for undo) colour, the return value is NULL) Notes: If you need to know what colour this colour *was* linked to, as the colour editor does when the user is randomly plonking about with the colour type, then call FindLastLinkedParent instead. See also: IndexedColour::FindLastLinkedParent Definition at line 1080 of file colourix.cpp. { if (IsDeleted()) return(NULL); if (GetType() != COLOURTYPE_TINT && GetType() != COLOURTYPE_LINKED) return(NULL); return(FindLastLinkedParent()); }

IndexedColour * IndexedColour::FindOldestAncestor (  void   )

Finds the colour upon which a tint/based-on colour is based, if any. Can also be used to determine if a colour is a tint/basedon colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/96 Returns: The utimate colour upon which this Tint or Linked colour is based. Note that if this colour has no parent, it will return itself! This is similar to FindLinkedParent, except it traverses all parent links until it finds the ultimate parent of the entire linked-colour tree in which this colour resides. See also: IndexedColour::FindLinkedParent Definition at line 1113 of file colourix.cpp. { IndexedColour *Ptr = FindLinkedParent(); IndexedColour *Last = this; while (Ptr != NULL) { Last = Ptr; Ptr = Ptr->FindLinkedParent(); } return(Last); }

void IndexedColour::ForceSpotsToBeProcess (  BOOL  ForceOn  )  [static]

To set the global colour flag. When the flag is TRUE, all spot colours in the entire program are forced to act as "normal" colours; when set FALSE, all spot colours behave normally. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/8/96 Parameters: ForceOn  - TRUE to force spots to process, FALSE to let them be spots [INPUTS] Notes: In many ways this would be better as a localised option, at least limited to the selected document, but this is much more difficult to achieve, and anyway, it's better that spot colours are effectively disabled by this flag, so that it becomes obvious that spot colours are no longer special. This calls ColourManager::SelViewContextHasChanged() to make all the appropriate colour interfaces update themselves correctly. (Yeah, it's not quite the right name for what the message does, but this is just as fundamental a change as context changing) Definition at line 1934 of file colourix.cpp. { SpotsAreProcess = ForceOn; ColourManager::SelViewContextHasChanged(); }

FIXED24 IndexedColour::GetAccumulatedTintValue (  void   )

To determine the accumulated tint value of any colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/6/96 Returns: A FIXED24 value between 0.0 and 1.0 representing the accumulated Tint for this colour. See Purpose for details. If this is not a true tint colour, returns 0.0 (a 0% tint, i.e. white) If this is a spot colour, returns 1.0 (i.e. 100% ink) If this is a true tint of a spot ink, it returns the overall ink density that should be used. With a simple tint-of-spot tint, this is the normal tint value, but if there are a chain of tints, the tint values are cumulative, i.e. a 50% tint of a 50% tint of Red gives a _25_ ink density. Thus, if you apply the GetAccumulatedTintVlaue() to the GetOldestAncestor() colour, you will arrive at the right output colour. (This isn't actually how screen values for tints are produced, but the cumulative tint is used when mixing tints in blends, and most importantly when outputting separated Spot ink plates! Notes: The cumulative value is simply the tint values of each colour in turn in the parent-colour chain multiplied together (where process colours are treated as a tint value of 0.0 and the ultimate spot colour is 1.0) Definition at line 1566 of file colourix.cpp. { double Tint = 1.0; IndexedColour *Ptr = this; while (Ptr != NULL && Tint > 0.0) { Tint *= Ptr->GetTintValue().MakeDouble(); Ptr = Ptr->FindLinkedParent(); } return(FIXED24(Tint)); }

ColourModel IndexedColour::GetColourModel (  void   )  const

To determine the colour model in which an IndexedColour is defined. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The colour model in which the IndexedColour was defined Notes: If this colour is a TINT, the parent colour's colour model is returned, as tints cannot be defined in a different model to their parents Returns: Errors: - See also: IndexedColour::GetSourceColour Definition at line 582 of file colourix.cpp. { // If we're a tint, return our parent's colour. NOTE that we do not call GetType() // as we want to ask our parent even if it is 'deleted' for UNDO reasons. if (Info.ColourType == COLOURTYPE_TINT && ParentColour != NULL) return(ParentColour->GetColourModel()); return((ColourModel) Info.SourceColourModel); }

void IndexedColour::GetDebugDetails (  StringBase *  Str  )

To get information on this colour for display in the Debug Tree. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 4/5/94 Parameters: Str  - string to receive the debug details [INPUTS] -  [OUTPUTS] Returns: - Errors: - Definition at line 1854 of file colourix.cpp. { String_256 TempStr; ColourContext *cc = ColourContext::GetGlobalDefault(GetColourModel()); ColourGeneric col; String_8 UnnamedString(TEXT("N")); if (!IsNamed()) UnnamedString = TEXT("U"); GetSourceColour(&col); String_32 ModelName; cc->GetModelName(&ModelName); String_32 Type(TEXT("")); switch(GetType()) { case COLOURTYPE_SPOT: Type._MakeMsg(TEXT(" Spot")); break; case COLOURTYPE_TINT: if (TintIsShade()) TempStr._MakeMsg( TEXT(" Shade, resulting in")); else TempStr._MakeMsg( TEXT(" #1%ld% Tint, resulting in"), (INT32) (GetTintValue().MakeDouble()*100)); break; case COLOURTYPE_LINKED: Type._MakeMsg(TEXT(" Linked, resulting in")); break; default: break; } TempStr._MakeMsg( TEXT(" #1%sIxCol (#2%s) =#3%s #4%s(#5%ld, #6%ld, #7%ld, #8%ld)\r\n"), (TCHAR *) UnnamedString, (TCHAR *) *(GetName(TRUE)), (TCHAR *) Type, (TCHAR *) ModelName, (INT32) (col.Component1.MakeDouble()*100), (INT32) (col.Component2.MakeDouble()*100), (INT32) (col.Component3.MakeDouble()*100), (INT32) (col.Component4.MakeDouble()*100)); (*Str) += TempStr; }

String_64 * IndexedColour::GetName (  BOOL  ReturnTrueID = FALSE  )

To find the name of an IndexedColour (or the ID of an unnamed indexed colour). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 02/04/94 Parameters: ReturnTrueID  - FALSE (the default) to retrieve the 'normal' name. If this [INPUTS] colour is unnamed, the string "Unnamed" will be returned. TRUE (*use with care*) to return a unique id for this colour. If unnamed, this will return a unique name string like "_362180". This is only intended for use by the import/export system. -  [OUTPUTS] Returns: A pointer to a String_64 containing the name of this indexed colour If it is named, the return value is always the name If it is unnamed, then either "Unnamed" or a unique id "_1234567" will be returned. Errors: - Definition at line 893 of file colourix.cpp. { static String_64 Default(_R(IDS_LOCALCOLOUR)); if (IsNamed()) { if (Name != NULL) return(Name); } else { if (ReturnTrueID) { // If we're an unnamed colour, then we generate an "ID" (not a name, honest, guv!) // which is unique. This is used for export/import to recognise unnamed colours if (Name == NULL) { Name = new String_64; if (Name != NULL) Name->_MakeMsg( TEXT("_#1%ld"), (UINT32)(UINT_PTR)(this) ); } if (Name != NULL) return(Name); } } return(&Default); }

FIXED24 IndexedColour::GetShadeValueX (  void   )  const

Gets the current Shade Saturation value for the colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A FIXED24 value between -1.0 and 1.0 representing the Shade for this colour This value is the half of the shading settings for affecting Saturation (If the colour is not a Tint/Shade, debug builds will ENSURE, and all builds will return 1.0 (a 100% shade)) Notes: Internally, tint/shade is currently stored in the SourceColour.Component1 field And now the Component2 field as well. Bodgy city dude. This should not be relied upon externally. Definition at line 1661 of file colourix.cpp. { if (GetType() != COLOURTYPE_TINT || !Info.InheritComponent1) { ERROR3("Attempt to read tint value for a non-shade colour"); return(FIXED24(1.0)); } return(SourceColour.Component1); }

FIXED24 IndexedColour::GetShadeValueY (  void   )  const

Gets the current Shade Brightness value for the colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A FIXED24 value between -1.0 and 1.0 representing the Shade for this colour This value is the half of the shading settings for affecting Brightness (If the colour is not a Tint/Shade, debug builds will ENSURE, and all builds will return 1.0 (a 100% shade)) Notes: Internally, tint/shade is currently stored in the SourceColour.Component1 field And now the Component2 field as well. Bodgy city dude. This should not be relied upon externally. Definition at line 1695 of file colourix.cpp. { if (GetType() != COLOURTYPE_TINT || !Info.InheritComponent1) { ERROR3("Attempt to read tint value for a non-shade colour"); return(FIXED24(1.0)); } return(SourceColour.Component2); }

void IndexedColour::GetSourceColour (  ColourGeneric *  Result  )

Gets the definition of the IndexedColour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The colour definition of this IndexedColour, in its native colour model Notes: If the colour is Tint/Linked, this may involve a recursive set of calls which will convert and override each parent colour up the chain until the resulting colour definition for this colour is eventually produced at the end. Returns: Errors: - See also: IndexedColour::GetColourModel Definition at line 615 of file colourix.cpp. { ERROR3IF(Result == &SourceColour, "Illegal attempt to GetSourceColour into a colour's own SourceColour field!"); if (ParentColour == NULL || ParentColour == this || (Info.ColourType != COLOURTYPE_LINKED && Info.ColourType != COLOURTYPE_TINT)) { // We are not linked to a parent colour (or the link is scarily illegal to ourself!) // (ParentColour == NULL OR we are not tint/linked) // - simply copy our own colour definition, checking that this is not an internal // call to get a source colour definition into our own source colour! if (&SourceColour != Result) memcpy(Result, &SourceColour, sizeof(ColourGeneric)); } else { ERROR3IF(ParentColour == NULL || ParentColour == this || ParentColour->IsADescendantOf(this), "Consistency failure in IndexedColour parent linkage"); // Ask our parent for its colour definition - recurse! ParentColour->GetSourceColour(Result); // Get our 'parent' colour context ColourContext *cc = ColourContext::GetGlobalDefault(GetColourModel()); ERROR3IF(cc == NULL, "IndexedColour::GetSourceColour - illegal colour context in use?!"); // Now, override the colour as necessary // NOTE that we do NOT call GetType(), as this might return COLOURTYPE_NORMAL for tints/linked // colours which have 'deleted' parents. This is due to nasty UNDO considerations - we retain // our linked parent internally when it is 'deleted'. if (Info.ColourType == COLOURTYPE_LINKED) { // If necessary, convert the Result colour into our own colour model if (ParentColour->GetColourModel() != GetColourModel()) { ColourContext *ccSource = ColourContext::GetGlobalDefault(ParentColour->GetColourModel()); if (ccSource != NULL) // Shouldn't happen, but let's be safe { ColourGeneric Source; memcpy(&Source, Result, sizeof(ColourGeneric)); cc->ConvertColour(ccSource, &Source, Result); } } // **** ToDo !!!! Override by copying OR Inherit by scaling !!!! // This is a linked colour. Override the given components with our own values if (!Info.InheritComponent1) Result->Component1 = SourceColour.Component1; if (!Info.InheritComponent2) Result->Component2 = SourceColour.Component2; if (!Info.InheritComponent3) Result->Component3 = SourceColour.Component3; if (!Info.InheritComponent4) Result->Component4 = SourceColour.Component4; } else if (Info.ColourType == COLOURTYPE_TINT) { // This is a tint. Component 1 of our 'SourceColour' is the tinting value // We get our 'parent' colour context to work out how to apply the tint/shade if (TintIsShade()) cc->ApplyShade(SourceColour.Component1, SourceColour.Component2, Result); // Shade it else cc->ApplyTint(SourceColour.Component1, Result); // Tint it } else { ERROR3("Unknown/Illegal colour type in IndexedColour::GetSourceColour"); } } }

FIXED24 IndexedColour::GetTintValue (  void   )  const

Gets the current Tint value for the colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A FIXED24 value between 0.0 and 1.0 representing the Tint for this colour Note that a spot colour returns 1.0 (a 100% tint - 100% ink density), and any process (non-spot/tint) colour returns 0.0 (a 0% tint, i.e. no ink). NOTE that the returned tint value simply indicates how much this colour tints its parent colour (if at all). If you want to know how much ink will actually be produced for this colour, then you want to use GetAccumulatedTintValue() instead. Notes: Internally, tint is currently stored in the SourceColour.Component1 field This should not be relied upon externally. See also: IndexedColour::GetAccumulatedTintValue Definition at line 1520 of file colourix.cpp. { if (GetType() == COLOURTYPE_SPOT) return(FIXED24(1.0)); // Spot colour is a 100% tint if (GetType() != COLOURTYPE_TINT || TintIsShade()) return(FIXED24(0.0)); // Any process colour is a 0% tint return(SourceColour.Component1); // Any tint is a (Tint)% tint }

IndexedColourType IndexedColour::GetType (  void   )  const

Determines the type of this colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/94 Returns: The type of this colour: MonoOn COLOURTYPE_NORMAL, COLOURTYPE_SPOT, COLOURTYPE_TINT, COLOURTYPE_LINKED MonoOff Notes: If this colour is linked to a deleted colour, then for sneaky undo reasons it (internally) remains linked. However, it pretends to the outside world that it is in fact a normal colour. See also: IndexedColour::SetType; IndexedColour::FindLinkedParent; IndexedColour::SetLinkedParent Definition at line 497 of file colourix.cpp. { if ((Info.ColourType == (UINT32) COLOURTYPE_LINKED || Info.ColourType == (UINT32) COLOURTYPE_TINT) && ParentColour != NULL && ParentColour->IsDeleted()) { return(COLOURTYPE_NORMAL); } // If the global "SpotsareProcess" flag is set, then spots pretend to be normal // Unnamed/Local colours also cannot be spots, so in case we accidentally get into the // wrong state, we make sure never to return a silly result. if (Info.ColourType == COLOURTYPE_SPOT && (SpotsAreProcess || !Info.IsNamed)) return(COLOURTYPE_NORMAL); return((IndexedColourType) Info.ColourType); }

BOOL IndexedColour::HasLinkedChildren (  void   )  [inline]

To determine if any other IndexedColour references this IndexedColour (An IndexedColour must not be deleted if it is in use). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the IndexedColour is in use (as a ParentColour) by other IndexedCols Notes: This is a simple usage count, and does not handle references from undo-system hidden nodes etc. This simply records how many other IndexedColours hold ParentColour pointers to this IndexedColour. Returns: Errors: - See also: IndexedColour::IncrementChildUsage; IndexedColour::DecrementChildUsage Definition at line 535 of file colourix.h. { return(ChildUsage != 0); }

void IndexedColour::IncrementChildUsage (  void   )  [inline, protected]

Informs the IndexedColour that yet another thing is referencing it. An IndexedColour must not be deleted if its usage count != 0 Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: IndexedColour::DecrementChildUsage; IndexedColour::HasLinkedChildren Definition at line 476 of file colourix.h. { ENSURE(IsNamed(), "Attempt to increment child usage of an UNNAMED colour!"); ChildUsage++; }

void IndexedColour::IncrementUsage (  void   )  [inline]

Informs the IndexedColour that yet another thing is referencing it. An IndexedColour should not be deleted if its usage count != 0 A non-zero usage count on exit will generate ENSUREs which usually signal memory leaks or people forgetting to link/delink themselves properly. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: IndexedColour::DecrementUsage; IndexedColour::IsInUse Definition at line 387 of file colourix.h. { UsageCount++; }

BOOL IndexedColour::InheritsComponent (  UINT32  ComponentID  )

To determine if a given component of a colour is inherited from its linked parent colour. Always returns FALSE if a colour is not linked. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: ComponentID,:  a number [1..4] indicating which component of the colour [INPUTS] you wish to find out about. Returns: TRUE if the component is inherited from the parent FALSE if the component overrides the parent, or if the colour isn't linked Notes: Should be used in conjunction with the appropriate ColourContext for this colour's colour model to determine if *valid* components of a colour are inherited from their parent colour. If asked about an invalid component, the result will be indeterminate (generally FALSE, but somebody may have set it to TRUE without checking if it is a valid component) See also: IndexedColour::GetType(); ColourContext::GetComponentName; IndexedColour::SetInheritsComponent Definition at line 1345 of file colourix.cpp. { ERROR3IF(ComponentID < 1 || ComponentID > 4, "Bad colour component index passed to IndexedColour::InheritsComponent"); if (GetType() == COLOURTYPE_LINKED) { switch(ComponentID) { case 1: return(Info.InheritComponent1); case 2: return(Info.InheritComponent2); case 3: return(Info.InheritComponent3); case 4: return(Info.InheritComponent4); } } return(FALSE); }

void IndexedColour::InitialiseInfoFields (  ColourModel  ColModel  )  [protected]

Private shared code for construction of IndexedColour objects Initialises the 'Info' structure to default values Scope: private. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 142 of file colourix.cpp. { UsageCount = 0; // We are not in-use yet ChildUsage = 0; Name = NULL; // This colour has no name ParentColour = NULL; // We are not linked to another colour by default Info.OCContextHandle = 0; // Set colour model, and remember we're not cached Info.SourceColourModel = ColModel; Info.CacheColourModel = COLOURMODEL_NOTCACHED; Info.InheritComponent1 = // By default, override all components in linked colour Info.InheritComponent2 = Info.InheritComponent3 = Info.InheritComponent4 = FALSE; Info.ColourType = COLOURTYPE_NORMAL; // Is normal (not spot/tint/linked) colour Info.Deleted = FALSE; // Not a deleted (hidden) colour Info.IsNamed = FALSE; }

void IndexedColour::InvalidateCache (  void   )  [inline]

Invalidates the IndexedColours output colour cache. This ensures that the colour is re-converted and cached the next time it is used. Scope: Generally private; All public access functions invalidate the cache automatically if it is necessary (if the colour changes). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/05/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 616 of file colourix.h. { Info.CacheColourModel = COLOURMODEL_NOTCACHED; Info.OCContextHandle = 0; }

BOOL IndexedColour::IsADescendantOf (  IndexedColour *  TestParent  )

Recursively backtracks through the chain of LinkedParent links to determine if this colour is in any way (directly or indirectly) linked to the given Parent colour, and might therefore be affected by any change to said colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: TestParent  - the parent/ancestor colour we wish to test for [INPUTS] Returns: TRUE if this is indeed a descendant of the given colour Notes: To determine if a colour is the *direct* parent of another, use if (TestParent == ThisColour->FindLinkedParent()) If the TestParent is THIS colour, the return value is TRUE (i.e Yes, a change to the 'Parent' colour will affect 'this' colour!). {This is also an end-of- recursion clause} This method only calculates descendant information for LINKED/TINT colours. Non-linked/tint colours will always spell the end of the search. Is quite happy if TestParent is NULL - will always return FALSE in this case Definition at line 1040 of file colourix.cpp. { if (TestParent == NULL) // Silly test! Of course it's not! return(FALSE); if (this == TestParent) // We are the colour being tested - we are related return(TRUE); // We cannot be descended, as we're a normal colour if (GetType() == COLOURTYPE_NORMAL || GetType() == COLOURTYPE_SPOT) return(FALSE); if (ParentColour == NULL) // We have no parent, so cannot be descended from anything return(FALSE); // Ask our parent to check back in the family tree return(ParentColour->IsADescendantOf(TestParent)); }

BOOL IndexedColour::IsDeleted (  void   )  [inline]

To determine if this colour has been marked 'deleted'. This is used for undo, to hide colours which have been 'deleted'. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 3/6/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if this colour is marked 'deleted' FALSE if it is not Errors: - See also: IndexedColour::SetDeleted Definition at line 559 of file colourix.h. { return(Info.Deleted); }

BOOL IndexedColour::IsDifferent (  const IndexedColour &  Other, FIXED24  ErrorLimit )

Definition at line 804 of file colourix.cpp. { if (GetType() != Other.GetType()) return(TRUE); if (GetColourModel() != Other.GetColourModel()) return(TRUE); // If this is a linked colour, check if their inheritance flags match if (GetType() == COLOURTYPE_LINKED) { if (ParentColour != Other.ParentColour) return(TRUE); if (Info.InheritComponent1 != Other.Info.InheritComponent1 || Info.InheritComponent2 != Other.Info.InheritComponent2 || Info.InheritComponent3 != Other.Info.InheritComponent3 || Info.InheritComponent4 != Other.Info.InheritComponent4) return(TRUE); } // If this is a tint, it has no components in the regular sense. // Return immediately with the result of comparing the tint values if (GetType() == COLOURTYPE_TINT) { if (ParentColour != Other.ParentColour) return(TRUE); if (TintIsShade() != Other.TintIsShade()) return(TRUE); if (TintIsShade()) { return( OUTSIDE_LIMIT(GetShadeValueX(), Other.GetShadeValueX()) || OUTSIDE_LIMIT(GetShadeValueY(), Other.GetShadeValueY()) ); } return( OUTSIDE_LIMIT(GetTintValue(), Other.GetTintValue()) ); } // Special case for greyscales... if (GetColourModel() == COLOURMODEL_GREYT) { // We ignore the 2nd and 3rd components as they are not used. if (OUTSIDE_LIMIT(SourceColour.Component1, Other.SourceColour.Component1) || OUTSIDE_LIMIT(SourceColour.Component4, Other.SourceColour.Component4)) return(TRUE); } else { if (OUTSIDE_LIMIT(SourceColour.Component1, Other.SourceColour.Component1) || OUTSIDE_LIMIT(SourceColour.Component2, Other.SourceColour.Component2) || OUTSIDE_LIMIT(SourceColour.Component3, Other.SourceColour.Component3) || OUTSIDE_LIMIT(SourceColour.Component4, Other.SourceColour.Component4)) return(TRUE); } return(FALSE); }

BOOL IndexedColour::IsDifferent (  const IndexedColour &  Other  )

To determine if two indexed colours share a common definition. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/8/94 Parameters: Other  - the other indexed colour to which 'this' will be compared [INPUTS] -  [OUTPUTS] Returns: TRUE if the two colours are considered different FALSE if they are considered the same This is defined as: Same Colour model, and source colour definitions and both are linked to/tint of the same colour (or none), and the 'no colour' (and if linked: inheritance bits; if tint: tinting values) and colour type match exactly. NOTE especially that this does NOT compare the names of the colours Definition at line 714 of file colourix.cpp. { if (GetType() != Other.GetType()) return(TRUE); if (GetColourModel() != Other.GetColourModel()) return(TRUE); // If this is a linked colour, check if their inheritance flags match if (GetType() == COLOURTYPE_LINKED) { if (ParentColour != Other.ParentColour) return(TRUE); if (Info.InheritComponent1 != Other.Info.InheritComponent1 || Info.InheritComponent2 != Other.Info.InheritComponent2 || Info.InheritComponent3 != Other.Info.InheritComponent3 || Info.InheritComponent4 != Other.Info.InheritComponent4) return(TRUE); } // If this is a tint, it has no components in the regular sense. // Return immediately with the result of comparing the tint values if (GetType() == COLOURTYPE_TINT) { if (ParentColour != Other.ParentColour) return(TRUE); if (TintIsShade() != Other.TintIsShade()) return(TRUE); if (TintIsShade()) { return(GetShadeValueX() != Other.GetShadeValueX() || GetShadeValueY() != Other.GetShadeValueY()); } return(GetTintValue() != Other.GetTintValue()); } if (GetColourModel() == COLOURMODEL_GREYT) { // We ignore the 2nd and 3rd components as they are not used. // (Should not be necessary, as these components should be zeroed anyway) if (SourceColour.Component1 != Other.SourceColour.Component1 || SourceColour.Component4 != Other.SourceColour.Component4) return(TRUE); } else { if (SourceColour.Component1 != Other.SourceColour.Component1 || SourceColour.Component2 != Other.SourceColour.Component2 || SourceColour.Component3 != Other.SourceColour.Component3 || SourceColour.Component4 != Other.SourceColour.Component4) return(TRUE); } return(FALSE); }

BOOL IndexedColour::IsInUse (  BOOL  IgnoreColourGallery = FALSE  )  [inline]

To determine if anything references this IndexedColour (An IndexedColour must not be deleted if it is in use). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: [IgnoreColourGallery  - INTERNAL paramter for Colour SuperGallery ONLY] [INPUTS] [LEAVE THIS PARAMETER OUT!] -  [OUTPUTS] Returns: FALSE if the IndexedColour can safely be deleted TRUE if the IndexedColour is in use Notes: This is a simple usage count, and does not handle references from undo-system hidden nodes etc. This simply records how many things hold pointers to this IndexedColour object. Returns: Errors: - See also: IndexedColour::IncrementUsage; IndexedColour::DecrementUsage Definition at line 446 of file colourix.h. { // If this item is referenced in the colour gallery, the gallery needs to know if // nobody *else* is using the colour (i.e. if it has more than 1 user) if (IgnoreColourGallery) return(UsageCount > 1); // Under normal circumstances, the colour is in use if anybody is using it return(UsageCount != 0); }

BOOL IndexedColour::IsNamed (  void   )  [inline]

Determines if this colour has been given a name. This cannot be determined using the GetName function, which returns a default name if the colour is unnamed. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/9/94 Returns: TRUE if this colour is named (GetName will return this name) FALSE if this colour is not named (GetName will return a string like "Unnamed colour" if this is the case) See also: IndexedColour::SetName; IndexedColour::GetName Definition at line 729 of file colourix.h. { return((Info.IsNamed) ? TRUE : FALSE); // **** !!!! TEMPORARY BODGE! //return(Name != NULL); }

BOOL IndexedColour::IsSpotOrTintOfSpot (  void   )  const

Determines if this colour is either a spot colour or a true tint of a spot colour. (Tints can unfortunately be made from non-spot colour parents, so you need to call this function to determine if a tint really is cleanly derived from a spot colour, or if it must be treated as a simple process colour). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/6/96 Returns: TRUE if this colour is either a spot colour or a tint of a spot colour Thus, this returns TRUE if the colour itself is a Spot, or if it is a Tint and its parent returns TRUE from IsSpotOrTintOfSpot(). Notes: If a colour in the tint chain is deleted, then all children must become process (non true-tint) colours, so this will return FALSE Definition at line 540 of file colourix.cpp. { if (Info.Deleted) return(FALSE); IndexedColourType Type = GetType(); if (Type == COLOURTYPE_SPOT) return(TRUE); // Is it a true spot colour? if (Type != COLOURTYPE_TINT || TintIsShade()) return(FALSE); // It's not even a tint if (ParentColour == NULL) return(FALSE); // We have no parent colour // OK, we're a tint of something. Recurse to find out if that something // is a true tint or a spot colour. return(ParentColour->IsSpotOrTintOfSpot()); }

void IndexedColour::LinkedAncestorHasChanged (  void   )  [inline]

Informs an IndexedColour that an ancestor in the linking chain has changed, and that therefore, it may also have changed. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/05/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - The ColourManager automatically calls this function for all affected colours whenever it recieves a ColourChangingMsg COLOURUPDATED, so it should never be necessary for anyone other than ColourManager to call this function. Notes: Currently this simply invalidates the cache to make the next access update the colour from its Parent(s). A separate function has been used just in case we change our minds about how this should be done in the future. Returns: Errors: - See also: - Definition at line 648 of file colourix.h. { InvalidateCache(); }

IndexedColour & IndexedColour::operator= (  const IndexedColour &  Other  )

IndexedColour assignment operator Copies the definition of one IndexedColour into another Notes: The name field is copied verbatim - if you want it to say 'Copy of ...' then you'll have to prepend this text yourself. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: Other  - colour to copy [INPUTS] -  [OUTPUTS] Returns: Errors: ERROR2 if you try to copy a colour over itself Definition at line 448 of file colourix.cpp. { ERROR2IF(&Other == this, *this, "Attempt to copy an IndexedColour over itself!"); Info = Other.Info; memcpy(&SourceColour, &Other.SourceColour, sizeof(ColourGeneric)); memcpy(&CachedColour, &Other.CachedColour, sizeof(ColourGeneric)); if (ParentColour != NULL) // Delink from old parent (if any) ParentColour->DecrementChildUsage(); ParentColour = Other.ParentColour; if (ParentColour != NULL) // Link to new parent (if any) ParentColour->IncrementChildUsage(); // UsageCount = 0; // These DO NOT CHANGE! We still have people referencing us // ChildUsage = 0; // and we must not forget about them! Info.IsNamed = FALSE; if (((IndexedColour *)&Other)->IsNamed()) SetName(*(Other.Name)); // Copy the string, not the string-pointer return(*this); }

void IndexedColour::SetDeleted (  BOOL  DeletedFlag  )  [inline]

This marks/unmarks a colour as 'deleted'. This flag is used for undo, to hide colours which have been 'deleted'. Remember that this constitutes a change to the colour, so you should call ColourManager::ColourListHasChanged, to ensure that the Colour dialogues update all displayed lists to show/not-show this colour. Scope: Only intended for internal ColourManager use Notes: Used by the undoable ColourManager OpColourChange. You should use colour manager calls to delete colours rather than touching them directly. Note that you can 'delete'/'undelete' colours even when they are deemed 'In Use'. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 3/6/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: IndexedColour::IsInUse; IndexedColour::IsDeleted; ColourManager::ColourHasChanged Definition at line 591 of file colourix.h. { Info.Deleted = DeletedFlag; }

BOOL IndexedColour::SetInheritsComponent (  UINT32  ComponentID, BOOL  Inherits )

To set if a given component of a colour is inherited from its linked parent colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: ComponentID,:  a number [1..4] indicating which component of the colour [INPUTS] you wish to set inheritance information for. Inherits - TRUE if the component is to be inherited from the parent FALSE if the component is to override the parent Returns: TRUE if this results in the stored value actually changing Errors: In a debug build, will give an ERROR3 if the colour is not linked or if the index given is out of range. In all builds, incorrect parameters will be ignored. Notes: Should be used in conjunction with the appropriate ColourContext for this colour's colour model to determine if a component is *valid* before you try to set it. See also: IndexedColour::GetType(); ColourContext::GetComponentName; IndexedColour::InheritsComponent Definition at line 1402 of file colourix.cpp. { BOOL Result = FALSE; ERROR3IF(ComponentID < 1 || ComponentID > 4, "Bad colour component index passed to IndexedColour::InheritsComponent"); ERROR3IF(GetType() != COLOURTYPE_LINKED, "Attempt to set Component Inheritance for non-Linked colour"); UINT32 ItInherits = (Inherits) ? 1 : 0; if (GetType() == COLOURTYPE_LINKED) { switch(ComponentID) { case 1: Result = (Info.InheritComponent1 != ItInherits); Info.InheritComponent1 = ItInherits; break; case 2: Result = (Info.InheritComponent2 != ItInherits); Info.InheritComponent2 = ItInherits; break; case 3: Result = (Info.InheritComponent3 != ItInherits); Info.InheritComponent3 = ItInherits; break; case 4: Result = (Info.InheritComponent4 != ItInherits); Info.InheritComponent4 = ItInherits; break; } } if (Result) // If the colour has changed, invalidate the output cache InvalidateCache(); return(Result); }

void IndexedColour::SetLinkedParent (  IndexedColour *  Parent, IndexedColourType  NewType = COLOURTYPE_LINKED )

To make a colour linked to or a tint of another colour. This links the colour to the parent. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: Parent  - the new Linked/Tint parent IndexedColour, or [INPUTS] NULL to remove any existing link NewType - The ColourType to set this to. Note that for NORMAL/SPOT, the parent field must be NULL; For LINKED/TINT, it must point at a valid Named IndexedColour. If this is not the case, an ERROR3 will occur. Notes: Generally, the colour's colour model and definition will be unaffected. However, if the colour was previously linked/tint, and it is being made into a standalone colour, the existing linked colour definition will be read, and then placed into SourceColour as a standalone version of the previous linked definition. (i.e. the colour's appearance will not change but the link will be broken) If the colour was not already a COLOURTYPE_LINKED when it is being made LINKED, all components will be set to override the parent. If the colour was not already a COLOURTYPE_TINT when it is being made a TINT, it will be set to be a 100% tint (no tinting at all) When making a COLOURTYPE_TINT colour, it will be a TINT, not a SHADE. To make a shade, make it COLOURTYPE_TINT then call SetTintOrShade(TRUE); If it was already a COLOURTYPE_TINT, the tint/shade state is unaffected. The colour's output cache is flushed by this call It is your responsibility to confirm overwriting the colour. It is also your responsibility to inform the system that this colour has changed, by calling ColourManager::ColourHasChanged IMPORTANT NOTE: This method allows you to do things like making a colour 'normal' (supposedly not linked), but still set a parent colour. This is a potentially dangerous practice so be very careful. (It is allowed so that the colour editor can cunningly remember what a colour was last linked to, in order to be far more helpful to the user). Scope: private? Generally speaking, you should not be calling this method, unless you are the colour editor, or a load/import filter. See also: IndexedColour::GetLinkedParent; IndexedColour::GetLastLinkedParent; IndexedColour::SetInheritsComponent; IndexedColour::SetType; IndexedColourType; ColourManager::ColourHasChanged Returns: Errors: ERROR3 if you try to do anythign totally stupid (circular linking, linking to deleted colours, linking to unnamed colours, etc) Definition at line 1188 of file colourix.cpp. { if (this == Parent) { ERROR3("Illegal attempt to make an IndexedColour Linked to itself"); return; } if (Parent != NULL && Parent->IsADescendantOf(this)) { // Our new parent-to-be is already a linked child of us! ERROR3("Illegal attempt to generate circular reference in Colour linking"); return; } if (Parent != NULL && !Parent->IsNamed()) { ERROR3("Illegal attempt to use UNNAMED IndexedColour as a linked parent"); return; } if (Parent!= NULL && Parent->IsDeleted()) { ERROR3("Illegal attempt to use 'DELETED' IndexedColour as a linked parent"); return; } switch(NewType) { case COLOURTYPE_LINKED: if (GetType() != COLOURTYPE_LINKED) { Info.InheritComponent1 = // Override all components for now Info.InheritComponent2 = Info.InheritComponent3 = Info.InheritComponent4 = FALSE; } break; case COLOURTYPE_TINT: if (GetType() != COLOURTYPE_TINT) { SetType(NewType); // Set type now to stop the next call ENSURE'ing SetTintOrShade(FALSE); // Make it a real tint (not a shade "tint") SetTintValue(FIXED24(1.0)); // 100% tint (the colour) for now } // Swapping from Tint to Shade (which are both COLOURTYPE_TINT will need to do this, // so we do it even if it is supposely chnaging to the same "type" if (Parent != NULL) Info.SourceColourModel = (UINT32) Parent->GetColourModel(); break; default: // COLOURTYPE_NORMAL, COLOURTYPE_SPOT if (FindLastLinkedParent() != NULL) { // If this was previously a tint/linked colour, then copy the resulting // colour definition into this colour to make it standalone again. ColourGeneric NewSourceColour; GetSourceColour(&NewSourceColour); memcpy(&SourceColour, &NewSourceColour, sizeof(ColourGeneric)); } break; } if (ParentColour != NULL) ParentColour->DecrementChildUsage(); ParentColour = Parent; // Set the new linked/tint parent colour if (ParentColour != NULL) ParentColour->IncrementChildUsage(); InvalidateCache(); // Invalidate the output colour cache SetType(NewType); // And set the new type of the colour }

void IndexedColour::SetName (  const StringBase &  NewName, BOOL  ForceNamed = TRUE )

To set the name of an IndexedColour. The name will be truncated to a maximum length of 63 characters. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 05/04/94 Parameters: NewName  - A StringBase which will be *copied* as this colours new name. [INPUTS] NOTE that this name will be truncated to a maximum length of 63 characters, and any underscore characters within it will be converted to spaces ForceNamed - if TRUE (the default), this forces the colour to become 'named' and will strip out underline characters from it. If FALSE (*use with care*) this will leave the colour in its current state, (i.e. won't make an unnamed colour named) and will retain underlines. This is only intended for use by importers for handling export/import of unnamed colours. Notes: Any underscore characters in the name will be converted to spaces, on the grounds that the export system uses underscores as a special name identifier to recognise unnamed colours. Suffice to say we just don't allow underscores If NewName is NULL, or if we fail to allocate space for the name to be stored, the colour will revert to having no name. Setting the name of an IndexedColour makes it a Named IndexedColour (Trust me, that is less silly than it sounds! ;-) See also: IndexedColour::SetUnnamed; IndexedColour::IsNamed Definition at line 960 of file colourix.cpp. { if (ForceNamed) Info.IsNamed = TRUE; if (Name == NULL) Name = new String_64; // If this fails, Name will just be NULL, which is safe if (Name != NULL) { if (ForceNamed) { const TCHAR *Src = (const TCHAR *)NewName; TCHAR *Dest = (TCHAR *)(*Name); // Copy up to 63 chars across camStrncpy(Dest, Src, 63); // convert underscores into spaces Name->SwapChar(TCHAR('_'), TCHAR(' ')); } else { NewName.Left(Name, 63); // Truncate to 63 chars max, and copy } } }

void IndexedColour::SetShadeValues (  FIXED24  NewShadeValueX, FIXED24  NewShadeValueY )

Sets new shade values for a Shade colour. Will generate ENSURE failures in the debug build if the colour is not a Tint/Shade. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Parameters: NewShadeValueX  - the new Shade Saturation value, in the range -1.0 to 1.0 [INPUTS] NewShadeValueY - the new Shade Brightness value, in the range -1.0 to 1.0 -  [OUTPUTS] Returns: - This also forces a Tint to be a shade (not a true tint) Notes: Internally, tint/shade is currently stored in the SourceColour.Component1 field. And now the Component2 field as well. Bodgy city dude. This should not be relied upon externally. See also: IndexedColour::SetTintValue Definition at line 1606 of file colourix.cpp. { if (GetType() != COLOURTYPE_TINT) { ERROR3("Your puny attempt to set the shade values for a non-shade colour has been ignored"); return; } Info.InheritComponent1 = TRUE; // Force it to be a shade if (NewShadeValueX <= FIXED24(-1.0)) NewShadeValueX = FIXED24(-1.0); if (NewShadeValueX >= FIXED24(1.0)) NewShadeValueX = FIXED24(1.0); SourceColour.Component1 = NewShadeValueX; if (NewShadeValueY <= FIXED24(-1.0)) NewShadeValueY = FIXED24(-1.0); if (NewShadeValueY >= FIXED24(1.0)) NewShadeValueY = FIXED24(1.0); SourceColour.Component2 = NewShadeValueY; InvalidateCache(); // The colour has changed, so invalidate the output cache }

void IndexedColour::SetSourceColourModel (  ColourModel  NewModel  )  [inline, protected]

Sets our colour model number, and invalidates the colour cache Scope: Private, for use by friend classes only. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/05/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 671 of file colourix.h. { // Set the new colour model Info.SourceColourModel = NewModel; // And invalidate the cache... Info.CacheColourModel = COLOURMODEL_NOTCACHED; Info.OCContextHandle = 0; }

void IndexedColour::SetTintOrShade (  BOOL  IsATint  )

Sets a COLOURTYPE_TINT colour to be either a Tint (fade-to-white) or a shade (fade-to-black) colour. The tint/shade fraction is unchnaged (the colour will just toggle between being darker and lighter!). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Parameters: IsATint  - TRUE to make this Tint a true Tint, FALSE to make it a Shade [INPUTS] Notes: Internally, tint/shade is currently stored in the SourceColour.Component1 field This should not be relied upon externally. Definition at line 1726 of file colourix.cpp. { if (GetType() != COLOURTYPE_TINT) { ERROR3("Attempt to set tint/shade value for a non-tint colour"); return; } Info.InheritComponent1 = IsATint ? 1 : 0; }

void IndexedColour::SetTintValue (  FIXED24  NewTintValue  )

Sets a new tint value for a Tint colour. Will generate ENSURE failures in the debug build if the colour is not a tint. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: NewTintValue  - the new tint value, in the range 0.0 to 1.0 [INPUTS] Any value outside this range will be clipped to 0.0 or 1.0 -  [OUTPUTS] Returns: - This also forces a Tint to be a true tint (not a shade) Notes: Internally, tint is currently stored in the SourceColour.Component1 field. This should not be relied upon externally. See also: IndexedColour::SetShadeValues Definition at line 1470 of file colourix.cpp. { if (GetType() != COLOURTYPE_TINT) { ERROR3("Your puny attempt to set the tint value for a non-tint colour has been ignored"); return; } Info.InheritComponent1 = FALSE; // Force it to be a tint (not a shade) if (NewTintValue <= FIXED24(0.0)) NewTintValue = 0; if (NewTintValue >= FIXED24(1.0)) NewTintValue = FIXED24(1.0); SourceColour.Component1 = NewTintValue; InvalidateCache(); // The colour has changed, so invalidate the output cache }

BOOL IndexedColour::SetType (  IndexedColourType  NewType  )  [protected]

Sets the type of this colour: MonoOn COLOURTYPE_NORMAL, COLOURTYPE_SPOT, COLOURTYPE_TINT, COLOURTYPE_LINKED MonoOff. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/11/94 Returns: TRUE if this caused the type of this colour to be changed FALSE if the new type is the same as the old type Notes: If you wish to make a colour Linked or a Tint, then you should set its type at the same time as its parent-link in SetLinkedParent(). If you wish to make a linked/tint colour normal again, then you should also use SetLinkedParent. On second thoughts, you shouldn't be calling this method! Scope: private See also: IndexedColour::SetType; IndexedColour::FindLinkedParent; IndexedColour::SetLinkedParent Definition at line 1299 of file colourix.cpp. { BOOL Result = (NewType != (IndexedColourType) Info.ColourType); if ((INT32)NewType < 0 || (INT32)NewType > 3) { ERROR3("Attempt to set invalid colour type"); return(FALSE); } Info.ColourType = (UINT32) NewType; if (Result) // If the colour has changed, invalidate the output cache InvalidateCache(); return(Result); }

void IndexedColour::SetUnnamed (  void   )

To UNset the name of an IndexedColour, forcing it back to being Unnamed. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 05/04/94 Definition at line 1001 of file colourix.cpp. { Info.IsNamed = FALSE; if (Name != NULL) delete Name; Name = NULL; }

ColourGeneric * IndexedColour::SourceColourPtr (  void   )  [inline, protected]

Returns a pointer to our source colour. Used to encapsulate our data for external friend users, rather than them poking directly at our data structures. Inlined, so just as efficient anyway. Scope: Private, for use by friend class ColourContext. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 12/04/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to our source colour. Note that this is our source colour so it would be appreciated if you'd not trample all over it with hob nailed boots. Errors: - See also: - Definition at line 704 of file colourix.h. { return(&SourceColour); }

void IndexedColour::SwapWith (  IndexedColour *  Other  )

Definition at line 1806 of file colourix.cpp. { // Components to copy are: // Info // SourceColour // ParentColour pointer // Name POINTER // CachedColour -- We are discarding the cache anyway so ignore // UsageCount -- We wish to keep the usage counts intact, as it is // ChildUsage the number of refs to THIS object. // Thus, only the first 4 in this list are copied. JASONSWAP(Info, Other->Info, IndexedColourInfo); JASONSWAP(SourceColour, Other->SourceColour, ColourGeneric); // Swap the Name POINTER String_64 *NameTemp = Name; Name = Other->Name; Other->Name = NameTemp; // Swap the linked/tint Parent Colour pointer IndexedColour *ParentTemp = ParentColour; ParentColour = Other->ParentColour; Other->ParentColour = ParentTemp; // And invalidate the caches just to be on the safe side Info.CacheColourModel = Other->Info.CacheColourModel = COLOURMODEL_NOTCACHED; Info.OCContextHandle = Other->Info.OCContextHandle = 0; }

BOOL IndexedColour::TintIsShade (  void   )  const

Determines if a COLOURTYPE_TINT colour is really a tint or a shade. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Returns: TRUE if this COLOURTYPE_TINT colour is a true Tint, FALSE if it's a Shade Notes: COLOURTYPE_TINT has two "subtypes" (tint-to white (tint) and tint-to-black (shade)). These are differentiated by a single flag, and are otherwise implemented identically. Thus, if it's type is "Tint" then it could be a shade! (Nasty, but gets around a shortage of flag bits, and also allows us to continue using screeds of old code which doesn't know the difference between tints and shades and doesn't need to know) Internally, tint/shade is currently stored in the SourceColour.Component1 field This should not be relied upon externally. Definition at line 1762 of file colourix.cpp. { if (Info.ColourType != COLOURTYPE_TINT) { ERROR3("TintIsShade() called for non-tint/shade colour"); return(FALSE); } return(Info.InheritComponent1); }

---

Friends And Related Function Documentation

friend class ColourContext [friend]

Definition at line 209 of file colourix.h.

friend class ColourPicker [friend]

Definition at line 211 of file colourix.h.

friend class DocColour [friend]

Definition at line 210 of file colourix.h.

---

Member Data Documentation

ColourGeneric IndexedColour::CachedColour [protected]

Definition at line 297 of file colourix.h.

DWORD IndexedColour::ChildUsage [protected]

Definition at line 300 of file colourix.h.

IndexedColourInfo IndexedColour::Info [protected]

Definition at line 295 of file colourix.h.

String_64* IndexedColour::Name [protected]

Definition at line 304 of file colourix.h.

IndexedColour* IndexedColour::ParentColour [protected]

Definition at line 299 of file colourix.h.

ColourGeneric IndexedColour::SourceColour [protected]

Definition at line 296 of file colourix.h.

BOOL IndexedColour::SpotsAreProcess = FALSE [static, private]

Definition at line 325 of file colourix.h.

DWORD IndexedColour::UsageCount [protected]

Definition at line 302 of file colourix.h.

---

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

• Kernel/colourix.h (r1785/r1282)
• Kernel/colourix.cpp (r1785/r1333)

---