Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TColor
Inherited By:
None.
Purpose:
TLuvColor derives from TColor. TLuvColor is a class that defines a uniform tristimulus device-independent color space (a calibrated color space) whose values are standardized internationally by the CIE (Commission Internationale de l'Eclairage). Two of the dimensions (u and v) are coordinates on a uniform chromaticity diagram. The L dimension specifies the psychometric lightness. The TLuvColor class is used to express colors in a perceptually linear fashion. The perceptual distance between colors is proportional to the geometric distance between colors. The Luv color space is based upon work done by the CIE to define a uniform color space.
The TLuvColor class has three static fields that are used to define reference white color. Reference white is required to transform a TLuvColor to a TXYZColor. The default is reference white D6500. Member functions support correlates of lightness, chroma, saturation, and color-difference. The class also 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.
- TLuvColor ()
- TLuvColor (const TColor & aColor)
- TLuvColor (TColorProfile * theDeviceColorProfile)
- TLuvColor (TristimulusCoord aL, TristimulusCoord au, TristimulusCoord av, GIntensity opacity =1.0)
- TLuvColor (const TLuvColor & aLuvColor)
- TLuvColor (TColorProfile * theDeviceColorProfile, TristimulusCoord aL, TristimulusCoord au, TristimulusCoord av, GIntensity opacity =1.0)
- TLuvColor (TLuvColor & aLuvColor, TxyYColor & aRefWhite)
Interface Category:
API.
Purpose:
- Default constructor; it has the default color profile, and color components are not initialized.
- Creates a TLuvColor from a TColor.
- Creates a TLuvColor with the specified color profile. The color components are not initialized.
- Creates a TLuvColor with the specified components. It has the default color profile.
- Copy constructor.
- Creates a TLuvColor with the specified components and color profile.
- Creates a TLuvColor with a new white point
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.
- 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.
- TristimulusCoord aL -The L component of the new color.
- TristimulusCoord au -The u component of the new color.
- TristimulusCoord av -The v component of the new color.
- GIntensity opacity =1.0 -The opacity of the new color.
- const TLuvColor & aLuvColor -The color to be copied.
- TColorProfile * theDeviceColorProfile -The color profile for the new color.
- TristimulusCoord aL -The L component of the new color.
- TristimulusCoord au -The u component of the new color.
- TristimulusCoord av -The v component of the new color.
- GIntensity opacity =1.0 -The opacity of the new color.
- TLuvColor & aLuvColor -The color to be copied.
- TxyYColor & aRefWhite -The new white point of the color.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Member Function: TLuvColor::GetComponents
void GetComponents (TristimulusCoord & aL, TristimulusCoord & au, TristimulusCoord & av, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord & aL -The L component of this color.
- TristimulusCoord & au -The u component of this color.
- TristimulusCoord & av -The v component of this color.
- GIntensity & opacity -The opacity of this color.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetClampedComponents
void GetClampedComponents (TristimulusCoord & aL, TristimulusCoord & au, TristimulusCoord & av, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TLuvColor clamped between 0.0 <= N <= 1.0.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord & aL -The clamped L component of this color.
- TristimulusCoord & au -The clamped u component of this color.
- TristimulusCoord & 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: TLuvColor::GetL
TristimulusCoord GetL () const
Interface Category:
API.
Purpose:
Returns the L component of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the L component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::Getu
TristimulusCoord Getu () const
Interface Category:
API.
Purpose:
Returns the u component of this TLuvColor.
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: TLuvColor::Getv
TristimulusCoord Getv () const
Interface Category:
API.
Purpose:
Returns the v component of this TLuvColor.
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: TLuvColor::GetColorDifference
GCoordinate GetColorDifference (const TLuvColor & color2) const
Interface Category:
API.
Purpose:
Calculates the color difference between this TLuvColor and the specified color. The color difference is defined as the sqrt( (L1-L2)^2+(u1-u2)^2+(v1-v2)^2 ).
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & color2 -The color with which the difference is computed.
Return Value:
Returns 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: TLuvColor::SetComponents
void SetComponents (TristimulusCoord aL, TristimulusCoord au, TristimulusCoord av, GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the components of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord aL -The new value for the L component.
- TristimulusCoord au -The new value for the u component.
- TristimulusCoord 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: TLuvColor::Setu
void Setu (TristimulusCoord au)
Interface Category:
API.
Purpose:
Sets the u component of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord 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: TLuvColor::Setv
void Setv (TristimulusCoord av)
Interface Category:
API.
Purpose:
Sets the v component of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord 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: TLuvColor::operatorTRGBColor
virtual operator TRGBColor () const
Interface Category:
API.
Purpose:
Casts the TLuvColor to a TRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a TRGBColor that corresponds to the LuvColor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::operatorTXYZColor
virtual operator TXYZColor () const
Interface Category:
API.
Purpose:
Casts the TLuvColor to a TXYZColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a TXYZColor that corresponds to the LuvColor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::operator=
- TLuvColor & operator =(const TLuvColor & aSource)
- TColor & operator =(const TColor & aSource)
Interface Category:
API.
Purpose:
- Assignment operator.
- Assignment operator that casts the specified operand to a TLuvColor.
Calling Context:
- Called when an object is assigned to another compatible object.
- Called when an object is assigned to another compatible object.
Parameters:
- const TLuvColor & aSource -The object to be copied.
- const TColor & aSource -The object 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: TLuvColor::operator+
- TLuvColor operator + (const TLuvColor & aColor2) const
- TLuvColor operator + (const float aScalar) const
Interface Category:
API.
Purpose:
- Adds the components of the two TLuvColors together.
- Adds the specified scalar to each component of this TLuvColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TLuvColor & 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: TLuvColor::operator-
- TLuvColor operator -(const TLuvColor & aColor2) const
- TLuvColor operator -(const float aScalar) const
Interface Category:
API.
Purpose:
- Subtracts the components of the specified color from this TLuvColor.
- Subtracts the specified scalar from each component of this TLuvColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TLuvColor & 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: TLuvColor::operator*
- TLuvColor operator * (const float aScalar) const
- TLuvColor operator * (const TLuvColor & aColor2) const
Interface Category:
API.
Purpose:
- Multiplies each component of this TLuvColor by the specified scalar.
- Multiplies the components of this TLuvColor by the components of the specified color.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const float aScalar -The multiplier.
- const TLuvColor & 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: TLuvColor::operator/=
TLuvColor & operator /= (const float aScalar)
Interface Category:
API.
Purpose:
Divides the components of this TLuvColor 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: TLuvColor::operator+=
- TLuvColor & operator += (const float aScalar)
- TLuvColor & operator += (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
- Adds the specified scalar to the components of this TLuvColor and assigns the new values to the respective components.
- Adds the specified colors to the components of this TLuvColor 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 TLuvColor & aColor2 -The color to be added to this one.
Return Value:
- Returns this color with the new components.
- 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: TLuvColor::operator-=
- TLuvColor & operator -=(const float aScalar)
- TLuvColor & operator -=(const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
- Subtracts the specified scalar from the components of this TLuvColor and assigns the new values to the respective components.
- Subtracts the specified scalar from the components of this TLuvColor 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 TLuvColor & aColor2 -The subtrahend.
Return Value:
- Returns this color with the new components.
- 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: TLuvColor::operator*=
TLuvColor & operator *= (const float aScalar)
Interface Category:
API.
Purpose:
Multiplies the components of this TLuvColor 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: TLuvColor::operator/
TLuvColor operator / (const float aScalar) const
Interface Category:
API.
Purpose:
Divides each component in this TLuvColor by the specified scalar.
Calling Context:
Call this operator directly.
Parameters:
- const float aScalar -The divisor.
Return Value:
Returns a color with the new components.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::FuzzyCompare
- bool FuzzyCompare (const TLuvColor & aLuvColor, float acceptableErrorPerComponent =0.0001) const
- bool FuzzyCompare (const TLuvColor & aLuvColor, float errOpacity, float errL, float erru, float errv) const
Interface Category:
API.
Purpose:
- Compares this TLuvColor 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 TLuvColor 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 TLuvColor & aLuvColor -The color that is compared to this color.
- float acceptableErrorPerComponent =0.0001 -The tolerance with which the two colors are compared.
- const TLuvColor & aLuvColor -The that is compared to this color.
- float errOpacity -The tolerance with which the opacities of the two colors are compared.
- float errL -The tolerance with which the L 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 tolerance.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::LinearInterpolate
void LinearInterpolate (const float aWeight, const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Makes a weighted linear interpolation of each component of this TLuvColor. The interpolation is returned in this color.
The interpolation that is done for each component is (using L as an example) given by L =L + (Color2.L -L) * Weight.
Calling Context:
Call this function directly.
Parameters:
- const float aWeight -The weight to use.
- const TLuvColor & 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: TLuvColor::AddAndPin
void AddAndPin (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Adds the specified color to this TLuvColor and then clamps the resulting values of the components.
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & 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: TLuvColor::SubtractAndPin
void SubtractAndPin (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Subtracts the specified color from this TLuvColor 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: TLuvColor::Maximum
void Maximum (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Determines the maximum of individual components of this TLuvColor and the specified color. It sets the components of this color to the resulting maximum values.
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & aColor2 -The color whose components are compared.
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: TLuvColor::Minimum
void Minimum (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Determines the maximum of individual components of this TLuvColor and the specified color. It sets the components of this color to the resulting maximum values.
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & aColor2 -The color whose components are compared.
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: TLuvColor::Blend
void Blend (const TLuvColor & aColor2)
Interface Category:
API.
Purpose:
Averages the individual components of the two colors and returns them in this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & aColor2 -The color whose components are 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: TLuvColor::Invert
void Invert ()
Interface Category:
API.
Purpose:
Inverts this TLuvColor.
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: TLuvColor::Clamp
void Clamp ()
Interface Category:
API.
Purpose:
Clamps the components of this TLabColor 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: TLuvColor::Scale
void Scale ()
Interface Category:
API.
Purpose:
Scale this TLabColor 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: TLuvColor::TemporaryTypeID
virtual TemporaryColorClassID TemporaryTypeID () const
Interface Category:
API.
Purpose:
Determines the type of color that the derived class of TLuvColor represents.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns TColor::kTLuvColor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::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: TLuvColor::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: TLuvColor::SetRefWhite
- void SetRefWhite (TxyYColor & aRefWhite)
- void SetRefWhite (ChromaCoord x, ChromaCoord y, TristimulusCoord Y)
- void SetRefWhite (Temperature aTemperature)
Interface Category:
API.
Purpose:
- Sets the reference white of the TLuvColor class to the specified TxyYColor.
- Sets the reference white of the TLuvColor class to the TxyYColor defined by the specified components.
- Sets the reference white of the TLuvColor class to the specified color temperature.
Calling Context:
- Call this function directly.
- Call this function directly.
- Call this function directly.
Parameters:
- TxyYColor & aRefWhite -The new value for the reference white.
- ChromaCoord x -The x component of the new reference white.
- ChromaCoord y -The y component of the new reference white.
- TristimulusCoord Y -The Y component of the new reference white.
- Temperature aTemperature -The color temperature of the new reference white.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetRefWhite
void GetRefWhite (TxyYColor & aRefWhite)
Interface Category:
API.
Purpose:
Returns the xyYColor that is the reference white of the TLuvColor class in the specified parameter.
Calling Context:
Call this function directly.
Parameters:
- TxyYColor & aRefWhite -The new reference white.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetHueDifference
GCoordinate GetHueDifference (const TLuvColor & Color2) const
Interface Category:
API.
Purpose:
Provides the numeric color difference in hue between two colors expressed in Luv space. The difference is calculated between this TLuvColor and the color (Color2) passed in as a parameter. A quantity of hue difference is described as the difference between its total color difference and its correlates of lightness and chroma.
Calling Context:
Call this function directly.
Parameters:
- const TLuvColor & Color2 -The color against which a difference is desired.
Return Value:
Returns the numeric value of the difference in hue between the two colors.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetHueAngle
GCoordinate GetHueAngle () const
Interface Category:
API.
Purpose:
Provides the hue angle of a given color. Hue angle is a useful quantity for specifying hue numerically. It is given by arctan(v/u).
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the hue angle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetCorrelatesOfSaturation
GCoordinate GetCorrelatesOfSaturation () const
Interface Category:
API.
Purpose:
Provides the correlate of saturation for the color, which is defined to be a quantity that remains constant when corresponding increases or decreases occur in luminance and the correlate of lightness.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the numeric value of the correlate of saturation for this color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetCorrelatesOfChroma
GCoordinate GetCorrelatesOfChroma () const
Interface Category:
API.
Purpose:
Calculates the correlate of chroma, which is the square root of the sum of the squares of u and v.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the numeric value of the correlate of chroma.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::GetCorrelateOfLightness
GCoordinate GetCorrelateOfLightness () const
Interface Category:
API.
Purpose:
Calculates the correlate of lightness which is usually defined to be the L component of the color.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the correlate of lightness for the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TLuvColor::SetL
void SetL (TristimulusCoord aL)
Interface Category:
API.
Purpose:
Sets the L component of this TLuvColor.
Calling Context:
Call this function directly.
Parameters:
- TristimulusCoord aL -The new value for the L component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TLuvColor ()
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: TLuvColor::ClampOpacity
void ClampOpacity ()
Interface Category:
API.
Purpose:
Pins the opacity of this TLuvColor 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: TLuvColor::SetOpacity
void SetOpacity (GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the opacity of this TLuvColor 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: TLuvColor::GetClampedOpacity
GIntensity GetClampedOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TLuvColor 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: TLuvColor::GetOpacity
GIntensity GetOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TLuvColor.
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.