Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TColor
Inherited By:
None.
Purpose:
TYuvColor, derived from TColor, defines the Yuv color space, which is the standard for European television (PAL). The European system provides more bandwidth for the chromaticity signals than does the American NTSC standard (which defines the YIQ color model). The weighting coefficients used for the Y signal are the same as in the YIQ color model. The u and v components are given by the following:
u =0.493( Blue -Y)
v =0.877( Red -Y)
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.
- TYuvColor ()
- TYuvColor (const TColor & aColor)
- TYuvColor (TColorProfile * theDeviceColorProfile)
- TYuvColor (GIntensity aY, GIntensity au, GIntensity av, GIntensity opacity =1.0)
- TYuvColor (const TYuvColor & aYuvColor)
- TYuvColor (TColorProfile * theDeviceColorProfile, GIntensity aY, GIntensity au, GIntensity av, GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
- Default constructor; it has the default color profile, and color components are not initialized.
- Creates a TYuvColor from a TColor.
- Creates a TYuvColor with the specified color profile. The color components are not initialized.
- Creates a TYuvColor with the specified components. It has the default color profile.
- Copy constructor.
- Creates a TYuvColor with the given 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 aY -The Y component of the new color.
- GIntensity au -The u component of the new color.
- GIntensity av -The v component of the new color.
- GIntensity opacity =1.0 -The opacity of the new color.
- const TYuvColor & aYuvColor -The color to be copied.
- TColorProfile * theDeviceColorProfile -The color profile for the new color.
- GIntensity aY -The Y component of the new color.
- GIntensity au -The u component of the new color.
- GIntensity av -The v 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: TYuvColor::GetComponents
void GetComponents (GIntensity & aY, GIntensity & au, GIntensity & av, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity & aY -The Y component of the color.
- GIntensity & au -The u component of the color.
- GIntensity & av -The v 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: TYuvColor::GetClampedComponents
void GetClampedComponents (GIntensity & aY, GIntensity & au, GIntensity & av, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TYuvKColor clamped between 0.0 <= N <=1.0.
Calling Context:
Call this function directly.
Parameters:
- GIntensity & aY -The clamped Y component of this color.
- GIntensity & au -The clamped u component of this color.
- GIntensity & av -The clamped v 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: TYuvColor::GetY
GIntensity GetY () const
Interface Category:
API.
Purpose:
Gets the Y component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the Y component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::Getu
GIntensity Getu () const
Interface Category:
API.
Purpose:
Gets the u component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the u component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::Getv
GIntensity Getv () const
Interface Category:
API.
Purpose:
Gets the v component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the v component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::GetColorDifference
GCoordinate GetColorDifference (const TYuvColor & aColor2) const
Interface Category:
API.
Purpose:
Calculates the color difference between this TYuvColor and the specified one. The color difference is defined as the sqrt( (Y1-Y2)^2+(u1-u2)^2+(v1-v2)^2 ).
Calling Context:
Call this function directly.
Parameters:
- const TYuvColor & 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: TYuvColor::SetComponents
void SetComponents (GIntensity aY, GIntensity au, GIntensity av, GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the components of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity aY -The new value for the Y component.
- GIntensity au -The new value for the u component.
- GIntensity av -The new value for the v 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: TYuvColor::Setu
void Setu (GIntensity au)
Interface Category:
API.
Purpose:
Sets the u component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity au -The new value for the u component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::SetY
void SetY (GIntensity aY)
Interface Category:
API.
Purpose:
Sets the Y component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity aY -The new value for the Y component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::Setv
void Setv (GIntensity av)
Interface Category:
API.
Purpose:
Sets the v component of this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity av -The new value for the v component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::operatorTRGBColor
virtual operator TRGBColor () const
Interface Category:
API.
Purpose:
Casts this TYuvColor to a TRGBColor.
Calling Context:
Call this operator directly.
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: TYuvColor::operatorTXYZColor
virtual operator TXYZColor () const
Interface Category:
API.
Purpose:
Casts this TYuvColor to a TXYZColor.
Calling Context:
Call this operator directly.
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: TYuvColor::operator=
- TYuvColor & operator =(const TYuvColor & aSource)
- TColor & operator =(const TColor & aSource)
Interface Category:
API.
Purpose:
- Assignment operator.
- Assignment operator that casts the specified operand to a TYuvColor.
Calling Context:
- Called when an object is assigned to another compatible object.
- Called when an object is assigned to another compatible object.
Parameters:
- const TYuvColor & 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: TYuvColor::operator+
- TYuvColor operator + (const TYuvColor & aColor2) const
- TYuvColor operator + (const float aScalar) const
Interface Category:
API.
Purpose:
- Adds the components of the two TYuvColors together.
- Adds the specified scalar to each component of this TYuvColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TYuvColor & 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: TYuvColor::operator-
- TYuvColor operator -(const TYuvColor & aColor2) const
- TYuvColor operator -(const float aScalar) const
Interface Category:
API.
Purpose:
- Subtracts the components of the specified color from this TYuvColor.
- Subtracts the specified scalar from each component of this TYuvColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TYuvColor & 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: TYuvColor::operator*
- TYuvColor operator * (const float aScalar) const
- TYuvColor operator * (const TYuvColor & aColor2) const
Interface Category:
API.
Purpose:
- Multiplies each component of this TYuvColor by the specified scalar.
- Multiplies the components of this TYuvColor by the components of the specified color.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const float aScalar -The multiplier.
- const TYuvColor & 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: TYuvColor::operator/=
TYuvColor & operator /= (const float aScalar)
Interface Category:
API.
Purpose:
Divides the components of this TYuvColor 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: TYuvColor::operator+=
- TYuvColor & operator += (const float aScalar)
- TYuvColor & operator += (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
- Adds the specified scalar to the components of this TYIQColor and assigns the new values to the respective components.
- Adds the specified colors to the components of this TYIQColor 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 TYuvColor & aColor2 -The number 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: TYuvColor::operator-=
- TYuvColor & operator -=(const float aScalar)
- TYuvColor & operator -=(const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
- Subtracts the specified scalar from the components of this TYuvColor and assigns the new values to the respective components.
- Subtracts the specified scalar from the components of this TYuvColor 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 TYuvColor & aColor2 -The subtrahend.
Return Value:
- Call this operator directly.
- Call this operator directly.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
The color's opacity is set to 1.0.
Member Function: TYuvColor::operator*=
TYuvColor & operator *= (const float aScalar)
Interface Category:
API.
Purpose:
Multiplies the components of this TYuvColor 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: TYuvColor::operator/
TYuvColor operator / (const float aScalar) const
Interface Category:
API.
Purpose:
Divides each component of this TYuvColor 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: TYuvColor::FuzzyCompare
- bool FuzzyCompare (const TYuvColor & aYuvColor, float acceptableErrorPerComponent =0.0001) const
- bool FuzzyCompare (const TYuvColor & aYuvColor, float errOpacity, float errY, float erru, float errv) const
Interface Category:
API.
Purpose:
- Compares this TYuvColor 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 TYuvColor 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 TYuvColor & aYuvColor -The color that is compared to this color.
- float acceptableErrorPerComponent =0.0001 -The tolerance with which the two colors are compared.
- const TYuvColor & aYuvColor -The color that is compared to this color.
- float errOpacity -The tolerance with which the opacities of the two colors are compared.
- float errY -The tolerance with which the Y components of the two colors are compared.
- float erru -The tolerance with which the u components of the two colors are compared.
- float errv -The tolerance with which the v 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: TYuvColor::LinearInterpolate
void LinearInterpolate (const float aWeight, const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Makes a weighted linear interpolation of each component of this TYIQColor. The interpolation is returned in this color.
The interpolation that is done for each component is (using Y as an example) given by Y1 =Y1 + (Y2 -Y1) * Weight.
Calling Context:
Call this function directly.
Parameters:
- const float aWeight -The weight to use.
- const TYuvColor & 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: TYuvColor::AddAndPin
void AddAndPin (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Adds the specified color to this TYuvColor and then clamps the resulting values of the components.
Calling Context:
Call this function directly.
Parameters:
- const TYuvColor & 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: TYuvColor::SubtractAndPin
void SubtractAndPin (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Subtracts the specified color from this TYuvColor and then clamps the resulting values of the components.
Calling Context:
Call this function directly.
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: TYuvColor::Maximum
void Maximum (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Determines the maximum of individual components of this TYuvColor and the specified color. It sets the components of this color to the resulting maximum values.
Calling Context:
Call this function directly.
Parameters:
- const TYuvColor & 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: TYuvColor::Minimum
void Minimum (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Determines the minimum of individual components of this TYuvColor and the specified color. It sets the components of this color to the resulting minimum values.
Calling Context:
Call this function directly.
Parameters:
- const TYuvColor & 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: TYuvColor::Blend
void Blend (const TYuvColor & aColor2)
Interface Category:
API.
Purpose:
Averages the individual components of the two colors and returns them in this TYuvColor.
Calling Context:
Call this function directly.
Parameters:
- const TYuvColor & 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: TYuvColor::Invert
void Invert ()
Interface Category:
API.
Purpose:
Inverts this TYuvColor.
Calling Context:
Call this function directly.
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: TYuvColor::Clamp
void Clamp ()
Interface Category:
API.
Purpose:
Clamps the components of this TYuvColor 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:
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: TYuvColor::Scale
void Scale ()
Interface Category:
API.
Purpose:
Scales this TYuvColor 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:
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: TYuvColor::TemporaryTypeID
virtual TemporaryColorClassID TemporaryTypeID () const
Interface Category:
API.
Purpose:
Returns TColor::kYuvColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns TColor::kYuvColor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::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: TYuvColor::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.
virtual ~ TYuvColor ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::ClampOpacity
void ClampOpacity ()
Interface Category:
API.
Purpose:
Pins the opacity of this TYuvColor to the range 0.0 to 1.0.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::SetOpacity
void SetOpacity (GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the opacity of this TYuvColor 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: TYuvColor::GetClampedOpacity
GIntensity GetClampedOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TYuvColor and pins the value to the range 0.0 to 1.0.
Calling Context:
Call this function directly.
Parameters:
Return Value:
The clamped opacity.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TYuvColor::GetOpacity
GIntensity GetOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TYuvColor.
Calling Context:
Call this function directly.
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.
Copyright©1995 Taligent,Inc. All rights reserved.