Class: TCMYColor

Declaration: CMYColor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TColor

Inherited By:

None.

Purpose:

TCMYColor derives from TColor. TCMYColor defines a color model of Cyan, Magenta, and Yellow. The CMY primaries are subtractive and used for most color hard-copy devices. Most hard-copy devices deposit colored pigments onto paper. When a surface is coated with cyan ink, for example, no red light is reflected. Cyan subtracts red light from reflected white light. Values of the primaries should be constrained to the range of between 0.0 and 1.0, inclusive. Member functions are provided to clamp the CMY primaries to this range. The CMY color model is uncalibrated; therefore, CMY colors must be defined with respect to a particular color device through a color profile. The class provides arithmetic operators that operate on two colors.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive new color models from TColor.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TCMYColor::TCMYColor

TCMYColor ()
TCMYColor (const TColor & aColor)
TCMYColor (TColorProfile * theDeviceColorProfile)
TCMYColor (GIntensity aCyan, GIntensity aMagenta, GIntensity aYellow, GIntensity opacity =1.0)
TCMYColor (const TCMYColor & aCMYColor)
TCMYColor (TColorProfile * theDeviceColorProfile, GIntensity aCyan, GIntensity aMagenta, GIntensity aYellow, GIntensity opacity =1.0)

Interface Category:

API.

Purpose:

Default constructor; it has the default color profile, and color components are not initialized.
Creates a TCMYColor from a TColor.
Creates a TCMYColor with the specified color profile. The color components are not initialized.
Creates a TCMYColor with the specified components. It has the default color profile.
Copy constructor.
Creates a TCMYColor with the specified components and color profile.

Calling Context:

Called by the stream-in operators. You can also call this function directly.
Call this function directly.
Call this function directly.
Call this function directly.
Called to copy an object. You can also call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
const TColor & aColor -The color to be copied.
TColorProfile * theDeviceColorProfile -The color profile for the new color.
GIntensity aCyan -The cyan component of the new color.
GIntensity aMagenta -The magenta component of the new color.
GIntensity aYellow -The yellow component of the new color.
GIntensity opacity =1.0 -The opacity of the new color.
const TCMYColor & aCMYColor -The color to be copied.
TColorProfile * theDeviceColorProfile -The color profile for the new color.
GIntensity aCyan -The cyan component of the new color.
GIntensity aMagenta -The magenta component of the new color.
GIntensity aYellow -The yellow component of the new color.
GIntensity opacity =1.0 -The opacity of the new color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Member Function: TCMYColor::GetComponents

void GetComponents (GIntensity & aCyan, GIntensity & aMagenta, GIntensity & aYellow, GIntensity & opacity) const

Interface Category:

API.

Purpose:

Gets the components of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

GIntensity & aCyan -The cyan component of the color.
GIntensity & aMagenta -The magenta component of the color.
GIntensity & aYellow -The yellow component of the color.
GIntensity & opacity -The opacity of the color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetClampedComponents

void GetClampedComponents (GIntensity & aCyan, GIntensity & aMagenta, GIntensity & aYellow, GIntensity & opacity) const

Interface Category:

API.

Purpose:

Gets the components of this TCMYColor clamped between 0.0 <= N <=1.0.

Calling Context:

Call this function directly.

Parameters:

GIntensity & aCyan -The clamped cyan component of this color.
GIntensity & aMagenta -The clamped magenta component of this color.
GIntensity & aYellow -The clamped yellow component of this color.
GIntensity & opacity -The clamped opacity of this color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetCyan

GIntensity GetCyan () const

Interface Category:

API.

Purpose:

Gets the cyan component of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the cyan component of the color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetMagenta

GIntensity GetMagenta () const

Interface Category:

API.

Purpose:

Gets the magenta component of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the magenta component of the color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetYellow

GIntensity GetYellow () const

Interface Category:

API.

Purpose:

Gets the yellow component of the color.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the yellow component of the color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetColorDifference

GCoordinate GetColorDifference (const TCMYColor & aColor2) const

Interface Category:

API.

Purpose:

Calculates the color difference between this TCMYColor and the specified one. The color difference is defined as the sqrt( (cyan1-cyan2)^2+(magenta1-magenta2)^2+(yellow1-yellow2)^2 ).

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The color with which the difference is computed.

Return Value:

The value of the color difference between the two colors.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::SetComponents

void SetComponents (GIntensity aCyan, GIntensity aMagenta, GIntensity aYellow, GIntensity opacity =1.0)

Interface Category:

API.

Purpose:

Sets the components of this TCMYColor to the specified values.

Calling Context:

Call this function directly.

Parameters:

GIntensity aCyan -The new value for the cyan component.
GIntensity aMagenta -The new value for the magenta component.
GIntensity aYellow -The new value for the yellow component.
GIntensity opacity =1.0 -The new value for the opacity.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::SetMagenta

