Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TColor
Inherited By:
None.
Purpose:
TRGBColor derives from TColor. The TRGBClass defines the Cartesian coordinate-based color model of red, green, and blue. The RGB primaries, which are additive, are used for most color monitors and color raster graphic systems. Because most RGB monitors emit radiation, the color perceived at the eye is the sum of three primaries. Values of the primaries should be constrained to the range between 0.0 and 1.0, inclusive. Member functions are provided to clamp the RGB primaries to this range. The RGB color model is uncalibrated; therefore, RGB colors must be defined with respect to a particular color device through a color profile.
Because many people are accustomed to working directly with individual values of red, green, and blue, these components are provided as public member variables.
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.
- TRGBColor ()
- TRGBColor (TColorProfile * theDeviceColorProfile)
- TRGBColor (GIntensity Red, GIntensity Green, GIntensity Blue, GIntensity opacity =1.0)
- TRGBColor (const TRGBColor & aRGBColor)
- TRGBColor (TColorProfile * theDeviceColorProfile, GIntensity Red, GIntensity Green, GIntensity Blue, GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
- Default constructor; it has the default color profile, and color components are not initialized.
- Creates a TRGBColor with the specified color profile. The color components are not initialized.
- Creates a TRGBColor with the specified components. It has the default color profile.
- Copy constructor.
- Creates a TRGBColor 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.
- Called to copy an object. You can also call this function directly.
- Call this function directly.
Parameters:
- Takes no parameters.
- TColorProfile * theDeviceColorProfile -The color profile for the new color.
- GIntensity Red -The red component of the new color.
- GIntensity Green -The green component of the new color.
- GIntensity Blue -The blue component of the new color.
- GIntensity opacity =1.0 -The opacity of the new color.
- const TRGBColor & aRGBColor -The color to be copied.
- TColorProfile * theDeviceColorProfile -The color profile for the new color.
- GIntensity Red -The red component of the new color.
- GIntensity Green -The green component of the new color.
- GIntensity Blue -The blue 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: TRGBColor::GetComponents
void GetComponents (GIntensity & Red, GIntensity & Green, GIntensity & Blue, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity & Red -The red component of this color.
- GIntensity & Green -The green component of this color.
- GIntensity & Blue -The blue 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: TRGBColor::GetClampedComponents
void GetClampedComponents (GIntensity & Red, GIntensity & Green, GIntensity & Blue, GIntensity & opacity) const
Interface Category:
API.
Purpose:
Gets the components of this TRGBColor clamped between 0.0 <= N <=1.0.
Calling Context:
Call this function directly.
Parameters:
- GIntensity & Red -The clamped red component of this color.
- GIntensity & Green -The clamped green component of this color.
- GIntensity & Blue -The clamped blue 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: TRGBColor::GetRed
GIntensity GetRed () const
Interface Category:
API.
Purpose:
Gets the red component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the red component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::GetGreen
GIntensity GetGreen () const
Interface Category:
API.
Purpose:
Returns the green component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the green component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::GetBlue
GIntensity GetBlue () const
Interface Category:
API.
Purpose:
Returns the blue component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the blue component of the color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::GetColorDifference
GCoordinate GetColorDifference (const TRGBColor & color2) const
Interface Category:
API.
Purpose:
Calculates the color difference between this TRGBColor and the specified one. The color difference is defined as the sqrt( (red1-red2)^2+(green1-green2)^2+(blue1-blue2)^2 ).
Calling Context:
Call this function directly.
Parameters:
- const TRGBColor & 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: TRGBColor::SetComponents
void SetComponents (GIntensity Red, GIntensity Green, GIntensity Blue, GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the components of this TRGBColor to the specified parameters.
Calling Context:
Call this function directly.
Parameters:
- GIntensity Red -The new value for the red component.
- GIntensity Green -The new value for the green component.
- GIntensity Blue -The new value for the blue 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: TRGBColor::SetRed
void SetRed (GIntensity Red)
Interface Category:
API.
Purpose:
Sets the red component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity Red -The new value for the red component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::SetGreen
void SetGreen (GIntensity Green)
Interface Category:
API.
Purpose:
Sets the green component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity Green -The new value for the green component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::SetBlue
void SetBlue (GIntensity Blue)
Interface Category:
API.
Purpose:
Sets the blue component of this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
- GIntensity Blue -The new value for the blue component.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::operatorTRGBColor
virtual operator TRGBColor () const
Interface Category:
API.
Purpose:
Casts this TRGBColor to a TRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a TRGBColor that corresponds to this color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Not strictly useful, but necessary for orthogonality.
Member Function: TRGBColor::operatorTXYZColor
virtual operator TXYZColor () const
Interface Category:
API.
Purpose:
Casts this TRGBColor to a TXYZColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a TXYZColor that corresponds to this color.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::operator=
- TRGBColor & operator =(const TRGBColor & aSource)
- virtual TColor & operator =(const TColor & source)
Interface Category:
API.
Purpose:
- Assignment operator.
- Assignment operator that casts the specified operand to a TRGBColor.
Calling Context:
- Called when an object is assigned to another compatible object.
- Called when an object is assigned to another compatible object.
Parameters:
- const TRGBColor & aSource -The object to be copied.
- const TColor & source -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: TRGBColor::operator+
- TRGBColor operator + (const TRGBColor & aColor2) const
- TRGBColor operator + (const float aScalar) const
Interface Category:
API.
Purpose:
- Adds the components of the two TRGBColors together.
- Adds the specified scalar to each component of this TRGBColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TRGBColor & 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: TRGBColor::operator-
- TRGBColor operator -(const TRGBColor & aColor2) const
- TRGBColor operator -(const float aScalar) const
Interface Category:
API.
Purpose:
- Subtracts the components of the specified color from this TRGBColor.
- Subtracts the specified scalar from each component of this TRGBColor.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const TRGBColor & 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: TRGBColor::operator*
- TRGBColor operator * (const float aScalar) const
- TRGBColor operator * (const TRGBColor & aColor2) const
Interface Category:
API.
Purpose:
- Multiplies each component of this TRGBColor by the specified scalar.
- Multiplies the components of this TRGBColor by the components of the specified color.
Calling Context:
- Call this operator directly.
- Call this operator directly.
Parameters:
- const float aScalar -The multiplier.
- const TRGBColor & 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: TRGBColor::operator/=
TRGBColor & operator /= (const float aScalar)
Interface Category:
API.
Purpose:
Divides the components of this TRGBColor 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: TRGBColor::operator+=
- TRGBColor & operator += (const float aScalar)
- TRGBColor & operator += (const TRGBColor & aColor2)
Interface Category:
API.
Purpose:
- Adds the specified scalar to the components of this TRGBColor and assigns the new values to the respective components.
- Adds the specified colors to the components of this TRGBColor 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 TRGBColor & 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: TRGBColor::operator-=
- TRGBColor & operator -=(const float aScalar)
- TRGBColor & operator -=(const TRGBColor & aColor2)
Interface Category:
API.
Purpose:
- Subtracts the specified scalar from the components of this TRGBColor and assigns the new values to the respective components.
- Subtracts the specified scalar from the components of this TRGBColor 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 TRGBColor & 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: TRGBColor::operator*=
TRGBColor & operator *= (const float aScalar)
Interface Category:
API.
Purpose:
Multiplies the components of this TRGBColor 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: TRGBColor::operator/
TRGBColor operator / (const float aScalar) const
Interface Category:
API.
Purpose:
Divides each component of this TRGBColor 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:
The values of the components are not clamped to the range 0.0 <= N <= 1.0.
Member Function: TRGBColor::FuzzyCompare
- bool FuzzyCompare (const TRGBColor & aRGBColor, float acceptableErrorPerComponentt =0.0001) const
- bool FuzzyCompare (const TRGBColor & aRGBColor, float errOpacity, float errRed, float errGreen, float errBlue) const
Interface Category:
API.
Purpose:
- Compares this TRGBColor 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 TRGBColor 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 TRGBColor & aRGBColor -The color that is compared to this one.
- float acceptableErrorPerComponentt =0.00011 -The tolerance with which the two colors are compared.
- const TRGBColor & aRGBColor -The that is compared to this color.
- float errOpacity -The tolerance with which the opacities of the two colors are compared.
- float errRed -The tolerance with which the red components of the two colors are compared.
- float errGreen -The tolerance with which the green components of the two colors are compared.
- float errBlue -The tolerance with which the blue 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: TRGBColor::LinearInterpolate
void LinearInterpolate (const float Weight, const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Makes a weighted linear interpolation of each component of this TRGBColor. The interpolation is returned in this color.
The interpolation that is done for each component is (using red as an example) given by red1 =red1 + (red2 -red1) * aWeight.
Calling Context:
Call this function directly.
Parameters:
- const float Weight -The weight to use.
- const TRGBColor & Color2 -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: TRGBColor::AddAndPin
void AddAndPin (const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Adds the specified color to this TRGBColor and then clamps the resulting values of the components.
Calling Context:
Call this function directly.
Parameters:
- const TRGBColor & Color2 -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: TRGBColor::SubtractAndPin
void SubtractAndPin (const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Subtracts the specified color from this TRGBColor 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: TRGBColor::Maximum
void Maximum (const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Determines the maximum of individual components of this TRGBColor and the specified color. It sets the components of this color to the resulting maximum values.
Calling Context:
Call this function directly.
Parameters:
- const TRGBColor & Color2 -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: TRGBColor::Minimum
void Minimum (const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Determines the minimum of individual components of this TRGBColor and the specified color. It sets the components of this color to the resulting minimum values.
Calling Context:
Call this function directly.
Parameters:
- const TRGBColor & Color2 -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: TRGBColor::Blend
void Blend (const TRGBColor & Color2)
Interface Category:
API.
Purpose:
Averages the individual components of the two colors and returns them in this TRGBColor.
Calling Context:
Call this function directly.
Parameters:
- const TRGBColor & Color2 -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: TRGBColor::Invert
void Invert ()
Interface Category:
API.
Purpose:
Inverts this TRGBColor.
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: TRGBColor::Clamp
void Clamp ()
Interface Category:
API.
Purpose:
Clamps the components of this TRGBColor 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: TRGBColor::Scale
void Scale ()
Interface Category:
API.
Purpose:
Scales this TRGBColor 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: TRGBColor::TemporaryTypeID
virtual TemporaryColorClassID TemporaryTypeID () const
Interface Category:
API.
Purpose:
Returns TColor::kRGBColor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns TColor::kRGBColor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TRGBColor::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: TRGBColor::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 ~ TRGBColor ()
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: TRGBColor::ClampOpacity
void ClampOpacity ()
Interface Category:
API.
Purpose:
Pins the opacity of this TRGBColor 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: TRGBColor::SetOpacity
void SetOpacity (GIntensity opacity =1.0)
Interface Category:
API.
Purpose:
Sets the opacity of this TRGBColor 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: TRGBColor::GetClampedOpacity
GIntensity GetClampedOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TRGBColor 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: TRGBColor::GetOpacity
GIntensity GetOpacity () const
Interface Category:
API.
Purpose:
Returns the opacity of this TRGBColor.
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.