DocColour Class Reference

This class defines a colour. A DocColour stores an original definition of a colour, a cache containing the definition of the colour in the last colour context in which it was used, and sundry information. DocColours have been designed to be small things to put in attributes. More...

#include <doccolor.h>

List of all members.

Public Member Functions
	DocColour ()
	Constructor for a DocColour Initialises the colour to an RGBT value representing 'no colour'. (i.e. The same as DocColour(COLOUR_TRANS)).
	~DocColour ()
	Destructor for a DocColour.
	DocColour (StockColour Col)
	Constructor for a DocColour Initialises it to the given predefined (stock) colours, as defined in stockcol.h (cf keyword StockColour).
	DocColour (ColourModel ColModel, ColourGeneric *Col)
	Constructor for a DocColour Initialises it to the given value.
	DocColour (ColourValue Red, ColourValue Green, ColourValue Blue)
	Constructor for a DocColour Initialises it to the given RGBT value. Values are ColourValues (FIXED24s) in the range 0.0 to 1.0.
	DocColour (const DocColour &other)
	DocColour copy constructor Notes: If copying a reference to an indexed colour, the indexed colours usage count will be incremented. If this is already a reference to an indexed colour, that indexed colours usage count will be decremented.
DocColour &	operator= (const DocColour &)
	DocColour assignment operator Notes: If copying a reference to an indexed colour, the indexed colours usage count will be incremented. If this is already a reference to an indexed colour, that indexed colours usage count will be decremented.
void	MakeRefToIndexedColour (IndexedColour *Other)
IndexedColour *	FindParentIndexedColour (void)
	Determines if a colour references an IndexedColour, and if so, gives access to the parent colour.
void	MakeRefToIndexedColourDBG (IndexedColour *Other, LPCSTR TheFile=NULL, INT32 TheLine=0)
	DocColour assignment - Makes this DocColour a reference to the given Indexed Colour. The Indexed Colour cannot be deleted until this DocColour releases this claim upon it (which occurs when it is deleted or re-assigned).
IndexedColour *	GetSpotParent (void)
	To determine which spot colour (if any) is the ultimate spot colour parent of this DocColour. (i.e. to see which spot plate a DocColour will appear on).
BOOL	operator== (const DocColour) const
	DocColour comparison operator.
BOOL	operator!= (const DocColour) const
	DocColour comparison operator Notes: If comparing two references to indexed colours, they will only be considered equal if they reference the SAME indexed colour (i.e. we do not compare the indexed colours).
ColourModel	GetColourModel (void) const
	{Copy} Constructor for a DocColour Notes: THIS FUNCTION DOES NOT EXIST!! DocColour::MakeRefToIndexedColour() should be used if you wish to "assign" an IndexedColour to a DocColour. To determine the colourmodel in which the given colour was defined Notes: If this is a reference to an IndexedColour, returns the colour of the referenced IndexedColour. The colour model number returned may be used as an index into the list of ColourContexts held by each document, in order to find a relevant context for the colour.
void	GetSourceColour (ColourGeneric *Result)
	Determine the native definition of the given colour Notes: If this is a reference to an IndexedColour, returns the colour of the referenced IndexedColour.
BOOL	IsTransparent (void) const
	Determines if a colour's "no colour" flag is set.
BOOL	IsSeparable (void) const
	Determines if a colour's "IsSeparable" flag is set.
void	SetSeparable (BOOL IsSeparable=TRUE)
	To set the separation/correction enable flag for a DocColour. Some colours (e.g. EOR blob colours) should not be colour-separated on screen. By default, all colours (except StockCols) will separate, but this flag can be set on "UI colours" to stop them separating.
void	Mix (DocColour *BlendStart, DocColour *BlendEnd, double BlendFraction, ColourContext *BlendContext, BOOL BlendTheLongWay=FALSE, ColourContext *OutputContext=NULL)
	"Constructor" for a DocColour - generates a blended DocColour The start and end colours are blended to create this new DocColour. The amount by which they are mixed is determined by BlendFraction. The blend occurs in the colourspace described by BlendContext. Note that BlendContext may be NULL, in which case the default context for the BlendStart colour will be used. However, this is not recommended, as this will result in a blend which may be incorrect for the context(s) in use in a given document, which could give seriously wonky colours!