void SetMagenta (GIntensity aMagenta)

Interface Category:

API.

Purpose:

Sets the magenta component of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

GIntensity aMagenta -The new value for the magenta component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::SetYellow

void SetYellow (GIntensity aYellow)

Interface Category:

API.

Purpose:

Sets the yellow component of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

GIntensity aYellow -The new value for the yellow component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operatorTRGBColor

virtual operator TRGBColor () const

Interface Category:

API.

Purpose:

Casts this TCMYColor to a TRGBColor.

Calling Context:

Call this operator directly.

Parameters:

Takes no parameters.

Return Value:

Returns an RGBColor that corresponds to this color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operatorTXYZColor

virtual operator TXYZColor () const

Interface Category:

API.

Purpose:

Casts this TCMYColor to a TXYZColor.

Calling Context:

Call this operator directly.

Parameters:

Takes no parameters.

Return Value:

Returns an XYZColor that corresponds to this color.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operator=

TCMYColor & operator =(const TCMYColor & aSource)
TColor & operator =(const TColor & aSource)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator that casts the specified operand to a TCMYColor.

Calling Context:

Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.

Parameters:

const TCMYColor & aSource -The color to be copied.
const TColor & aSource -The color to be converted and copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operator+

TCMYColor operator + (const TCMYColor & aColor2) const
TCMYColor operator + (const float aScalar) const

Interface Category:

API.

Purpose:

Adds the components of the two TCMYColors together.
Adds the specified scalar to each component of this TCMYColor.

Calling Context:

Call this operator directly.
Call this operator directly.

Parameters:

const TCMYColor & aColor2 -The color to be added to this one.
const float aScalar -The scalar to be added to each component of this color.

Return Value:

Returns a new color with the new components.
Returns a new color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The values of the components are not clamped to the range 0.0 <= N <= 1.0.

Member Function: TCMYColor::operator-

TCMYColor operator -(const TCMYColor & aColor2) const
TCMYColor operator -(const float aScalar) const

Interface Category:

API.

Purpose:

Subtracts the components of the specified color from this TCMYColor.
Subtracts the specified scalar from each component of this TCMYColor.

Calling Context:

Call this operator directly.
Call this operator directly.

Parameters:

const TCMYColor & aColor2 -The subtrahend.
const float aScalar -The subtrahend.

Return Value:

Returns a new color with the new components.
Returns a new color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The values of the components are not clamped to the range 0.0 <= N <= 1.0.

Member Function: TCMYColor::operator*

TCMYColor operator * (const float aScalar) const
TCMYColor operator * (const TCMYColor & aColor2) const

Interface Category:

API.

Purpose:

Multiplies each component of this TCMYColor by the specified scalar.
Multiplies the components of this TCMYColor by the components of the specified color.

Calling Context:

Call this operator directly.
Call this operator directly.

Parameters:

const float aScalar -The multiplier.
const TCMYColor & aColor2 -The multiplier.

Return Value:

Returns a new color with the new components.
Returns a new color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The values of the components are not clamped to the range 0.0 <= N <= 1.0.

Member Function: TCMYColor::operator/=

TCMYColor & operator /= (const float aScalar)

Interface Category:

API.

Purpose:

Divides the components of this TCMYColor by the specified scalar and assigns the new values to the respective components.

Calling Context:

Call this operator directly.

Parameters:

const float aScalar -The divisor.

Return Value:

Returns this color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::operator+=

