ColourContextCMYK Class Reference

Object class representing colour contexts based upon the CMYK colour model (Cyan, Magenta, Yellow, Key). More...

#include <colcontx.h>

Inheritance diagram for ColourContextCMYK:

List of all members.

Public Member Functions
	ColourContextCMYK (View *Scope)
	Constructor for a "logical" CMYK Colour context.
	ColourContextCMYK (View *Scope, StringBase *NewProfileName)
	Constructor for a CMYK Colour context.
void	ConvertToCIET (ColourGeneric *Source, DColourCIET *Result)
	Converts the given colour from our CMYK colourspace to CIET colourspace.
void	ConvertFromCIET (DColourCIET *Source, ColourGeneric *Result)
	Converts the given colour to our CMYK colourspace from CIET colourspace Notes: -.
void	CreateExternalTransform ()
	Create an external transform to be used during colour conversions from CMYK to the current RCS space. This function uses the Winoil CMS Manager to create the transform. Both forward and backward transforms use a physical printer profile description.
virtual void	GetModelName (StringBase *Result)
	Returns the name of this context's colour model Notes:.
virtual BOOL	GetComponentName (INT32 ComponentID, StringBase *Result, BOOL LongName=FALSE)
	Returns the name of one of this context's colour components.
virtual UINT32	GetComponentCount ()
	Provides number of components in the colour context's colour model.
virtual void	ApplyTint (ColourValue TintFraction, ColourGeneric *SourceAndResult)
	Tints a colour (mixes it with white).
virtual void	ApplyShade (ColourValue XFraction, ColourValue YFraction, ColourGeneric *SourceAndResult)
	Shades a colour (tweaks the saturation and value in a relative way).
virtual void	ApplyInputFilter (ColourPlate *FilterDescription, ColourContext *DestContext, ColourGeneric *OutputColour, IndexedColour *SourceIxCol)
	All colour conversions call this function for the SOURCE context immediately before converting the colour. This gives the input colour context the chance to apply a filtering process to the colour.
virtual void	ApplyOutputFilter (ColourPlate *FilterDescription, ColourContext *SourceContext, ColourGeneric *OutputColour, IndexedColour *SourceIxCol)
	All colour conversions call this function immediately prior to returning the converted colour to the caller. This gives the output colour context the chance to apply an output filtering process to the output colour.
virtual BOOL	IsDifferent (ColourContext *Other) const
	Determine if two colour contexts are not exactly equivalent.
virtual void	GetWhite (ColourGeneric *Result)
	An easy way to get a colour definition in this colour model which is white (paper colour).
virtual BOOL	GetProfileTables (BYTE *Tables)
	Uses the CMSManager to extract the profile data from our current CMSTransform.
String_256 *	GetProfileName (void)
Protected Member Functions
virtual UnitGroup **	GetComponentUnitGroups ()
	Provides an array of UnitGroups primarily for use by the base class (ColourContext) members Set/GetComponentUnitGroup().
virtual void	ConvertColourBase (ColourContext *SourceContext, ColourGeneric *Source, ColourGeneric *Result, IndexedColour *SourceIxCol=NULL)
	SEE ColourContext::ConvertColourbase This method is identical to that function, except that it also passes the colour directly through (rather than converting to/from CIET) if the source and destination contexts are both CMYK (even if they are different contexts, CMYK colours are always passed through without colour correction).
Protected Attributes
String_256	ProfileName
Private Types
enum	{ MAX_COMPONENTS = 4 }
Static Private Attributes
static UnitGroup *	m_pUnitGroupArray [MAX_COMPONENTS]
Friends
class	DocColour
class	ColourContextList
class	GRenderRegion
class	OSRenderRegion

---

Detailed Description

Object class representing colour contexts based upon the CMYK colour model (Cyan, Magenta, Yellow, Key).

Author:

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

Date:

14/04/94

See also:

Colour; ColourModel; ColourContext; ColourContextCMYK::ColourContextCMYK Documentation: HowToUse.doc

