ColourContext Class Reference

#include <colcontx.h>

Inheritance diagram for ColourContext:

List of all members.

Public Member Functions
	ColourContext (View *Scope)
	Constructor for a Colour context. This is shared code used by all derived ColourContextXXXX classes. You cannot create vanilla ColourContext objects (virtual functions abound).
virtual	~ColourContext ()
	Colour context destructor.
virtual BOOL	IsDifferent (ColourContext *Other) const
	Determine if two colour contexts are not exactly equivalent.
void	ConvertColour (DocColour *Source, ColourGeneric *Result)
	Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible.
void	ConvertColour (IndexedColour *Source, ColourGeneric *Result)
	Converts an indexed colour into this colour context. The converted colour will be supplied from a cache where possible.
void	ConvertColour (ColourContext *SourceContext, ColourGeneric *SourceColour, ColourGeneric *Result)
	Converts a colour in any arbitrary colour context into this colour context. The converted colour will be supplied from a cache where possible.
virtual void	ConvertToCIET (ColourGeneric *Source, DColourCIET *Result)=0
virtual void	ConvertFromCIET (DColourCIET *Source, ColourGeneric *Result)=0
virtual void	CreateExternalTransform ()
	Create an external transform to be used during colour conversions from RGB to the current RCS space. This function uses the Winoil CMS Manager to create the transform. Both forward and backward transforms use logical RGB descriptions.
ColourModel	GetColourModel (void) const
	Determines the colour model on which this colour context is based.
virtual void	GetModelName (StringBase *Result)=0
virtual BOOL	GetComponentName (INT32 ComponentID, StringBase *Result, BOOL LongName=FALSE)=0
virtual UINT32	GetComponentCount ()=0
virtual BOOL	SetComponentUnitGroup (UINT32 ComponentID, UnitGroup *pComponentUnitGroup)
virtual UnitGroup *	GetComponentUnitGroup (UINT32 ComponentID)
	Provides the UnitGroup of the given component in the ColourModel.
virtual void	ApplyTint (ColourValue TintFraction, ColourGeneric *SourceAndResult)=0
virtual void	ApplyShade (ColourValue XFraction, ColourValue YFraction, ColourGeneric *SourceAndResult)=0
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 for the DEST context 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.
void	SetColourPlate (ColourPlate *NewColourPlate)
	Sets a colour separation/plate for this context.
ColourPlate *	GetColourPlate (void)
	Reads the colour separation/plate for this context.
ColourPlate *	DetachColourPlate (void)
	Detaches the ColourPlate (if any) currently attached to this ColourContext. The context will no longer use the colour plate descriptor, and will return to default colour separation/correction actions.
void	ColourPlateHasChanged (void)
	Effectively flushes the caches of all colours currently cached in this ColourContext, so that on the next redraw they will re-convert.
virtual void	GetWhite (ColourGeneric *Result)=0
virtual BOOL	GetProfileTables (BYTE *Tables)
virtual BOOL	IsDeviceContext () const
void	ConvertColour (DocColour *Source, ColourPacked *Result)
	Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible Scope: PRIVATE - for use only by 'friend' rendering classes: OSRenderRegion, GRenderRegion.
Static Public Member Functions
static BOOL	InitColourContexts (void)
static void	DeinitColourContexts (void)
static ColourContext *	GetGlobalDefault (ColourModel ColModel)
	Find a default colour context for a given colour model number within GLOBAL scope. This is a static function, so may be called without having to create an actual ColourContext instance.
static void	GetGlobalDefaults (ColourContextArray *Destination)
	Find the default contexts used by this Scope: Pretty private. Should only need to be used by document.cpp.
static ColourContextRGBT *	GetCurrentForScreen (void)
	Code used by all renderers to find the current screen output context.
Protected Member Functions
virtual BOOL	Init (void)
	Colour context initialiser. This is called by the ColourContextList when it wishes to add a context to the list, and makes the context ready for use. This allows the list to compare contexts, and only initialise a given context when it knows the initialisation is absolutely necessary (e.g. allocating a large chunk of memory or calculating a complex table is avoided until we are sure there are no equivalent contexts already available) This function is overridden by colour contexts which actually need to do some initialisation other than just storing a few values away.
