ColourContextHSVT Class Reference

Object class representing colour contexts based upon the HSVT colour model (Red, Green, Blue, Transparent). More...

#include <colcontx.h>

Inheritance diagram for ColourContextHSVT:

List of all members.

Public Member Functions
	ColourContextHSVT (View *Scope)
	Constructor for an HSVT Colour context.
void	ConvertToCIET (ColourGeneric *Source, DColourCIET *Result)
	Converts the given colour from our HSVT colourspace to CIET colourspace Notes: -.
void	ConvertFromCIET (DColourCIET *Source, ColourGeneric *Result)
	Converts the given colour to our HSVT colourspace from CIET colourspace Notes: -.
void	CreateExternalTransform ()
	Create an external transform to be used during colour conversions from HSV 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	GetWhite (ColourGeneric *Result)
	An easy way to get a colour definition in this colour model which is white (paper colour).
Protected Member Functions
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.
virtual UnitGroup **	GetComponentUnitGroups ()
	Provides an array of UnitGroups primarily for use by the base class (ColourContext) members Set/GetComponentUnitGroup().
Private Types
enum	{ MAX_COMPONENTS = 3 }
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 HSVT colour model (Red, Green, Blue, Transparent).

Author:

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

Date:

02/04/94

See also:

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

Definition at line 1159 of file colcontx.h.

---

Member Enumeration Documentation

anonymous enum [private]

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

---

Constructor & Destructor Documentation

ColourContextHSVT::ColourContextHSVT (  View *  Scope  )