Definition at line 1078 of file colcontx.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator: MAX_COMPONENTS  Definition at line 1126 of file colcontx.h. { MAX_COMPONENTS = 4 // Number of components in colour context };

---

Constructor & Destructor Documentation

ColourContextCMYK::ColourContextCMYK (  View *  Scope  )

Constructor for a "logical" CMYK Colour context. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Scope  - The view in which this context is to be used, or NULL [INPUTS] -  [OUTPUTS] Returns: - A logical context represents an "ideal" CMYK printer. This is used internally when converting colours between logical colour models, and only used externally when no printer device profile is available. Notes: Colour Contexts should not be created and used directly. See the notes in the SeeAlso's for instructions on proper care and use. Returns: Errors: - See also: ColourContext::ColourContext; ColourContextList::AddContext Definition at line 1973 of file colcontx.cpp. : ColourContext(Scope) { ColModel = COLOURMODEL_CMYK; CreateExternalTransform(); }

ColourContextCMYK::ColourContextCMYK (  View *  Scope, StringBase *  NewProfileName )

Constructor for a CMYK Colour context. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/96 Parameters: Scope  - The view in which this context is to be used, or NULL [INPUTS] ProfileName - A string indicating the XaraCMS device profile which describes the printer device this context represents -  [OUTPUTS] Returns: - Notes: Colour Contexts should not be created and used directly. See the notes in the SeeAlso's for instructions on proper care and use. XaraCMS::GetPrinterProfile() can be used to find the default printer profile name. Returns: Errors: - See also: ColourContext::ColourContext; ColourContextList::AddContext Definition at line 2006 of file colcontx.cpp. : ColourContext(Scope) { ColModel = COLOURMODEL_CMYK; if (NewProfileName == NULL) { ERROR3("Illegal NULL param"); ProfileName.Empty(); } else ProfileName = *NewProfileName; CreateExternalTransform(); }

---

Member Function Documentation

void ColourContextCMYK::ApplyInputFilter (  ColourPlate *  FilterDescription, ColourContext *  DestContext, ColourGeneric *  OutputColour, IndexedColour *  SourceIxCol )  [virtual]

All colour conversions call this function for the SOURCE context immediately before converting the colour. This gives the input colour context the chance to apply a filtering process to the colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/1/96 Parameters: FilterDescription  - A ColourPlate describing how the colour is to be filtered [INPUTS] DestContext - Points to the context to which the OutputColour will be converted after we return it (in case this information is useful) OutputColour - The colour to be filtered SourceIxCol - NULL, or the original IndexedColour which is being converted. This is used for handling spot colour separation correctly. Parameters: OutputColour  - Will be modified as appropriate to the current colour [OUTPUTS] filtering options (see Purpose) This is usually used to provide colour separations. Often, this function will do nothing to the output colour - generally it is only used by CMYK contexts in order to colour-separate the colour in CMYK space. See also: ColourContext::ConvertColourBase Reimplemented from ColourContext. Definition at line 2547 of file colcontx.cpp. { ERROR3IF(FilterDescription == NULL || DestContext == NULL || OutputColour == NULL, "Illegal NULL params"); if (FilterDescription == NULL) return; ColourCMYK *OutputCMYK = (ColourCMYK *)OutputColour; FIXED24 temp; // Separate the colour as appropriate switch(FilterDescription->GetType()) { case COLOURPLATE_CYAN: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Cyan = 1.0 - OutputCMYK->Cyan; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { OutputCMYK->Key = OutputCMYK->Cyan; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } break; case COLOURPLATE_MAGENTA: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Magenta = 1.0 - OutputCMYK->Magenta; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { OutputCMYK->Key = OutputCMYK->Magenta; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Cyan = OutputCMYK->Yellow = 0.0; } break; case COLOURPLATE_YELLOW: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Yellow = 1.0 - OutputCMYK->Yellow; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { OutputCMYK->Key = OutputCMYK->Yellow; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Magenta = OutputCMYK->Cyan = 0.0; } break; case COLOURPLATE_KEY: { OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; // The FilterDescription->IsMonochrome() flag has no effect on this plate! if (FilterDescription->IsNegative()) OutputCMYK->Key = 1.0 - OutputCMYK->Key; } break; case COLOURPLATE_SPOT: // NOTE: // Real spot colours are generally sorted out by the higher level ConvertColour // calls. However, 2 cases may seep through to this level: // 1) Colours which are not indexed colours (which can't be spots, so are always // just converted to white) // 2) Spot colours which *do* appear on this plate must be made into monochrome // ink density values (which we put into the Key component). // In all cases, we're going monochrome in the Key only, so clear C/M/Y now. OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0; if (SourceIxCol == NULL) { // It's not an IndexedColour, so can't appear on this plate - make it white OutputCMYK->Key = 0; } else { // We have a source IndexedColour, so we know it's been separated. // We just have to get a decent ink density value out of the IxCol if (SourceIxCol == FilterDescription->GetSpotColour()) { // The spot colour itself is always considered a 100% tint (100% ink) OutputCMYK->Key = 1.0; } else if (SourceIxCol->IsADescendantOf(FilterDescription->GetSpotColour())) { // It's not the spot colour, but it is a child - check that it's a tint ERROR3IF(SourceIxCol->GetType() != COLOURTYPE_TINT || SourceIxCol->TintIsShade(), "Spot colour children must all be tints!"); // Tint gives the amount of ink, which we stick into the Key plate. // Note that we get the accumulated tint value rather than the simple // tint, which is the true output ink density. OutputCMYK->Key = SourceIxCol->GetAccumulatedTintValue(); } } // If negative, then photographically invert the colour if (FilterDescription->IsNegative()) { OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 1.0; OutputCMYK->Key = 1.0 - OutputCMYK->Key; } break; // case COLOURPLATE_COMPOSITE: // -- We don't need to do anything here // break; default: // If monochrome, convert the image to a greyscale if (FilterDescription->IsMonochrome()) { // It is extremely unlikely that anyone will ever need to do this. // (If you want a monochrome preview, you should really use a greyscale ColourContext) ERROR3("Unimplemented: Filtering of composite CMYK colour to monochrome!"); } // If negative, then photographically invert the colour if (FilterDescription->IsNegative()) { OutputCMYK->Cyan = 1.0 - OutputCMYK->Cyan; OutputCMYK->Magenta = 1.0 - OutputCMYK->Magenta; OutputCMYK->Yellow = 1.0 - OutputCMYK->Yellow; OutputCMYK->Key = 1.0 - OutputCMYK->Key; } break; } }

void ColourContextCMYK::ApplyOutputFilter (  ColourPlate *  FilterDescription, ColourContext *  SourceContext, ColourGeneric *  OutputColour, IndexedColour *  SourceIxCol )  [virtual]

All colour conversions call this function immediately prior to returning the converted colour to the caller. This gives the output colour context the chance to apply an output filtering process to the output colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/1/96 Parameters: FilterDescription  - A ColourPlate describing how the colour is to be filtered [INPUTS] SourceContext - Points to the context from which the OutputColour has just been converted. OutputColour - The colour to be filtered SourceIxCol - NULL, or the IndexedColour which was the source of the colour being converted. This is only used for information when preparing spot colour separations. Parameters: OutputColour  - Will be modified as appropriate to the current colour [OUTPUTS] filtering options (see Purpose) This is usually used to provide colour separations, and may also be used to apply some colour corrections. Often, this function will do nothing to the output colour. See also: ColourContext::ConvertColourBase Reimplemented from ColourContext. Definition at line 2726 of file colcontx.cpp. { ERROR3IF(FilterDescription == NULL || SourceContext == NULL || OutputColour == NULL, "Illegal NULL params"); // No FilterDescription means no filtering; If the source colour was CMYK, we msutn't filter it // as the ApplyInputFilter will have dealt with it if (FilterDescription == NULL || SourceContext->GetColourModel() == COLOURMODEL_CMYK) return; ColourCMYK *OutputCMYK = (ColourCMYK *)OutputColour; FIXED24 temp; // Separate the colour as appropriate switch(FilterDescription->GetType()) { case COLOURPLATE_CYAN: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Cyan = 1.0 - OutputCMYK->Cyan; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { // Move the Cyan value into the Key component OutputCMYK->Key = OutputCMYK->Cyan; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } break; case COLOURPLATE_MAGENTA: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Magenta = 1.0 - OutputCMYK->Magenta; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { // Move the Cyan value into the Key component OutputCMYK->Key = OutputCMYK->Magenta; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Cyan = OutputCMYK->Yellow = 0.0; } break; case COLOURPLATE_YELLOW: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Yellow = 1.0 - OutputCMYK->Yellow; if (FilterDescription->IsMonochrome()) // Make the plate a greyscale if necessary { // Move the Cyan value into the Key component OutputCMYK->Key = OutputCMYK->Yellow; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else OutputCMYK->Key = OutputCMYK->Cyan = OutputCMYK->Magenta = 0.0; } break; case COLOURPLATE_KEY: { if (FilterDescription->IsNegative()) // Negate the plate if necessary OutputCMYK->Key = 1.0 - OutputCMYK->Key; // The monochrome flag has no effect on a key plate! OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } break; case COLOURPLATE_SPOT: // NOTE: // Spot colours are partially handled by the IndexedColour variants of // ConvertColour, so will never reach us here if they have been // eliminated from the plate. // However, if a spot colour gets this far, we need to generate an ink // density value for output, as well as applying the negate flag. // // Actually, I have decreed that all spot plates will always be monochrome, // because that makes coding DocColour::Mix much easier, and anyway it makes // a load more sense for the very good reason that if you don't believe me // I'll get my Dad to come around and beat up your dad. if (SourceIxCol != NULL) // && FilterDescription->IsMonochrome()) { if (SourceIxCol == FilterDescription->GetSpotColour()) { // The spot colour itself is always considered a 100% tint (100% ink) OutputCMYK->Key = 1.0; OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } else if (SourceIxCol->IsADescendantOf(FilterDescription->GetSpotColour())) { // It's not the spot colour, but it is a child - check that it's a tint ERROR3IF(SourceIxCol->GetType() != COLOURTYPE_TINT || SourceIxCol->TintIsShade(), "Spot colour children must all be tints!"); // Tint gives the amount of ink. Note that we get the accumlated // tint value (true ink density) rather than the simple tint. OutputCMYK->Key = SourceIxCol->GetAccumulatedTintValue(); OutputCMYK->Cyan = OutputCMYK->Magenta = OutputCMYK->Yellow = 0.0; } } // If negative, then photographically invert the colour if (FilterDescription->IsNegative()) { OutputCMYK->Cyan = 1.0 - OutputCMYK->Cyan; OutputCMYK->Magenta = 1.0 - OutputCMYK->Magenta; OutputCMYK->Yellow = 1.0 - OutputCMYK->Yellow; OutputCMYK->Key = 1.0 - OutputCMYK->Key; } break; case COLOURPLATE_COMPOSITE: #ifndef NO_XARACMS { /* // Go to and from (printer) cmyk just for a laugh // Find the CMS manager, and get it to do all the work XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan != NULL) lpCMSMan->ConvertColourForPaperView(OutputRGB); */ ERROR3("Composite preview to a CMYK colour context is barmy!"); } #endif // ... drop through to the default case to apply monochrome/negate default: // If monochrome, convert the image to a greyscale if (FilterDescription->IsMonochrome()) { // Will anyone ever need this? It seems unlikely - but we may well get Key coming // through here, which is entirely sensible, so we only error if there is colour info. ERROR3IF(OutputCMYK->Cyan != 0 || OutputCMYK->Magenta != 0 || OutputCMYK->Yellow != 0, "Monochrome output of colour CMYK to CMYK colour context is unimplemented"); } // If negative, then photographically invert the colour if (FilterDescription->IsNegative()) { OutputCMYK->Cyan = 1.0 - OutputCMYK->Cyan; OutputCMYK->Magenta = 1.0 - OutputCMYK->Magenta; OutputCMYK->Yellow = 1.0 - OutputCMYK->Yellow; OutputCMYK->Key = 1.0 - OutputCMYK->Key; } break; } }

void ColourContextCMYK::ApplyShade (  ColourValue  XFraction, ColourValue  YFraction, ColourGeneric *  SourceAndResult )  [virtual]

Shades a colour (tweaks the saturation and value in a relative way). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/95 Parameters: XFraction  - The fraction (as a FIXED24 ColourValue) by which the colour [INPUTS] should be saturated. This value is expected to lie between -1.0 and 1.0 inclusive Values below 0.0 mean tint towards 0, while values above mean tint towards 1. 0.0 means no tinting YFraction - The fraction (as a FIXED24 ColourValue) by which the colour should be shaded. This value is expected to lie between -1.0 and 1.0 inclusive Values below 0.0 mean shade towards 0, while values above mean shade towards 1. 0.0 means no shading SourceAndResult - The source colour to be tinted, as defined in this colour model Parameters: SourceAndResult  is shaded by the given Fractions [OUTPUTS] Any invalid value is clipped to 0.0 Returns: - Notes: Contexts other than HSV currently convert the colour to and from HSV form in order to apply the shade. This is a tad inefficient, but a quick'n'easy bodge that will get it going nice and quickly. Implements ColourContext. Definition at line 2499 of file colcontx.cpp. { ColourHSVT HSVDef; ColourContext *cc = ColourContext::GetGlobalDefault(COLOURMODEL_HSVT); ERROR3IF(cc == NULL, "No default HSV colour context?!"); cc->ConvertColour(this, SourceAndResult, (ColourGeneric *) &HSVDef); cc->ApplyShade(XFraction, YFraction, (ColourGeneric *) &HSVDef); ConvertColour(cc, (ColourGeneric *) &HSVDef, SourceAndResult); }

void ColourContextCMYK::ApplyTint (  ColourValue  TintFraction, ColourGeneric *  SourceAndResult )  [virtual]

Tints a colour (mixes it with white). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 17/11/94 Parameters: TintFraction  - The fraction (as a FIXED24 ColourValue) by which the colour [INPUTS] should be tinted. This value is expected to lie between 0.0 and 1.0 inclusive SourceAndResult - The source colour to be tinted, as defined in this colour model Parameters: SourceAndResult  is tinted by the given TintFraction [OUTPUTS] If TintFraction <= 0.0, White is output If TintFraction >= 1.0, The source colour is output Returns: - Notes: If the tinting value is out of range, either source-colour ow white (as appropriate) will be output. Implements ColourContext. Definition at line 2445 of file colcontx.cpp. { ColourCMYK *Result = (ColourCMYK *) SourceAndResult; if (TintFraction <= FIXED24(0.0)) // 0% tint = White { Result->Cyan = Result->Magenta = Result->Yellow = Result->Key = 0; return; } if (TintFraction >= FIXED24(1.0)) // The Result colour is identical to the source return; // Otherwise, tint the colour... Result->Cyan = (Result->Cyan * TintFraction); Result->Magenta = (Result->Magenta * TintFraction); Result->Yellow = (Result->Yellow * TintFraction); Result->Key = (Result->Key * TintFraction); }

void ColourContextCMYK::ConvertColourBase (  ColourContext *  SourceContext, ColourGeneric *  Source, ColourGeneric *  Result, IndexedColour *  SourceIxCol = NULL )  [protected, virtual]

SEE ColourContext::ConvertColourbase This method is identical to that function, except that it also passes the colour directly through (rather than converting to/from CIET) if the source and destination contexts are both CMYK (even if they are different contexts, CMYK colours are always passed through without colour correction). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: SourceContext  - The context in which the source is defined [INPUTS] Source - A ColourGeneric to convert Result - A ColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContextCMYK. SourceIxCol - NULL, or a pointer to the IndexedColour we are converting. This is used only for handling spot colour separations, to determine if the colour is a given spot colour or tint thereof. Parameters: Result  - will be returned with the converted colour [OUTPUTS] Scope: private to colcontx.cpp Returns: Errors: - See also: ColourContextCMYK::ConvertColour Reimplemented from ColourContext. Definition at line 2967 of file colcontx.cpp. { // Copy the source colour into a temporary variable ColourGeneric FilteredSource; memcpy(&FilteredSource, Source, sizeof(ColourGeneric)); // Call the SourceContext to allow it to pre-filter the colour. This is used to // provide colour separations and other doody features when converting CMYK colours // - when converting non-CMYK colours, this is usually done in the OutputFilter (below) if (ColPlate != NULL && !ColPlate->IsDisabled()) SourceContext->ApplyInputFilter(ColPlate, this, &FilteredSource, SourceIxCol); // ----- // Call levels expected: // 1 inline ConvertColour checks if can satisfy from cache // 2 function ConvertColourInternal does any short cuts it can, such // as CMYK->CMYK passthrough // 3 Call ConvertColourBase, which // a) Checks if in same colour model, and implements passthrough, or // b) Converts colour properly via CIET space if (SourceContext == this || SourceContext->GetColourModel() == COLOURMODEL_CMYK) { // The SourceContext and Destination context are identical, so we can // just copy the definition directly across. memcpy(Result, &FilteredSource, sizeof(ColourGeneric)); } else { DColourCIET IntermediateResult; SourceContext->ConvertToCIET(&FilteredSource, &IntermediateResult); ConvertFromCIET(&IntermediateResult, Result); } // Call the DestinationContext (derived class of this) to apply any output filtering - // non-CMYK colour conversions will separate the colour (as appropriate) here if (ColPlate != NULL && !ColPlate->IsDisabled()) ApplyOutputFilter(ColPlate, SourceContext, Result, SourceIxCol); }

void ColourContextCMYK::ConvertFromCIET (  DColourCIET *  Source, ColourGeneric *  Result )  [virtual]

Converts the given colour to our CMYK colourspace from CIET colourspace Notes: -. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Source  - A Colour defined in the CIET colourspace [INPUTS] Result - pointer to a structure to recieve the resulting colour as defined in the CMYK space described by this colour context. -  [OUTPUTS] Returns: - Errors: - See also: ColourContextCMYK::ConvertToCIET Implements ColourContext. Definition at line 2143 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); ColourCMYK *cmyk = (ColourCMYK *) Result; #ifndef NO_XARACMS // If we've got a CMS manager, use it, else use the version 1.1 bodge XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan != NULL) { // The new colour calibration method CMSColour icol, ocol; icol.c0 = Source->X; icol.c1 = Source->Y; icol.c2 = Source->Z; // If we have no colour transform, or if we don't want the colour corrected/separated, // then we will just do a "logical" conversion. if (CMSTransform == NULL || (ColPlate != NULL && ColPlate->IsDisabled())) lpCMSMan->ConvCIEXYZtoCMYK(icol, ocol); else lpCMSMan->GTransform(CMSTransform, cmsReverse, icol, ocol); cmyk->Cyan = FIXED24(ocol.c0); cmyk->Magenta= FIXED24(ocol.c1); cmyk->Yellow = FIXED24(ocol.c2); cmyk->Key = FIXED24(ocol.c3); /* #ifdef _DEBUG { // Check that the colour will round-trip from CIE to CMYK and back to CIE correctly DColourCIET temp; ConvertToCIET(Result, &temp); INT32 t1 = (INT32)(Source->X*1000.0); INT32 t2 = (INT32)(Source->Y*1000.0); INT32 t3 = (INT32)(Source->Z*1000.0); INT32 t4 = (INT32)INT32(temp.X*1000.0); INT32 t5 = (INT32)INT32(temp.Y*1000.0); INT32 t6 = (INT32)INT32(temp.Z*1000.0); CMSColour orgb, orgb2; lpCMSMan->ConvCIEXYZtoRGB(icol, orgb); if (t1==t4 && t2==t5 && t3==t6) { TRACE( _T("CIE-CMYK-CIE roundtrip OK : RGB(%.3f,%.3f,%.3f) (%.3f,%.3f,%.3f,%.3f)\n"), orgb.c0, orgb.c1, orgb.c2, ocol.c0, ocol.c1, ocol.c2, ocol.c3); } else { TRACE( _T("CIE-CMYK-CIE roundtrip error: RGB(%.3f,%.3f,%.3f) (%.3f,%.3f,%.3f,%.3f)\n"), orgb.c0, orgb.c1, orgb.c2, ocol.c0, ocol.c1, ocol.c2, ocol.c3); TRACE( _T(" CIEIn[%d,%d,%d] CIEOut[%d,%d,%d]\n"), t1, t2, t3, t4, t5, t6); } // ERROR3IF((INT32)(temp.X*1000.0)!=(INT32)(Source->X*1000.0) || // (INT32)(temp.Y*1000.0)!=(INT32)(Source->Y*1000.0) || // (INT32)(temp.Z*1000.0)!=(INT32)(Source->Z*1000.0), // "CMYK does not round-trip!"); } #endif */ } else #endif { // The old rgb method ColourRGBT rgb; rgb.Red = FIXED24(Source->X); rgb.Green = FIXED24(Source->Y); rgb.Blue = FIXED24(Source->Z); // If all components are 0 then we know it's BLACK. if (rgb.Red <= 0 && rgb.Green <= 0 && rgb.Blue <= 0) { cmyk->Cyan = cmyk->Magenta = cmyk->Yellow = 0; cmyk->Key = 1.0; } else { // Invert the Colour Vector cmyk->Cyan = 1.0 - rgb.Red; cmyk->Magenta = 1.0 - rgb.Green; cmyk->Yellow = 1.0 - rgb.Blue; double smallest; smallest = min(cmyk->Cyan.MakeDouble(), cmyk->Magenta.MakeDouble()); smallest = min(smallest, cmyk->Yellow.MakeDouble()); smallest = max(smallest-0.5, 0.0); // Key starts being generated beyond threshold cmyk->Key = smallest; // Subtract KEY component. cmyk->Cyan -= cmyk->Key; cmyk->Magenta -= cmyk->Key; cmyk->Yellow -= cmyk->Key; } } }

void ColourContextCMYK::ConvertToCIET (  ColourGeneric *  Source, DColourCIET *  Result )  [virtual]

Converts the given colour from our CMYK colourspace to CIET colourspace. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: Source  - A Colour defined in this CMYK context [INPUTS] Result - pointer to a structure to recieve the resulting colour as defined in CIE space -  [OUTPUTS] Returns: - Notes: - Returns: Errors: - See also: ColourContextCMYK::ConvertFromCIET Implements ColourContext. Definition at line 2080 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); ColourCMYK *bob = (ColourCMYK *) Source; #ifndef NO_XARACMS // If we've got a CMS manager, use it, else use the version 1.1 bodge XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan != NULL) { // The new colour calibration method CMSColour icol, ocol; icol.c0 = bob->Cyan.MakeDouble(); icol.c1 = bob->Magenta.MakeDouble(); icol.c2 = bob->Yellow.MakeDouble(); icol.c3 = bob->Key.MakeDouble(); // If we have no colour transform, or if we don't want the colour corrected/separated, // then we will just do a "logical" conversion. if (CMSTransform == NULL || (ColPlate != NULL && ColPlate->IsDisabled())) lpCMSMan->ConvCMYKtoCIEXYZ(icol, ocol); else lpCMSMan->GTransform(CMSTransform, cmsForward, icol, ocol); Result->X = ocol.c0; Result->Y = ocol.c1; Result->Z = ocol.c2; } else #endif { // The old rgb method Result->X = ( 1.0 - ( min( 1.0, ( bob->Cyan + bob->Key ).MakeDouble() ) ) ); // R Result->Y = ( 1.0 - ( min( 1.0, ( bob->Magenta + bob->Key ).MakeDouble() ) ) ); // G Result->Z = ( 1.0 - ( min( 1.0, ( bob->Yellow + bob->Key ).MakeDouble() ) ) ); // B } Result->Transparent = 0.0; // CMYK values are not transparent }

void ColourContextCMYK::CreateExternalTransform (   )  [virtual]

Create an external transform to be used during colour conversions from CMYK to the current RCS space. This function uses the Winoil CMS Manager to create the transform. Both forward and backward transforms use a physical printer profile description. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 12/05/96 Parameters: -  [INPUTS] Returns: - Reimplemented from ColourContext. Definition at line 2039 of file colcontx.cpp. { #ifndef NO_XARACMS XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); // If we have a CMS and we are not a logical context, set up a transform if (lpCMSMan != NULL && !ProfileName.IsEmpty()) { TCHAR* pProfile = (TCHAR*)ProfileName; // set this as the active colour profile UINT32 err = lpCMSMan->SetProfile(ptPrinter, pProfile); // if we haven't got an error, create that transform if (err==0) CMSTransform = lpCMSMan->CreateTransform(PRINT_RCS); } #endif }

UINT32 ColourContextCMYK::GetComponentCount (   )  [virtual]

Provides number of components in the colour context's colour model. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Returns: The number of components Implements ColourContext. Definition at line 2413 of file colcontx.cpp. { return MAX_COMPONENTS; }

BOOL ColourContextCMYK::GetComponentName (  INT32  ComponentID, StringBase *  Result, BOOL  LongName = FALSE )  [virtual]

Returns the name of one of this context's colour components. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/7/94 Parameters: ComponentID  - Index [1..4] of the component you want the name of [INPUTS] (Result is an output) LongName - TRUE to get the long name, FALSE to get the short name (e.g. "Magenta" vs "M", "Saturation" vs "Sat") Result  returns containing a String of the name of the given component [OUTPUTS] of colours defined in this context. This string is guaranteed to fit within a String_32 - this is the minimum size you should allocate. (Most names, in English at least, are shorter than this (10 chars max, e.g. 'Red' 'Hue' 'Saturation') so allow at least 10 chars of space in your displays as well) Note that Result can be passed in NULL in order to only determine if the context supports a given component. Returns: FALSE if this component is not used by this model. Notes: The components are given in the same order as they appear in the high-precision ColourXYZ structures defined in colmodel.h Implements ColourContext. Definition at line 2338 of file colcontx.cpp. { UINT32 StringID = 0; BOOL Used = TRUE; switch(ComponentID) { case 1: StringID = (LongName) ? _R(IDS_COLCOMPL_CYAN) : _R(IDS_COLCOMP_CYAN); break; case 2: StringID = (LongName) ? _R(IDS_COLCOMPL_MAGENTA) : _R(IDS_COLCOMP_MAGENTA); break; case 3: StringID = (LongName) ? _R(IDS_COLCOMPL_YELLOW) : _R(IDS_COLCOMP_YELLOW); break; default: StringID = (LongName) ? _R(IDS_COLCOMPL_KEY) : _R(IDS_COLCOMP_KEY); break; } if (Result != NULL && StringID != 0) *Result = String_32(StringID); return(Used); }

UnitGroup ** ColourContextCMYK::GetComponentUnitGroups (   )  [protected, virtual]

Provides an array of UnitGroups primarily for use by the base class (ColourContext) members Set/GetComponentUnitGroup(). Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the UnitGroup array Errors: - See Also: ColourContext::GetComponentUnitGroup() ColourContext::SetComponentUnitGroup() Implements ColourContext. Definition at line 2386 of file colcontx.cpp. { return m_pUnitGroupArray; }

void ColourContextCMYK::GetModelName (  StringBase *  Result  )  [virtual]

Returns the name of this context's colour model Notes:. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 1/6/94 Parameters: -  [INPUTS] Result  returns continaing a String of the name of the context. [OUTPUTS] This string is guaranteed to fit within a String_32 - this is the minimum size you should allocate. (Most names, in English at least, are shorter than this (10 chars max, e.g. 'RGB' 'HSV' 'Greyscale') so allow at least 10 chars of space in your displays as well) Returns: - Implements ColourContext. Definition at line 2299 of file colcontx.cpp. { ENSURE(Result != NULL, "ColourContext::GetModelName called with NULL result pointer!"); *Result = String_32(_R(IDS_COLMODEL_CMYK)); }

String_256* ColourContextCMYK::GetProfileName (  void   )  [inline]

Definition at line 1119 of file colcontx.h. { return(&ProfileName); };

BOOL ColourContextCMYK::GetProfileTables (  BYTE *  Tables  )  [virtual]

Uses the CMSManager to extract the profile data from our current CMSTransform. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Tables  = a byte pointer to a 5*256 byte buffer [INPUTS] TRUE  if the Tables buffer has been filled [OUTPUTS] FALSE otherwise. Reimplemented from ColourContext. Definition at line 2260 of file colcontx.cpp. { PORTNOTE("other","Removed HCMTRANSFORM usage") #ifndef EXCLUDE_FROM_XARALX if (CMSTransform==NULL) return FALSE; #endif #ifdef NO_XARACMS return FALSE; #else XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan==NULL) return FALSE; return lpCMSMan->GetProfileTables(CMSTransform, Tables); #endif }

void ColourContextCMYK::GetWhite (  ColourGeneric *  Result  )  [virtual]

An easy way to get a colour definition in this colour model which is white (paper colour). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 8/6/96 Parameters: Result  - Will be filled in with White, however that is defined in [OUTPUTS] this context's colour model. (i.e. RGB(1,1,1) or CMYK(0,0,0,0), etc) Implements ColourContext. Definition at line 2926 of file colcontx.cpp. { ColourCMYK *cmyk = (ColourCMYK *) Result; cmyk->Cyan = cmyk->Magenta = cmyk->Yellow = cmyk->Key = 0; }

BOOL ColourContextCMYK::IsDifferent (  ColourContext *  Other  )  const [virtual]

Determine if two colour contexts are not exactly equivalent. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/96 Parameters: Other  - a colour context to comapre ourselves to [INPUTS] -  [OUTPUTS] Returns: TRUE if the other colour context object is different from ourself, or TRUE if it is an exactly equivalent context. Errors: - See also: ColourContext::IsDifferent Reimplemented from ColourContext. Definition at line 2900 of file colcontx.cpp. { if (ColourContext::IsDifferent(Other)) // Different on generic ColourContext basis return(TRUE); // These must both be CMYK contexts, so check if they are equivalent return(ProfileName.IsIdentical(((ColourContextCMYK *)Other)->ProfileName)); }

---

Friends And Related Function Documentation

friend class ColourContextList [friend]

Reimplemented from ColourContext. Definition at line 1081 of file colcontx.h.

friend class DocColour [friend]

Reimplemented from ColourContext. Definition at line 1080 of file colcontx.h.

friend class GRenderRegion [friend]

Reimplemented from ColourContext. Definition at line 1083 of file colcontx.h.

friend class OSRenderRegion [friend]

Reimplemented from ColourContext. Definition at line 1084 of file colcontx.h.

---

Member Data Documentation

UnitGroup * ColourContextCMYK::m_pUnitGroupArray [static, private]

Initial value: { &(StandardUnit::PercentGroup), &(StandardUnit::PercentGroup), &(StandardUnit::PercentGroup), &(StandardUnit::PercentGroup) } Definition at line 1130 of file colcontx.h.

String_256 ColourContextCMYK::ProfileName [protected]

Definition at line 1138 of file colcontx.h.

---

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

• Kernel/colcontx.h (r1785/r1282)
• Kernel/colcontx.cpp (r1785/r1402)

---