BOOL	DecrementUsage (void)
	Decrements usage-count for a colour context. This count allows us to determine when we can delete unused contexts.
void	IncrementUsage (void)
	Increments usage-count for a colour context. This count allows us to determine when we can delete unused contexts.
virtual void	PackColour (ColourGeneric *Source, ColourPacked *Result)
	Converts 128-bit colour representation to 32-bit packed form.
virtual void	UnpackColour (ColourPacked *Source, ColourGeneric *Result)
	Converts 32-bit packed colour representation to 128-bit form.
void	ConvertColourInternal (DocColour *Source, ColourGeneric *Result)
	Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible.
void	ConvertColourInternal (DocColour *Source, ColourPacked *Result)
	Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible (this check is made by the caller function ConvertColour) Scope: PRIVATE - for use only by 'friend' rendering classes: OSRenderRegion, GRenderRegion.
PColourValue	PackColour128 (ColourValue Source)
	Given a 32-bit (FIXED24) colour definition value, packs it into a 7-bit (unsigned byte) colour definition value. The value is rounded and clipped to lie within gamut (0.0 <= g <= 1.0).
void	UnpackColour128 (PColourValue Source, FIXED24 *Result)
	Unpacks the packed source colour value into a FIXED24 unpacked format.
PColourValue	PackColour256 (ColourValue Source)
	Given a 32-bit (FIXED24) colour definition value, packs it into an 8-bit (unsigned byte) colour definition value. The value is rounded and clipped to lie within gamut (0.0 <= g <= 1.0).
void	UnpackColour256 (PColourValue Source, FIXED24 *Result)
	Unpacks the packed source colour value into a FIXED24 unpacked format.
PColourValue	PackColour360 (ColourValue Source)
	Given a 32-bit (FIXED24) colour definition value, packs it into a 9-bit (0..359) colour definition value. The value is rounded and clipped to lie within gamut (0.0 <= g <= 1.0).
void	UnpackColour360 (PColourValue Source, FIXED24 *Result)
	Unpacks the packed source colour value into a FIXED24 unpacked format.
virtual UnitGroup **	GetComponentUnitGroups ()=0
virtual void	ConvertColourBase (ColourContext *SourceContext, ColourGeneric *Source, ColourGeneric *Result, IndexedColour *SourceIxCol=NULL)
	Converts a Colour into this colour context, from the default colour context implied by the given colour model Post-processing (as described by the attached ColourPlate object) will be applied to generate colour separations (etc) as required.
Static Protected Member Functions
static void	SetGlobalDefault (ColourModel ColModel, ColourContext *Default)
	Set the default colour context for a given colour model number Scope: private - used internally by ColourContextList::InitColourContexts.
Protected Attributes
ColourContextHandle	MyHandle
INT32	UsageCount
ColourModel	ColModel
ColourPlate *	ColPlate
HCMTRANSFORM	CMSTransform
View *	ScopeView
Static Protected Attributes
static ColourContextHandle	NextColourContextHandle = 1
Static Private Attributes
static ColourContextArray	GlobalDefaultContext
Friends
class	DocColour
class	ColourContextList
class	GRenderRegion
class	OSRenderRegion

---

Detailed Description

Definition at line 173 of file colcontx.h.

---

Constructor & Destructor Documentation

ColourContext::ColourContext (  View *  Scope  )

Constructor for a Colour context. This is shared code used by all derived ColourContextXXXX classes. You cannot create vanilla ColourContext objects (virtual functions abound). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: Scope  - The view within which this context is to be used, or NULL [INPUTS] for a global (non-view-specific) context -  [OUTPUTS] Returns: - Notes: The usage count for a colour context defaults to 0 ("not in use"). When using colour contexts, you should always register them with the global ColContextList object (see ColourContextList::AddContext for details) When created, relevant conversion parameters (gamma correction etc) are passed in to the constructor.The context stores these parameters so it can quickly compare itself to another context, but it may defer creation of tables and other essential stuff until the Init() function is called (when it is added to the list of available colour contexts). Nobody but the context list can call the Init() function. The passed-in Scope may be NULL, in which case global scope is used. However, if you're using this within the scope of any view, note that you must set up ScopeView properly or colour separated output of some colour models will be incorrect. Returns: Errors: - See also: ColourContextRGBT::ColourContextRGBT; ColourContextCMYK::ColourContextCMYK; ColourContextHSVT::ColourContextHSVT; ColourContextList::AddContext Definition at line 215 of file colcontx.cpp. { MyHandle = NextColourContextHandle++; ScopeView = Scope; UsageCount = 0; ColPlate = NULL; PORTNOTE("other","Removed HCMTRANSFORM usage") #ifndef EXCLUDE_FROM_XARALX CMSTransform = NULL; #endif // ColourModel and Model-specific data must be dealt with in the // constructor/Init() for the derived ColourContextXXXX class }