Constructor for an HSVT Colour context. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/04/94 Parameters: Scope  - The view in which this context is to be used, or NULL [INPUTS] -  [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. Returns: Errors: - See also: ColourContext::ColourContext; ColourContextList::AddContext Definition at line 3047 of file colcontx.cpp. : ColourContext(Scope) { ColModel = COLOURMODEL_HSVT; CreateExternalTransform(); }

---

Member Function Documentation

void ColourContextHSVT::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: - Implements ColourContext. Definition at line 3577 of file colcontx.cpp. { ColourHSVT *Result = (ColourHSVT *) SourceAndResult; ERROR3IF(XFraction < FIXED24(-1.0) || XFraction > FIXED24(1.0), "Illegal X Shading value"); ERROR3IF(YFraction < FIXED24(-1.0) || YFraction > FIXED24(1.0), "Illegal Y Shading value"); // Adjust the Saturation according to XFraction if (XFraction != FIXED24(0.0)) { if (XFraction < FIXED24(0.0)) { XFraction = -XFraction; Result->Saturation = Result->Saturation * (FIXED24(1.0) - XFraction); } else Result->Saturation = XFraction + Result->Saturation * (FIXED24(1.0) - XFraction); } // Adjust the Value according to YFraction if (YFraction != FIXED24(0.0)) { if (YFraction < FIXED24(0.0)) { YFraction = -YFraction; Result->Value = Result->Value * (FIXED24(1.0) - YFraction); } else Result->Value = YFraction + Result->Value * (FIXED24(1.0) - YFraction); } }

void ColourContextHSVT::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 3527 of file colcontx.cpp. { ColourHSVT *Result = (ColourHSVT *) SourceAndResult; if (TintFraction <= FIXED24(0.0)) // 0% tint = White { Result->Saturation = 0; Result->Value = FIXED24(1.0); return; } if (TintFraction >= FIXED24(1.0)) // The Result colour is identical to the source return; // Otherwise, tint the colour... // Hue remains constant Result->Saturation = Result->Saturation * TintFraction; Result->Value = FIXED24(1.0) - (TintFraction - (Result->Value * TintFraction)); }

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

Converts the given colour to our HSVT colourspace from CIET colourspace Notes: -. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/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 HSVT space described by this colour context. -  [OUTPUTS] Returns: - Errors: - See also: ColourContextHSVT::ConvertToCIET Implements ColourContext. Definition at line 3203 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); // First, we'll convert from CIE to RGB double R, G, B; #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->ConvCIEXYZtoRGB(icol, ocol); else lpCMSMan->GTransform(CMSTransform, cmsReverse, icol, ocol); R = ocol.c0; G = ocol.c1; B = ocol.c2; } else #endif { // The old rgb system R = Source->X; G = Source->Y; B = Source->Z; } // Now, convert the RGB value into HSV double Min, Max, Delta, H, S, V; Min = min(R, G); Min = min(Min, B); Max = max(R, G); Max = max(Max, B); V = Max; Delta = Max - Min; if (fabs(Delta) > 0.000001) { if (Max > 0.0) S = Delta / Max; else S = 0.0; if (R == Max) H = (G - B) / Delta; else if (G == Max) H = 2.0 + (B - R) / Delta; else H = 4 + (R - G) / Delta; H = H / 6.0; if (H < 0.0) H += 1.0; } else { H = S = 0.0; } ((ColourHSVT *)Result)->Hue = H; ((ColourHSVT *)Result)->Saturation = S; ((ColourHSVT *)Result)->Value = V; ((ColourHSVT *)Result)->Transparent = 0; //Source->Transparent; }

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

Converts the given colour from our HSVT colourspace to CIET colourspace Notes: -. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/04/94 Parameters: Source  - A Colour defined in this HSVT context [INPUTS] Result - pointer to a structure to recieve the resulting colour as defined in CIE space -  [OUTPUTS] Returns: - Errors: - See also: ColourContextHSVT::ConvertFromCIET Implements ColourContext. Definition at line 3109 of file colcontx.cpp. { ENSURE(UsageCount > 0, "Colour context being used when not initialised!"); // First, let's convert the HSV into RGB FIXED24 H,S,V, R,G,B, F, P,Q,T; // Sorry, I just have to override the style guide here! H = ((ColourHSVT *)Source)->Hue; S = ((ColourHSVT *)Source)->Saturation; V = ((ColourHSVT *)Source)->Value; if (S == FIXED24(0)) { R = V; G = V; B = V; } else { H *= 6; INT32 I = H.MakeInt(); F = H - I; P = V * (1.0 - S); Q = V * (1.0 - (S * F)); T = V * (1.0 - (S * (1.0 - F))); switch (I) { case 1: R = Q; G = V; B = P; break; case 2: R = P; G = V; B = T; break; case 3: R = P; G = Q; B = V; break; case 4: R = T; G = P; B = V; break; case 5: R = V; G = P; B = Q; break; default: R = V; G = T; B = P; break; } } #ifndef NO_XARACMS // Now, convert the RGB to CIE // 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 = R.MakeDouble(); icol.c1 = G.MakeDouble(); icol.c2 = B.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->ConvRGBtoCIEXYZ(icol, ocol); else lpCMSMan->GTransform(CMSTransform, cmsForward, icol, ocol); Result->X = ocol.c0; Result->Y = ocol.c1; Result->Z = ocol.c2; Result->Transparent = 0.0;//bob->Transparent; } else #endif { // The old rgb system Result->X = R.MakeDouble(); Result->Y = G.MakeDouble(); Result->Z = B.MakeDouble(); Result->Transparent = 0;//((ColourHSVT *)Source)->Transparent; } }

void ColourContextHSVT::CreateExternalTransform (   )  [virtual]

Create an external transform to be used during colour conversions from HSV 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 3070 of file colcontx.cpp. { #ifndef NO_XARACMS CMSColourSpace cmsSpace; XaraCMS* lpCMSMan = GetApplication()->GetCMSManager(); if (lpCMSMan != NULL) { // first read our internal colour calibration space lpCMSMan->GetLogicalProfile(&cmsSpace); // set this as the active colour profile UINT32 err = lpCMSMan->SetProfile(cmsSpace); // if we haven't got an error, create that transform if (err==0) CMSTransform = lpCMSMan->CreateTransform(DISPLAY_RCS); } #endif }

UINT32 ColourContextHSVT::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 3495 of file colcontx.cpp. { return MAX_COMPONENTS; }

BOOL ColourContextHSVT::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 3414 of file colcontx.cpp. { UINT32 StringID = 0; BOOL Used = TRUE; switch(ComponentID) { case 1: StringID = (LongName) ? _R(IDS_COLCOMPL_HUE) : _R(IDS_COLCOMP_HUE); break; case 2: StringID = (LongName) ? _R(IDS_COLCOMPL_SATURATION) : _R(IDS_COLCOMP_SATURATION); break; case 3: StringID = (LongName) ? _R(IDS_COLCOMPL_VALUE) : _R(IDS_COLCOMP_VALUE); break; #ifdef TRANSPARENTCOLOUR default: StringID = _R(IDS_COLCOMP_TRANS); break; #else default: Used = FALSE; break; #endif } if (Result != NULL && StringID != 0) *Result = String_32(StringID); return(Used); }

UnitGroup ** ColourContextHSVT::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 3469 of file colcontx.cpp. { return m_pUnitGroupArray; }

void ColourContextHSVT::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 3375 of file colcontx.cpp. { ENSURE(Result != NULL, "ColourContext::GetModelName called with NULL result pointer!"); *Result = String_32(_R(IDS_COLMODEL_HSVT)); }

void ColourContextHSVT::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 3628 of file colcontx.cpp. { ColourHSVT *hsvt = (ColourHSVT *) Result; hsvt->Hue = hsvt->Saturation = 0; hsvt->Value = 1.0; hsvt->Transparent = 0; }

void ColourContextHSVT::PackColour (  ColourGeneric *  Source, ColourPacked *  Result )  [protected, virtual]

Converts 128-bit colour representation to 32-bit packed form. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/04/94 Parameters: Source  - A ColourHSVT structure defining the colour in the model [INPUTS] pertaining to this colour context (HSVT) Result - A Packed colour structure in the same model, into which the result is copied. -  [OUTPUTS] Returns: - Overrides the base class to provide special packing of HSV colours, which use a 9-bit component for packed Hue, and a different component ordering within the PColourHSVT structure. Scope: Private (used internally by friend class DocColour) Returns: Errors: - See also: ColourContextHSVT::UnpackColour Reimplemented from ColourContext. Definition at line 3309 of file colcontx.cpp. { PColourHSVT *bob = (PColourHSVT *) Result; bob->Hue = PackColour360(Source->Component1); bob->Saturation = PackColour256(Source->Component2); bob->Value = PackColour256(Source->Component3); bob->Transparent = 0; //PackColour128(Source->Transparent); }

void ColourContextHSVT::UnpackColour (  ColourPacked *  Source, ColourGeneric *  Result )  [protected, virtual]

Converts 32-bit packed colour representation to 128-bit form. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 22/04/94 Parameters: Source  - A Packed Colour structure defining the colour in the model [INPUTS] pertaining to this colour context (HSVT) Result - A ColourGeneric structure in the same model, into which the result is copied. -  [OUTPUTS] Returns: - Overrides the base class to provide special packing of HSV colours, which use a 9-bit component for packed Hue, and a different component ordering within the PColourHSVT structure. Scope: Private (used internally by friend class DocColour) Returns: Errors: - See also: ColourContextHSVT::PackColour Reimplemented from ColourContext. Definition at line 3345 of file colcontx.cpp. { PColourHSVT *bob = (PColourHSVT *) Source; UnpackColour360(bob->Hue, &Result->Component1); UnpackColour256(bob->Saturation, &Result->Component2); UnpackColour256(bob->Value, &Result->Component3); Result->Component4 = 0;//UnpackColour128(bob->Transparent, &Result->Transparent); }

---

Friends And Related Function Documentation

friend class ColourContextList [friend]

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

friend class DocColour [friend]

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

friend class GRenderRegion [friend]

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

friend class OSRenderRegion [friend]

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

---

Member Data Documentation

UnitGroup * ColourContextHSVT::m_pUnitGroupArray [static, private]

Initial value: { &(StandardUnit::AngleGroup), &(StandardUnit::PercentGroup), &(StandardUnit::PercentGroup) } Definition at line 1197 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)

---