void	ForceRounding (BOOL RoundingOn)
BOOL	IsForcedToRound (void)
void	SetReservedFlag (UINT32 Value)
	To set the Reserved flag of the colour info struct.
UINT32	GetReservedFlag ()
	access fn.
BOOL	IsNamed ()
	to identidy if this colour is named, or was created from a named colour. Note that not all colours that were created by Named colours will have the relevant flag set, as I have only just started using it (4/2000). This fn. was really designed to be used specifically by the brush attribute replace named colours system.
void	HackColReplacerPreDestruct ()
	As you might expect from the name this is a real bodge. Basically the named colour replacer used in the brush needs to store some colours which are converted index colours. To cut a long story short I'm looking at a deadline and this prevents an assert upon destruction, theres no reason for anyone else to use it.
void	GetDebugDetails (StringBase *Str)
void	SetRGBValue (INT32 Red, INT32 Green, INT32 Blue)
void	GetRGBValue (INT32 *Red, INT32 *Green, INT32 *Blue)
void	SetCMYKValue (PColourCMYK *New)
void	GetCMYKValue (PColourCMYK *Result)
void	GetCMYKValue (ColourContext *pContext, PColourCMYK *Result)
void	SetHSVValue (INT32 h, INT32 s, INT32 v)
void	GetHSVValue (INT32 *h, INT32 *s, INT32 *v)
	DocColour (INT32 Red, INT32 Green, INT32 Blue)
Protected Member Functions
void	MixRGB (DocColour *BlendStart, DocColour *BlendEnd, double BlendFraction, ColourContext *BlendContext)
	Internal helper function for DocColour::Mix. This is a reasonably optimised routine for mixing RGB colours.
void	MixCMYK (DocColour *BlendStart, DocColour *BlendEnd, double BlendFraction, ColourContext *BlendContext)
	Internal helper function for DocColour::Mix. This is a reasonably optimised routine for mixing CMYK colours.
void	MixHSV (DocColour *BlendStart, DocColour *BlendEnd, double BlendFraction, ColourContext *BlendContext, BOOL BlendTheLongWay=FALSE)
	Internal helper function for DocColour::Mix. This is a reasonably optimised routine for mixing HSV colours.
void	MixTint (IndexedColour *SpotParent, IndexedColour *StartTint, IndexedColour *EndTint, double BlendFraction)
	Internal helper function for DocColour::Mix. This method is used to mix the DocColours to an IndexedColour result when one or both of the end colours are tints. This simply linearly interpolates the tint values.
void	InitialiseInfoField (ColourModel ColModel)
	Private shared code for construction of DocColour objects Initialises the 'Info' structure to default values Scope: private.
void	ZapSourceColour ()
Protected Attributes
ColourInfo	Info
ColourPacked	SourceColour
ColourPacked	CachedColour
Friends
class	ColourContext

---

Detailed Description

This class defines a colour. A DocColour stores an original definition of a colour, a cache containing the definition of the colour in the last colour context in which it was used, and sundry information. DocColours have been designed to be small things to put in attributes.

Author:

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

Date:

30/03/94

DocColours cannot be used on their own, however. They have meaning only within the scope of a given colour context.

DocColours can be defined in any of the available colour models.

DocColours are stored to "low" (32-bit) precision, except when they are references to IndexedColours (which are 128-bit precision). However, colour calculations, and access to values stored in colours are generally only available through the 128bit interface.

Notes: NOTE that any use of a DocColour may result in updating its cache, so you must NOT treat DocColours as const anywhere. Also, work on original DocColours rather than copies if you want the cache to be kept fresh on the original.

See also:

IndexedColour; ColourModel; ColourContext Documentation: HowToUse.doc

Definition at line 179 of file doccolor.h.

---

Constructor & Destructor Documentation

DocColour::DocColour (   )