ColourContext::~ColourContext (   )  [virtual]

Colour context destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Notes: This destroys any attached ColourPlate descriptor See also: ColourContextList::AddContext Definition at line 250 of file colcontx.cpp. { ENSURE(UsageCount == 0, "ColourContext deleted while still in use!"); if (ColPlate != NULL) { delete ColPlate; ColPlate = NULL; } #ifndef NO_XARACMS if (CMSTransform != NULL) { if (GetApplication()->GetCMSManager() != NULL) GetApplication()->GetCMSManager()->DestroyTransform(CMSTransform); CMSTransform = NULL; } #endif }

---

Member Function Documentation

void ColourContext::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. 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 in ColourContextCMYK. Definition at line 851 of file colcontx.cpp. { // ERROR3IF(FilterDescription == NULL || DestContext == NULL || OutputColour == NULL, "Illegal NULL params"); // // if (FilterDescription == NULL) // return; // }

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

All colour conversions call this function for the DEST context 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 in ColourContextRGBT, and ColourContextCMYK. Definition at line 899 of file colcontx.cpp. { // ERROR3IF(FilterDescription == NULL || SourceContext == NULL || OutputColour == NULL, "Illegal NULL params"); // // if (FilterDescription == NULL) // return; }

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

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

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

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

void ColourContext::ColourPlateHasChanged (  void   )

Effectively flushes the caches of all colours currently cached in this ColourContext, so that on the next redraw they will re-convert. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 9/5/96 Notes: This is achieved by generating a new unique handle for this Context. Note that after 65536 handles, we will start re-using handles, and things will look bad if we inadvertently use the same handle for 2 contexts. This is an extremely unlikely occurrence, but please do not call this function unless it is absolutely necessary, to minimise the number of handle changes that occur. This function is automatically called whenever you change the ColourPlate attached to this context in any way. Scope: Intended as an internal routine; also called by ColourPlate class Should not be called by anyone else See also: ColourContext::SetColourPlate; IndexedColour; DocColour Definition at line 1050 of file colcontx.cpp. { // We need to change this context's "MyHandle" so that all cached colours for this // context are treated as non-cached again, and will be converted correctly for // the new output filter. MyHandle = NextColourContextHandle++; }

void ColourContext::ConvertColour (  DocColour *  Source, ColourPacked *  Result )  [inline]

Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible Scope: PRIVATE - for use only by 'friend' rendering classes: OSRenderRegion, GRenderRegion. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Source  - A Colour to convert [INPUTS] Result - A PColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 788 of file colcontx.h. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); ConvertColourInternal(Source, Result); }

void ColourContext::ConvertColour (  ColourContext *  SourceContext, ColourGeneric *  SourceColour, ColourGeneric *  Result )

Converts a colour in any arbitrary colour context into this colour context. The converted colour will be supplied from a cache where possible. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: SourceContext  - The colour context in which the Source Colour is defined [INPUTS] Source - A ColourGeneric structure defining a colour to convert, in the given SourceContext Result - A ColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 781 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); // This may look like an opportunity for optimisation, but // ConvertColourBase is actually an inline function ConvertColourBase(SourceContext, SourceColour, Result); }

void ColourContext::ConvertColour (  IndexedColour *  Source, ColourGeneric *  Result )

Converts an indexed colour into this colour context. The converted colour will be supplied from a cache where possible. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: Source  - An IndexedColour to convert [INPUTS] Result - A ColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 699 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); if (Source->Info.OCContextHandle != MyHandle) // Uncached so convert it into the cache { // Ask the colour to get its source colour for us. If this is a Linked/Tint colour, // this could well involve getting another colour's definition, converting it, and // generally giving us an extended tour of stack city. ColourGeneric SourceColour; Source->GetSourceColour(&SourceColour); // Check if we're doing a spot colour plate. We either get the colour's source colour, // or if it shouldn't appear on the plate, we get White. if (ColPlate != NULL && !ColPlate->IsDisabled()) { switch(ColPlate->GetType()) { case COLOURPLATE_SPOT: // If we're doing a spot plate and this isn't a descendant of the spot colour // then we must eliminate it from this plate. We must also check that it's a "true" // spot/tint, as opposed to a tint which is really a process colour. if ((!Source->IsADescendantOf(ColPlate->GetSpotColour())) || (!Source->IsSpotOrTintOfSpot())) { // Fill it with whatever White is defined as in the source context GetGlobalDefault(Source->GetColourModel())->GetWhite(&SourceColour); } break; case COLOURPLATE_CYAN: case COLOURPLATE_MAGENTA: case COLOURPLATE_YELLOW: case COLOURPLATE_KEY: // If we're doing a process plate, eliminate any spot colours (or tints) from it if (Source->IsSpotOrTintOfSpot()) { // Fill it with whatever White is defined as in the source context GetGlobalDefault(Source->GetColourModel())->GetWhite(&SourceColour); } break; default: break; } } ConvertColourBase(GetGlobalDefault(Source->GetColourModel()), &SourceColour, &Source->CachedColour, Source); Source->Info.OCContextHandle = MyHandle; Source->Info.CacheColourModel = ColModel; } // Copy the result from our cache memcpy(Result, &Source->CachedColour, sizeof(ColourGeneric)); }

