Class: THLSReplaceSaturationTransferMode

Declaration: HLSTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

THLSReplaceSaturationTransferMode is a concrete class, derived from TTransferMode, for substituting the saturation component in the HLS (hue-lightness-saturation) color space. This transfer mode sets the resulting color's saturation to that of the source. The hue, lightness, and alpha are those of the destination. (The source and destination need not be THLSColors, and the resulting color is converted from HLS to the specified color space.)

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: THLSReplaceSaturationTransferMode::THLSReplaceSaturationTransferMode

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const THLSReplaceSaturationTransferMode & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::~THLSReplaceSaturationTransferMode

virtual ~ THLSReplaceSaturationTransferMode ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::GetResultingColor

virtual void GetResultingColor (const TColor & sourceColor, const TColor & destColor, TColor & resultingColor) const

Interface Category:

API.

Purpose:

Transforms the destination TColor to a color that has the same saturation value as the source color, but with the original hue, lightness, and alpha values. All arguments are passed as TColors.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color with the saturation value to use.
const TColor & destColor -The destination color to be modified.
TColor & resultingColor -The modified destination color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::GetReplaceSaturationResult

static void GetReplaceSaturationResult (const THLSColor & sourceColor, const THLSColor & destColor, THLSColor & resultingColor)

Interface Category:

API.

Purpose:

Transforms the destination THLSColor to a color that has the same saturation value as the source color, but with the original hue, lightness, and alpha values. All arguments are passed as THLSColors.

Calling Context:

Call this function directly.

Parameters:

const THLSColor & sourceColor -The source color with the saturation value to use.
const THLSColor & destColor -The destination color to be modified.
THLSColor & resultingColor -The modified destination color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::operator=

THLSReplaceSaturationTransferMode & operator =(const THLSReplaceSaturationTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const THLSReplaceSaturationTransferMode & source -The object to be copied.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream that the object streams itself 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:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream that the object streams itself 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:

Not multithread safe.

Other Considerations:

None.

Member Function: THLSReplaceSaturationTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of transfer mode this class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID with value kHLSReplaceSatTransferMode.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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