Constructor for a DocColour Initialises the colour to an RGBT value representing 'no colour'. (i.e. The same as DocColour(COLOUR_TRANS)). 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 doccolor.cpp. { ZapSourceColour(); InitialiseInfoField(COLOURMODEL_RGBT); SourceColour.RGBT.Red = 0; // Black & 100% Transparent SourceColour.RGBT.Green = 0; SourceColour.RGBT.Blue = 0; SourceColour.RGBT.Transparent = 255; Info.NoColour = TRUE; // And also 'no colour' transparent }

DocColour::~DocColour (   )

Destructor for a DocColour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 215 of file doccolor.cpp. { // If we are a reference to an indexed colour, tell that colour that we are // no longer referencing it if (Info.SourceColourModel == COLOURMODEL_INDEXED) SourceColour.Indexed.Colour->DecrementUsage(); }

DocColour::DocColour (  StockColour  Col  )

Constructor for a DocColour Initialises it to the given predefined (stock) colours, as defined in stockcol.h (cf keyword StockColour). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 06/04/94 Parameters: Col  - Identifies the stock colour to create [INPUTS] -  [OUTPUTS] Returns: - Notes: ALL StockColours are non-separable colours! i.e. they should only be applied to user-interface rendering Returns: Errors: - See also: StockColour Definition at line 250 of file doccolor.cpp. { ZapSourceColour(); PColourValue Red = 0, Green = 0, Blue = 0, Transparent = 0; InitialiseInfoField(COLOURMODEL_RGBT); switch (Col) { case COLOUR_TRANS: Red = Green = Blue = Transparent = 255; Info.NoColour = TRUE; break; case COLOUR_BLACK: case COLOUR_UNSELECTEDBLOB: case COLOUR_FILLDEFAULT: case COLOUR_LINEDEFAULT: case COLOUR_XORDRAG: break; case COLOUR_DKGREY: Red = Green = Blue = 64; break; case COLOUR_MIDGREY: Red = Green = Blue = 128; break; case COLOUR_XOREDIT: Red = 64; Green = 64; Blue = 230; break; case COLOUR_LTGREY: case COLOUR_BEZIERLINE: Red = Green = Blue = 192; break; case COLOUR_WHITE: Red = Green = Blue = 255; break; case COLOUR_RED: case COLOUR_XORSELECT: case COLOUR_TOOLBLOB: case COLOUR_SELECTEDBLOB: case COLOUR_BEZIERBLOB: Red = 255; break; case COLOUR_GREEN: Green = 255; break; case COLOUR_BLUE: case COLOUR_XORNEW: case COLOUR_GRID: Blue = 255; break; case COLOUR_CYAN: Green = Blue = 255; break; case COLOUR_MAGENTA: Red = Blue = 255; break; case COLOUR_YELLOW: Red = Green = 255; break; } SourceColour.RGBT.Red = Red; SourceColour.RGBT.Green = Green; SourceColour.RGBT.Blue = Blue; SourceColour.RGBT.Transparent = Transparent; Info.IsSeparable = FALSE; }

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

Constructor for a DocColour Initialises it to the given value. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: ColModel  - Colour model in which Col is defined [INPUTS] Col - definition of the colour in model ColModel -  [OUTPUTS] Returns: - Notes: Note the existence of the macros: DOCCOLOUR_RGBT(Colour_RGBT *col) DOCCOLOUR_CMYK(Colour_CMYK *col) DOCCOLOUR_HSVT(Colour_HSVT *col) DOCCOLOUR_CIET(COLOUR_CIET *col) which can be used to create DocColours from ColourRGBT etc structs e.g. ColourRGBT AnRGBTColourDefn; DocColour MyRGBT = DOCCOLOUR_RGBT(&AnRGBTColourDefn); These macros are defined in doccolor.h Returns: Errors: - See also: - Definition at line 403 of file doccolor.cpp. { ZapSourceColour(); InitialiseInfoField(ColModel); DEFAULTCONTEXT(ColModel)->PackColour(Col, &SourceColour); }

DocColour::DocColour (  ColourValue  Red, ColourValue  Green, ColourValue  Blue )

Constructor for a DocColour Initialises it to the given RGBT value. Values are ColourValues (FIXED24s) in the range 0.0 to 1.0. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: Red;  Green; Blue - The RGB definition of the colour [INPUTS] -  [OUTPUTS] Returns: - Notes: DocColours no longer support transparency/transtype. Returns: Errors: - See also: - Definition at line 357 of file doccolor.cpp. { ZapSourceColour(); ColourRGBT temp; InitialiseInfoField( COLOURMODEL_RGBT ); temp.Red = Red; // Copy data into 128-bit struct, then pack temp.Green = Green; // it into our 32-bit store. temp.Blue = Blue; temp.Transparent = 0; DEFAULTCONTEXT(COLOURMODEL_RGBT)->PackColour( (ColourGeneric *)&temp, &SourceColour ); }

DocColour::DocColour (  const DocColour &  Other  )

DocColour copy constructor Notes: If copying a reference to an indexed colour, the indexed colours usage count will be incremented. If this is already a reference to an indexed colour, that indexed colours usage count will be decremented. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Other  - colour to copy [INPUTS] -  [OUTPUTS] Returns: Errors: - Definition at line 430 of file doccolor.cpp. { ENSURE(Other.Info.SourceColourModel < MAX_COLOURMODELS, "Attempt to use illegal colour model!"); Info = Other.Info; CachedColour = Other.CachedColour; SourceColour = Other.SourceColour; if (Info.SourceColourModel == COLOURMODEL_INDEXED) { ENSURE(SourceColour.Indexed.Colour != NULL, "Corrupted DocColour (NULL IndexedColour ref) detected"); SourceColour.Indexed.Colour->IncrementUsage(); ENSURE(Info.CacheColourModel == 0, "RefToIndexedColour DocColour has a cache!!"); #ifdef TRACECOLOURIX TRACE( _T(">> Construct DocColour(DocColour => ColourIx %x) @ %x\n"), (INT32)SourceColour.Indexed.Colour, (INT32)this); #endif } }

DocColour::DocColour (  INT32  Red, INT32  Green, INT32  Blue )

Definition at line 1612 of file doccolor.cpp. { ZapSourceColour(); InitialiseInfoField(COLOURMODEL_RGBT); SourceColour.RGBT.Red = (PColourValue) Red; SourceColour.RGBT.Green = (PColourValue) Green; SourceColour.RGBT.Blue = (PColourValue) Blue; SourceColour.RGBT.Transparent = 0; }

---

Member Function Documentation

IndexedColour * DocColour::FindParentIndexedColour (  void   )  [inline]

Determines if a colour references an IndexedColour, and if so, gives access to the parent colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/6/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: NULL if this is an immediate colour else a pointer to the IndexedColour which this DocColour references See also: DocColour::MakeRefToIndexedColour Definition at line 413 of file doccolor.h. { if (Info.SourceColourModel != COLOURMODEL_INDEXED) return(NULL); return(SourceColour.Indexed.Colour); }

void DocColour::ForceRounding (  BOOL  RoundingOn  )  [inline]

Definition at line 246 of file doccolor.h. { Info.ForceRounding = RoundingOn; };

void DocColour::GetCMYKValue (  ColourContext *  pContext, PColourCMYK *  Result )

Definition at line 1715 of file doccolor.cpp. { if (pContext!=NULL) { ERROR3IF(pContext->GetColourModel() != COLOURMODEL_CMYK, "Colour context is not CMYK!"); pContext->ConvertColour(this, (ColourPacked *) Result); return; } ColourContext *CCcmyk = ColourContext::GetGlobalDefault(COLOURMODEL_CMYK); ERROR3IF(CCcmyk == NULL, "No default CMYK colour context?!"); CCcmyk->ConvertColour(this, (ColourPacked *) Result); }

void DocColour::GetCMYKValue (  PColourCMYK *  Result  )

Definition at line 1708 of file doccolor.cpp. { ColourContext *CCcmyk = ColourContext::GetGlobalDefault(COLOURMODEL_CMYK); CCcmyk->ConvertColour(this, (ColourPacked *) Result); }

ColourModel DocColour::GetColourModel (  void   )  const

{Copy} Constructor for a DocColour Notes: THIS FUNCTION DOES NOT EXIST!! DocColour::MakeRefToIndexedColour() should be used if you wish to "assign" an IndexedColour to a DocColour. To determine the colourmodel in which the given colour was defined Notes: If this is a reference to an IndexedColour, returns the colour of the referenced IndexedColour. The colour model number returned may be used as an index into the list of ColourContexts held by each document, in order to find a relevant context for the colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A Colour Model identifying the model in which the colour is defined Errors: - See also: DocColour::GetSourceColour Definition at line 490 of file doccolor.cpp. { ENSURE(Info.SourceColourModel < MAX_COLOURMODELS, "DocColour based on illegal colour model!"); // If colour is a reference to an indexed colour, return indexed colour's // colour model if (Info.SourceColourModel == COLOURMODEL_INDEXED) { ENSURE(SourceColour.Indexed.Colour != NULL, "Corrupted DocColour (NULL IndexedColour ref) detected"); return(SourceColour.Indexed.Colour->GetColourModel()); } return((ColourModel) Info.SourceColourModel); }

void DocColour::GetDebugDetails (  StringBase *  Str  )

Definition at line 1732 of file doccolor.cpp. { String_256 TempStr; if (Info.IsSeparable) *Str += TEXT(" Sep "); else *Str += TEXT(" NotSep "); if (Info.SourceColourModel == COLOURMODEL_INDEXED) { ENSURE(SourceColour.Indexed.Colour != NULL, "Corrupted DocColour (NULL IndexedColour ref) detected"); String_64 *pIndexedName = SourceColour.Indexed.Colour->GetName(); // TempStr._MakeMsg(TEXT(" (#1%s) ref->"), // pIndexedName); // This is a reference to an indexed col // (*Str) += TempStr; (*Str) += TEXT(" ("); (*Str) += (*pIndexedName); (*Str) += TEXT(") ref ->"); SourceColour.Indexed.Colour->GetDebugDetails(Str); return; } if (Info.NoColour) TempStr._MakeMsg( TEXT(" colour=transparent\r\n")); else { ColourContext *cc = ColourContext::GetGlobalDefault((ColourModel) Info.SourceColourModel); ColourGeneric col; String_32 ModelName; cc->GetModelName(&ModelName); cc->UnpackColour(&SourceColour, &col); TempStr._MakeMsg( TEXT(" colour=#1%s(#2%ld, #3%ld, #4%ld, #5%ld)\r\n"), (TCHAR *) ModelName, (INT32) (col.Component1.MakeDouble()*100), (INT32) (col.Component2.MakeDouble()*100), (INT32) (col.Component3.MakeDouble()*100), (INT32) (col.Component4.MakeDouble()*100)); } (*Str) += TempStr; }

void DocColour::GetHSVValue (  INT32 *  h, INT32 *  s, INT32 *  v )

Definition at line 1678 of file doccolor.cpp. { ColourContextHSVT *CChsvt = (ColourContextHSVT *)ColourContext::GetGlobalDefault(COLOURMODEL_HSVT); ColourHSVT result; ColourPacked bob; CChsvt->ConvertColour((DocColour *)this, (ColourGeneric *)&result); CChsvt->PackColour((ColourGeneric *)&result, (ColourPacked *)&bob); *h = (INT32) bob.HSVT.Hue; *s = (INT32) bob.HSVT.Saturation; *v = (INT32) bob.HSVT.Value; }

UINT32 DocColour::GetReservedFlag (   )

access fn. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 12/4/2000 Parameters: -  [INPUTS] Returns: the Reserved Flag of the ColourInfo struct See also: Definition at line 634 of file doccolor.cpp. { return Info.Reserved; }

void DocColour::GetRGBValue (  INT32 *  Red, INT32 *  Green, INT32 *  Blue )

Definition at line 1644 of file doccolor.cpp. { ColourContextRGBT *CCrgbt = (ColourContextRGBT *)ColourContext::GetGlobalDefault(COLOURMODEL_RGBT); ColourRGBT result; ColourPacked bob; CCrgbt->ConvertColour((DocColour *)this, (ColourGeneric *)&result); CCrgbt->PackColour((ColourGeneric *)&result, (ColourPacked *)&bob); *Red = (INT32) bob.RGBT.Red; *Green = (INT32) bob.RGBT.Green; *Blue = (INT32) bob.RGBT.Blue; }

void DocColour::GetSourceColour (  ColourGeneric *  Result  )

Determine the native definition of the given colour Notes: If this is a reference to an IndexedColour, returns the colour of the referenced IndexedColour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 30/03/94 Parameters: Result  - pointer to structure to recieve the colour [INPUTS] -  [OUTPUTS] Returns: The native definition of the colour. This is a ColourPacked containing the colour as defined in its original Colour Model (cf DocColour::GetColourModel) Errors: - See also: DocColour::GetColourModel Definition at line 528 of file doccolor.cpp. { ENSURE(Info.SourceColourModel < MAX_COLOURMODELS, "DocColour based on illegal colour model!"); // If colour is reference to indexed colour, ask the indexed colour for the // original colour definition, else return our own definition. if (Info.SourceColourModel == COLOURMODEL_INDEXED) { ENSURE(SourceColour.Indexed.Colour != NULL, "Corrupted DocColour (NULL IndexedColour ref) detected"); SourceColour.Indexed.Colour->GetSourceColour(Result); } else DEFAULTCONTEXT(Info.SourceColourModel)-> UnpackColour(&SourceColour, Result); if (Info.ForceRounding) { // Our ForceRounding flag is on, so we must round all components to the closest // half percentage value. This is a bodge to correct for representational errors // in PANTONE library colours. double temp; temp = Result->Component1.MakeDouble(); temp = (floor((temp * 200.0) + 0.5)) / 200.0; // Round to nearest 200th Result->Component1 = temp; temp = Result->Component2.MakeDouble(); temp = (floor((temp * 200.0) + 0.5)) / 200.0; // Round to nearest 200th Result->Component2 = temp; temp = Result->Component3.MakeDouble(); temp = (floor((temp * 200.0) + 0.5)) / 200.0; // Round to nearest 200th Result->Component3 = temp; temp = Result->Component4.MakeDouble(); temp = (floor((temp * 200.0) + 0.5)) / 200.0; // Round to nearest 200th Result->Component4 = temp; } }

IndexedColour * DocColour::GetSpotParent (  void   )

To determine which spot colour (if any) is the ultimate spot colour parent of this DocColour. (i.e. to see which spot plate a DocColour will appear on). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 25/6/96 Returns: NULL if this DocColour does not reference an indexed colour, or if the referenced colour is not a spot colour, else A pointer to the ultimate parent spot colour of this colour. Notes: This only returns a non-NULL result if this colour is a TRUE tint of a spot colour (as opposed to a tint of a process colour). Definition at line 1525 of file doccolor.cpp. { IndexedColour *Parent = FindParentIndexedColour(); if (Parent != NULL) { if (!Parent->IsSpotOrTintOfSpot()) // If we aren't a TRUE tint, return NULL return(NULL); Parent = Parent->FindOldestAncestor(); // ...else find our spot parent if (Parent->IsSpotOrTintOfSpot()) // (and check just to be really safe) return(Parent); } // no parent, or it's not a spot colour return(NULL); }

void DocColour::HackColReplacerPreDestruct (   )

As you might expect from the name this is a real bodge. Basically the named colour replacer used in the brush needs to store some colours which are converted index colours. To cut a long story short I'm looking at a deadline and this prevents an assert upon destruction, theres no reason for anyone else to use it. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 10/6/2000 Parameters: -  [INPUTS] Returns: - See also: Definition at line 696 of file doccolor.cpp. { Info.SourceColourModel = MAX_COLOURMODELS; }

void DocColour::InitialiseInfoField (  ColourModel  ColModel  )  [protected]

Private shared code for construction of DocColour 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 150 of file doccolor.cpp. { ENSURE((INT32) ColModel < MAX_COLOURMODELS, "Attempt to use illegal colour model!"); Info.Reserved = 0; // Reserved - set to zero for safety Info.OCContextHandle = 0; Info.SourceColourModel = ColModel; Info.CacheColourModel = COLOURMODEL_NOTCACHED; Info.IsSeparable = TRUE; Info.ForceRounding = FALSE; Info.NoColour = FALSE; }

BOOL DocColour::IsForcedToRound (  void   )  [inline]

Definition at line 247 of file doccolor.h. { return(Info.ForceRounding); };

BOOL DocColour::IsNamed (  void   )

to identidy if this colour is named, or was created from a named colour. Note that not all colours that were created by Named colours will have the relevant flag set, as I have only just started using it (4/2000). This fn. was really designed to be used specifically by the brush attribute replace named colours system. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 12/4/2000 Parameters: -  [INPUTS] Returns: TRUE, if this colour is named, or if it has the flag set that indicates that it was created by a named colour See also: Definition at line 658 of file doccolor.cpp. { BOOL RetVal = FALSE; // first try the parent colour IndexedColour* pParent = FindParentIndexedColour(); if (pParent != NULL) { if (pParent->IsNamed()) RetVal = TRUE; } // now try the flags if (Info.Reserved == COL_NAMED) RetVal = TRUE; return RetVal; }

BOOL DocColour::IsSeparable (  void   )  const [inline]

Determines if a colour's "IsSeparable" flag is set. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/5/96 Returns: TRUE if the colour is allowed to be colour separated and/or corrected during colour conversions. See also: DocColour::SetSeparable Definition at line 390 of file doccolor.h. { return(Info.IsSeparable); }

BOOL DocColour::IsTransparent (  void   )  const [inline]

Determines if a colour's "no colour" flag is set. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the colour is "no colour" ("transparent"). See also: - Definition at line 370 of file doccolor.h. { return(Info.NoColour); }

void DocColour::MakeRefToIndexedColour (  IndexedColour *  Other  )

Definition at line 1481 of file doccolor.cpp. { ENSURE(Other != NULL, "NULL IndexedColour pointer passed to DocColour::MakeRefToIndexedColour!"); if (Info.SourceColourModel == COLOURMODEL_INDEXED) { ENSURE(SourceColour.Indexed.Colour != NULL, "Corrupted DocColour (NULL IndexedColour ref) detected"); SourceColour.Indexed.Colour->DecrementUsage(); } Info.NoColour = FALSE; Info.SourceColourModel = COLOURMODEL_INDEXED; Info.CacheColourModel = COLOURMODEL_NOTCACHED; // NEVER cache indexed colours Info.OCContextHandle = 0; Info.IsSeparable = TRUE; // IxCols are always separable SourceColour.Indexed.Colour = Other; Other->IncrementUsage(); }

void DocColour::MakeRefToIndexedColourDBG (  IndexedColour *  Other, LPCSTR  TheFile = NULL, INT32  TheLine = 0 )

DocColour assignment - Makes this DocColour a reference to the given Indexed Colour. The Indexed Colour cannot be deleted until this DocColour releases this claim upon it (which occurs when it is deleted or re-assigned). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 03/05/94 Parameters: Other  - Indexed colour to assign [INPUTS] -  [OUTPUTS] Returns: Notes: This is not done as an "operator=" because it does NOT make an independent copy of the other colour, merely a reference to it; I force you to use this method in order to remind you of this. This makes the given DocColour a reference to an Indexed Colour, incrementing the usage count of that indexed colour. If this is already a reference to an indexed colour, that indexed colours usage count will be decremented. Returns: Errors: - See also: DocColour:FindParentIndexedColour Definition at line 1466 of file doccolor.cpp. { #ifdef TRACECOLOURIX TRACE( _T(">> DocColour @ %x ref ColourIx: %x @ %s line %ld\n"), (INT32)this, (INT32)Other, TheFile, TheLine); #endif // Disable the debugging macro so that the function code will compile #undef MakeRefToIndexedColour // --------- MakeRefToIndexedColour(Other); }

void DocColour::Mix (  DocColour *  BlendStart, DocColour *  BlendEnd, double  BlendFraction, ColourContext *  BlendContext, BOOL  BlendTheLongWay = FALSE, ColourContext *  OutputContext = NULL )

"Constructor" for a DocColour - generates a blended DocColour The start and end colours are blended to create this new DocColour. The amount by which they are mixed is determined by BlendFraction. The blend occurs in the colourspace described by BlendContext. Note that BlendContext may be NULL, in which case the default context for the BlendStart colour will be used. However, this is not recommended, as this will result in a blend which may be incorrect for the context(s) in use in a given document, which could give seriously wonky colours! Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 (moved from constructor, 29/5/96) Parameters: BlendStart  - The start DocColour [INPUTS] BlendEnd - The end DocColour BlendFraction - The amount by which the two colours should be blended, in the range 0.0 to 1.0. Blending is linear in the given colourspace, achieved by the equation Result = (BlendStart * (1.0-BlendFraction)) + (BlendEnd * BlendFraction) BlendContext - the colour context in which the blend will take place (may be NULL, but this is NOT recommended) (Note that this is ignored if either colour is a Spot) (Note that if both end colours are CMYK, and Mix effect is used, a CMYK context is used instead, so that CMYK grads colour separate properly) BlendTheLongWay - (ONLY used if the BlendContext points to an HSV context) This indicates whether to do 'rainbow' (shortest distance- FALSE) or 'alt-rainbow' (longest distance- TRUE) HSV colour blending. OutputContext - Normally, this should be NULL. However, if you're doing a colour separation involving spot colours, you should pass the output colour context in here, so that spots can be correctly separated. The output for mixing a spot colour will then be a greyscale ink intensity, correctly colour separated, and with its IsSeparable flag FALSE so that it is not colour separated or corrected a second time when output. It is safe to always pass the output context in here, as this function will always work out the appropriate behviour. If blending is requested in HSV space, the extra parameter BlendTheLongWay is required, to determine if blending is done in a "Rainbow" or "Alt-Rainbow" fashion. Notes: Note that although this may be slow, you must mix colours using this method, or colour correction/separation may not occur. The blend method specified by BlendContext & BlendTheLongWay is ignored if either of the colours is a spot colour - these are always coerced into simple "Mix" fills/blends, as otherwise the printed output and colour representation on screen will be totally different! If both end colours reference the same IndexedColour, and the mixing method is Mix (RGB) or Rainbow (HSV, BlendTheLongWay==FALSE), then all intermediate colours are identical, and are thus returned referencing the original indexed colour. If both the end colours are tints of the same spot colour, then two things can occur: If OutputContext != NULL, we presume the mix is temporary for rendering to that context, so produce an RGB mix or separated Ink density value for the context. If OutputContext == NULL, we presume you're doing a make shapes on a blend or similar, so we create a new local colour for each mix, which is a permanent proper tint of the parent spot ink. Definition at line 777 of file doccolor.cpp. { // if (BlendFraction >= 1.0) // BlendFraction = 0.999999999; // ERROR3IF(BlendFraction < 0.0 || BlendFraction > 1.0, // "DocColour::DocColour Blend: Illegal Blend fraction!"); ERROR3IF(BlendStart == NULL || BlendEnd == NULL, "DocColour::DocColour Blend: NULL input parameters!"); // Make sure that this colour is not a reference to an IndexedColour, otherwise // if/when we InitialiseInfoField() below, we'll forget the reference, and trigger // lots of bogus "IndexedColour deleted while in use" warnings if (Info.SourceColourModel == COLOURMODEL_INDEXED) { SourceColour.Indexed.Colour->DecrementUsage(); Info.SourceColourModel = COLOURMODEL_RGBT; } // If either the start of end colour is a spot/tint colour, then we will coerce // this mix into a simple RGB mix, not a Hue mix, by grabbing the default RGB context // We also special-case a Mix/Rainbow from an IndexedColour to itself, by simply making // the mixed step another reference to that colour (but not for alt-rainbow!) BOOL IncludesSpots = FALSE; // Remember if we've got to worry about spots IndexedColour *StartParent = BlendStart->FindParentIndexedColour(); IndexedColour *EndParent = BlendEnd->FindParentIndexedColour(); // --- Are blend start/end colours identical? - we might optimise them out if they are if (StartParent != NULL && StartParent == EndParent) { // If it's an RGB Mix or an HSV Rainbow (short way) then all mixes are identical to // the original colour, so just return that instead. if ( BlendContext != NULL && ( BlendContext->GetColourModel () == COLOURMODEL_RGBT || ( BlendContext->GetColourModel () == COLOURMODEL_HSVT && !BlendTheLongWay ) ) ) { // Make ourselves a reference to the parent colour MakeRefToIndexedColour ( StartParent ); return; } } // --- Determine if one or both of the colours are spot/tint colours // (When separating, we must treat blends including spot colours very specially) if (StartParent != NULL && StartParent->IsSpotOrTintOfSpot()) IncludesSpots = TRUE; else if (EndParent != NULL && EndParent->IsSpotOrTintOfSpot()) IncludesSpots = TRUE; if (IncludesSpots) {