void ColourContext::ConvertColour (  DocColour *  Source, ColourGeneric *  Result )  [inline]

Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 29/04/94 Parameters: Source  - A Colour to convert [INPUTS] Result - A ColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 760 of file colcontx.h. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); ConvertColourInternal(Source, Result); }

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

Converts a Colour into this colour context, from the default colour context implied by the given colour model Post-processing (as described by the attached ColourPlate object) will be applied to generate colour separations (etc) as required. 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 ColourContext. 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] The converted colour will be supplied from a cache where possible Notes: It is up to the caller to update caches etc if necessary This is used as a base on which ConvertColourInternal methods are built ColourContextCMYK overrides this base class method to provide direct passthrough of CMYK colours into a CMYK output context. (passthrough otherwise only occurs if the source & destination contexts are the same object) Scope: private to colcontx.cpp Returns: Errors: - See also: ColourContext::ConvertColour Reimplemented in ColourContextCMYK. Definition at line 490 of file colcontx.cpp. { #ifndef NO_XARACMS // Last minute bodge for Composite preview of CMYK colours in RGB space // This is done here cos it's much faster, and gets around pre/post filter problems // with CMYK colours which aren't IndexedColours (like intermediate blend/gradfill DocColours) if (ColPlate != NULL && ColPlate->GetType() == COLOURPLATE_COMPOSITE && GetColourModel() == COLOURMODEL_RGBT && SourceContext->GetColourModel() == COLOURMODEL_CMYK) { // If it's a CMYK colour, then it's already in printer gamut, so we only apply // the backward colour correction factor to it. // Note that this means we chuck away the normal colour conversion system! XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan != NULL) { ColourCMYK Def; memcpy(&Def, Source, sizeof(ColourGeneric)); lpCMSMan->ConvertColourForPaperView(&Def, (ColourRGBT *) Result); return; } } #endif // 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) { // 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 ColourContext::ConvertColourInternal (  DocColour *  Source, ColourPacked *  Result )  [protected]

Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible (this check is made by the caller function ConvertColour) Scope: PRIVATE - for use only by 'friend' rendering classes: OSRenderRegion, GRenderRegion. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/04/94 Parameters: Source  - A Colour to convert [INPUTS] Result - A PColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Errors: - See also: ColourContext::ConvertColour Definition at line 663 of file colcontx.cpp. { ColourGeneric NewResult; ConvertColourInternal(Source, &NewResult); // Convert PackColour(&NewResult, Result); // Pack the colour into Result... if (Source->Info.SourceColourModel != COLOURMODEL_INDEXED) { // And (if not an IndexedColour) update the cache Source->Info.OCContextHandle = MyHandle; Source->Info.CacheColourModel = ColModel; memcpy(&Source->CachedColour, Result, sizeof(ColourPacked)); } }

void ColourContext::ConvertColourInternal (  DocColour *  Source, ColourGeneric *  Result )  [protected]

Converts a Colour into this colour context. The converted colour will be supplied from a cache where possible. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: Source  - A Colour to convert [INPUTS] Result - A ColourGeneric structure to recieve the resulting converted colour, as defined in this ColourContext. -  [OUTPUTS] Returns: - Notes: This is used internally. It is only called by the inlined conversion functions if they fail to return a cached result Returns: Errors: - See also: ColourContext::ConvertColour Definition at line 581 of file colcontx.cpp. { if (Source->Info.SourceColourModel == COLOURMODEL_INDEXED) { IndexedColour *SrcIndexed = Source->SourceColour.Indexed.Colour; // Convert the indexed colour to our context ConvertColour(SrcIndexed, Result); // If IndexedColour, we do NOT want the colour cached at the DocColour // level (else if the IxCol changes, we'd have to search for all related // DocCols to fix their caches... erg!) return; } // Unpack the 32-bit colour into a 128-bit structure, and then invoke the // shared internal conversion routine. ColourGeneric SourceDefn; // If this DocColour should not be separated (it's a UI colour), then disable // any active colour plate to stop it separating the output - we'll save and restore // its previous state around the call to ConvertColourBase BOOL WasDisabled = TRUE; if (ColPlate != NULL) { WasDisabled = ColPlate->IsDisabled(); ColPlate->SetDisabled(!Source->IsSeparable()); } // Check if we're doing a spot colour plate. We either get the colour's source colour, // or if it shouldn't appear on the plate, we get White. if (ColPlate != NULL && !ColPlate->IsDisabled() && ColPlate->GetType() == COLOURPLATE_SPOT) { // We're doing a SPOT colour plate, but this colour is a local DocColour, so // it cannot possibly be a tint on this plate, so we just return white. GetGlobalDefault(Source->GetColourModel())->GetWhite(&SourceDefn); } else { // Unpack the colour GetGlobalDefault(Source->GetColourModel())->UnpackColour(&Source->SourceColour, &SourceDefn); } // Assume that the source context is a global default. Generally, this should be true, // as all source colours should be defined in terms of logical colour models. ConvertColourBase(GetGlobalDefault(Source->GetColourModel()), &SourceDefn, Result); // And restore the previous ColourPlate "disabled" state if (ColPlate != NULL) ColPlate->SetDisabled(WasDisabled); PackColour(Result, &Source->CachedColour); // And update the cache // Update cache flags - I am the context in which the cache is defined Source->Info.OCContextHandle = MyHandle; Source->Info.CacheColourModel = ColModel; }

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

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

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

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

void ColourContext::CreateExternalTransform (   )  [virtual]

Create an external transform to be used during colour conversions from RGB to the current RCS space. This function uses the Winoil CMS Manager to create the transform. Both forward and backward transforms use logical RGB descriptions. Author: Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 12/05/96 Parameters: -  [INPUTS] Returns: - Reimplemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT. Definition at line 809 of file colcontx.cpp. { // We do nothing here. If no one creates an external transform, the default // internal one will be used. To create an external transform, call the derived class // function, not this one as you can see it does nothing. }

BOOL ColourContext::DecrementUsage (  void   )  [protected]

Decrements usage-count for a colour context. This count allows us to determine when we can delete unused contexts. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if the object is still in use Notes: The usage count for a colour context defaults to 0 ("not in use"). When using colour contexts, you should always register them with the global ColContextList object (see ColourContextList::AddContext for details) Returns: Errors: ENSURE fails if the usage count goes negative, indicating the context is being 'released' more times than it is 'claimed'. See also: ColourContext::IncrementUsage; ColourContextList::AddContext Definition at line 329 of file colcontx.cpp. { ENSURE(UsageCount > 0, "ColourContext::DecrementUsage - Usage count is negative!"); return((--UsageCount) != 0); }

static void ColourContext::DeinitColourContexts (  void   )  [static]

ColourPlate * ColourContext::DetachColourPlate (  void   )

Detaches the ColourPlate (if any) currently attached to this ColourContext. The context will no longer use the colour plate descriptor, and will return to default colour separation/correction actions. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 11/6/96 Returns: The pointer to the previously attached ColourPlate (may be NULL) The caller is now responsible for deleting the returned object ** Notes: The Context's cache handle will be changed so that all cached colours in this output context are effectively 'flushed'. See also: ColourPlate; ColourContext::GetColourPlate; ColourContext::SetColourPlate Definition at line 981 of file colcontx.cpp. { ColourPlate *OldColourPlate = ColPlate; if (ColPlate != NULL) { ColPlate = NULL; // Change our context handle so that all cached colours in this context // are effectively "flushed" ColourPlateHasChanged(); } return(OldColourPlate); }

ColourModel ColourContext::GetColourModel (  void   )  const [inline]

Determines the colour model on which this colour context is based. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/03/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The colour model on which this colour context is based Errors: - See also: - Definition at line 367 of file colcontx.h. { return(ColModel); }

ColourPlate * ColourContext::GetColourPlate (  void   )

Reads the colour separation/plate for this context. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/01/96 Returns: NULL if Colour separation is disabled on this context, else a pointer to a ColourPlate descriptor object which describes the current colour separation/filtering options. See also: ColourPlate; ColourContext::ApplyOutputFilter; ColourContext::SetColourPlate Definition at line 1016 of file colcontx.cpp. { return(ColPlate); }

virtual UINT32 ColourContext::GetComponentCount (   )  [pure virtual]

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

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

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

UnitGroup * ColourContext::GetComponentUnitGroup (  UINT32  ComponentID  )  [virtual]

Provides the UnitGroup of the given component in the ColourModel. Author: Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> Date: 02/05/96 Parameters: ComponentID  - the number of the component (1..GetComponentCount()) [INPUTS] -  [OUTPUTS] Returns: A pointer to the desired UnitGroup Errors: ERROR2IF ComponentIndex < 1 or greater than number of components in model See Also: ColourContextCMYK::GetComponentUnitGroups() ColourContextGreyT::GetComponentUnitGroups() ColourContextHSVT::GetComponentUnitGroups() ColourContextRGBT::GetComponentUnitGroups() Definition at line 1111 of file colcontx.cpp. { ERROR2IF(ComponentID < 1 || ComponentID > GetComponentCount(), FALSE, "Invalid ID"); UnitGroup** pUnitGroupArray = GetComponentUnitGroups(); ERROR3IF(!(pUnitGroupArray[ComponentID - 1]->IS_KIND_OF(UnitGroup)), "ColourContext::GetComponentUnitGroup - Not UnitGroup array"); return pUnitGroupArray[ComponentID - 1]; }

virtual UnitGroup** ColourContext::GetComponentUnitGroups (   )  [protected, pure virtual]

Implemented in ColourContextRGBT, ColourContextCMYK, ColourContextHSVT, and ColourContextGreyT.

ColourContextRGBT * ColourContext::GetCurrentForScreen (  void   )  [inline, static]

Code used by all renderers to find the current screen output context. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 23/04/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the current screen output colour context for the given colour model. (This will either be the Selected Document's RGBT output context, or the global default output context, if Selected Document returns NULL) Notes: If you're colour separating, then you should use the context for your current render View - this function just gives a logical global default. Definition at line 393 of file colcontx.h. { Document *Scope = Document::GetSelected(); if (Scope == NULL) return((ColourContextRGBT *) GlobalDefaultContext.Context[COLOURMODEL_RGBT]); else return((ColourContextRGBT *) Scope->GetDefaultColourContexts()->Context[COLOURMODEL_RGBT]); }

ColourContext * ColourContext::GetGlobalDefault (  ColourModel  ColModel  )  [inline, static]

Find a default colour context for a given colour model number within GLOBAL scope. This is a static function, so may be called without having to create an actual ColourContext instance. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/04/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the default colour context for the given colour model, within the GLOBAL scope. Errors: - See also: ColourContext::GetDefault Definition at line 424 of file colcontx.h. { #ifdef DISABLE_WEBRGBT if (ColModel==COLOURMODEL_WEBRGBT) ColModel = COLOURMODEL_RGBT; #endif ENSURE(ColModel >= 0 && ColModel < MAX_COLOURMODELS, "ColourContext::GetGlobalDefault - Illegal colour model!"); ENSURE(GlobalDefaultContext.Context[ColModel