TCMYColor & operator += (const float aScalar)
TCMYColor & operator += (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Adds the specified scalar to the components of this TCMYColor and assigns the new values to the respective components.
Adds the specified colors to the components of this TCMYColor and assigns the new values to the respective components.

Calling Context:

Call this operator directly.
Call this operator directly.

Parameters:

const float aScalar -The number to be added to this color.
const TCMYColor & aColor2 -The color to be added to this color.

Return Value:

Returns this color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::operator-=

TCMYColor & operator -=(const float aScalar)
TCMYColor & operator -=(const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Subtracts the specified scalar from the components of this TCMYColor and assigns the new values to the respective components.
Subtracts the specified scalar from the components of this TCMYColor and assigns the new values to the respective components.

Calling Context:

Call this operator directly.
Call this operator directly.

Parameters:

const float aScalar -The subtrahend.
const TCMYColor & aColor2 -The subtrahend.

Return Value:

Returns this color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::operator*=

TCMYColor & operator *= (const float aScalar)

Interface Category:

API.

Purpose:

Multiplies the components of this TCMYColor by the specified scalar and assigns the new values to the respective components.

Calling Context:

Call this operator directly.

Parameters:

const float aScalar -The multiplier.

Return Value:

Returns this color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::operator/

TCMYColor operator / (const float aScalar) const

Interface Category:

API.

Purpose:

Divides each component of this TCMYColor by the specified scalar.

Calling Context:

Call this operator directly.

Parameters:

const float aScalar -The divisor.

Return Value:

Returns this color with the new components.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The values of the components are not clamped to the range 0.0 <= N <= 1.0.

Member Function: TCMYColor::FuzzyCompare

bool FuzzyCompare (const TCMYColor & aCMYColor, float acceptableErrorPerComponent =0.0001) const
bool FuzzyCompare (const TCMYColor & aCMYColor, float errOpacity, float errCyan, float errMagenta, float errYellow) const

Interface Category:

API.

Purpose:

Compares this TCMYColor and the specified color with reference to the specified tolerance. It takes the absolute difference between the components of the color and compares them to a known value.
Compares this TCMYColor and the specified color to a given accuracy on a component by component level.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TCMYColor & aCMYColor -The color that is compared to this color.
float acceptableErrorPerComponent =0.0001 -The tolerance with which the two colors are compared.
const TCMYColor & aCMYColor -The color that is compared to this color.
float errOpacity -The tolerance with which the opacities of the two colors are compared.
float errCyan -The tolerance with which the cyan components of the two colors are compared.
float errMagenta -The tolerance with which the magenta components of the two colors are compared.
float errYellow -The tolerance with which the yellow components of the two colors are compared.

Return Value:

Returns true if the two colors are equal with reference to the specified tolerance.
Returns true if the two colors are equal with reference to the specified tolerances.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::LinearInterpolate

void LinearInterpolate (const float aWeight, const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Makes a weighted linear interpolation of each component of this TCMYColor. The interpolation is returned in this color. The interpolation that is done for each component is (using cyan as an example) given by cyan1 =cyan1 + (cyan2 -cyan1) * Weight.

Calling Context:

Call this function directly.

Parameters:

const float aWeight -The weight to use.
const TCMYColor & aColor2 -The color to be interpolated with this one.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::AddAndPin

void AddAndPin (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Adds the specified color to this TCMYColor and then clamps the resulting values of the components.

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The color to be added to this one.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::SubtractAndPin

void SubtractAndPin (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Subtracts the specified color from this TCMYColor and then clamps the resulting values of the components.

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The subtrahend.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Maximum

void Maximum (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Determines the maximum of individual components of this TCMYColor and the specified color. It sets the components of this color to the resulting maximum values.

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The color whose components are compared with this one.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Minimum

void Minimum (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Determines the minimum of individual components of this TCMYColor and the specified color. It sets the components of this color to the resulting minimum values.

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The color whose components are compared with this one.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Blend

void Blend (const TCMYColor & aColor2)

Interface Category:

API.

Purpose:

Averages the individual components of the two colors and returns them in this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

const TCMYColor & aColor2 -The color to be blended with this one.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Invert

void Invert ()

Interface Category:

API.

Purpose:

Inverts this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Clamp

void Clamp ()

Interface Category:

API.

Purpose:

Clamps the components of this TCMYColor between 0.0 <= N <= 1.0. If a value is less than 0.0, it is set to 0.0, and if it is greater than 1.0, it is set to 1.0.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::Scale

void Scale ()

Interface Category:

API.

Purpose:

Scales this TCMYColor to 1.0. If all of the color's components are between 0.0 <= N <= 1.0, the color is untouched. If there are components with values greater than 1.0, then the largest component is used to renormalize the color. If any of the color's components are less than 0.0, they set to 0.0.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The color's opacity is set to 1.0.

Member Function: TCMYColor::TemporaryTypeID

virtual TemporaryColorClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns TColor::kCMYColor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns TColor::kCMYColor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream that the object's data is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream that the object's data is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::SetCyan

void SetCyan (GIntensity aCyan)

Interface Category:

API.

Purpose:

Sets the cyan component of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

GIntensity aCyan -The new value for the cyan component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::~TCMYColor

virtual ~ TCMYColor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::ClampOpacity

void ClampOpacity ()

Interface Category:

API.

Purpose:

Pins the opacity of this TCMYColor to the range 0.0 to 1.0.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::SetOpacity

void SetOpacity (GIntensity opacity =1.0)

Interface Category:

API.

Purpose:

Sets the opacity of this TCMYColor to the specified value.

Calling Context:

Call this function directly.

Parameters:

GIntensity opacity =1.0 -The new value for the opacity.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetClampedOpacity

GIntensity GetClampedOpacity () const

Interface Category:

API.

Purpose:

Returns the opacity of this TCMYColor and pins the value to the range 0.0 to 1.0.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The clamped opacity.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCMYColor::GetOpacity

GIntensity GetOpacity () const

Interface Category:

API.

Purpose:

Returns the opacity of this TCMYColor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The opacity that can be outside the range 0.0 to 1.0.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.