Class: TRGBTransparentTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

TRGBTransparentTransferMode
~TRGBTransparentTransferMode
GetTransparentColor
GetResultingColor
GetTransparentResult
operator=
operator>>=
operator<<=
TemporaryTypeID

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TRGBTransparentTransferMode is a concrete class, derived from TTransferMode, that generates a color based on a source color, a destination color, and a reference transparent color. If the source color is the same as the transparent color, the result is the same color as the destination; otherwise, the result is the same as the source color. The comparison of the source to the transparent color is made in the RGB color space, and the two colors' alpha (transparency) values must also match. (The source and destination colors need not be TRGBColors, and the resulting color is converted from RGB to the specified color space.) This transfer mode is different from most of the other RGB transfer modes, in that the transfer mode itself stores a TRGBColor, the transparent color. The color is specified as an argument to a constructor, and can be retrieved with TRGBTransparentTransferMode::GetTransparentColor.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRGBTransparentTransferMode::TRGBTransparentTransferMode

TRGBTransparentTransferMode ()
TRGBTransparentTransferMode (const TRGBColor & theColor)
TRGBTransparentTransferMode (const TRGBTransparentTransferMode &)

Interface Category:

API.

Purpose:

Default constructor. The transparent color is undefined.
Constructor to set the transparent color.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TRGBColor & theColor -The color to be considered transparent.
const TRGBTransparentTransferMode & -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: TRGBTransparentTransferMode::~TRGBTransparentTransferMode

virtual ~ TRGBTransparentTransferMode ()

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: TRGBTransparentTransferMode::GetTransparentColor

TRGBColor GetTransparentColor () const

Interface Category:

API.

Purpose:

Returns the value of the transparent color held by this object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a TRGBColor that was set in the constructor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBTransparentTransferMode::GetResultingColor

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

Interface Category:

API.

Purpose:

If the source color is equal to the internally stored transparency color of this object, replaces the source color with the destination color. If the source color is not equal to the transparency color, the resulting color is set to the source color. All parameters are passed as TColor objects.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to compare with the transparent color.
const TColor & destColor -The destination color to show through.
TColor & resultingColor -The resulting, modified source color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBTransparentTransferMode::GetTransparentResult

void GetTransparentResult (const TRGBColor & sourceColor, const TRGBColor & destColor, TRGBColor & resultingColor) const

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TRGBColor & sourceColor -The source color to compare with the transparent color.
const TRGBColor & destColor -The destination color to show through.
TRGBColor & resultingColor -The resulting, modified source color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBTransparentTransferMode::operator=

TRGBTransparentTransferMode & operator =(const TRGBTransparentTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBTransparentTransferMode & 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: TRGBTransparentTransferMode::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: TRGBTransparentTransferMode::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: TRGBTransparentTransferMode::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 kRGBTransparentTransferMode.

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.