Class: TRGBInvertDstTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDstActiveTransferMode

Inherited By:

None.

Purpose:

TRGBInvertDstTransferMode is a concrete class, derived from TDstActiveTransferMode, for inverting a color in the RGB color space. This transfer mode determines the destination color's red, green, and blue components, subtracts each value from 1.0, and replaces the destination with the inverted color. (The original destination need not be a TRGBColor, and the resulting color is converted from RGB to the specified color space.) This transfer mode is suitable for real-time interactions. After you apply the transfer mode to an area, the original contents of that area can be restored by applying the operation again.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRGBInvertDstTransferMode::TRGBInvertDstTransferMode

TRGBInvertDstTransferMode ()
TRGBInvertDstTransferMode (const TRGBInvertDstTransferMode &)

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 TRGBInvertDstTransferMode & -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: TRGBInvertDstTransferMode::~TRGBInvertDstTransferMode

virtual ~ TRGBInvertDstTransferMode ()

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: TRGBInvertDstTransferMode::GetResultingColor

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

Interface Category:

API.

Purpose:

Converts a destination color into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The destination color is ignored. The resulting color is returned as a TColor.
Converts a destination color into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TColor.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -Not used by this function.
const TColor & destColor -The destination color to be inverted.
TColor & resultingColor -The resulting, inverted destination color.
const TColor & destColor -The destination color to be inverted.
TColor & resultingColor -The resulting, inverted destination color. Return Value:
None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBInvertDstTransferMode::GetInvertDstResult

static void GetInvertDstResult (const TRGBColor & destColor, TRGBColor & resultingColor)

Interface Category:

API.

Purpose:

Converts a destination TRGBColor into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TRGBColor.

Calling Context:

Call this function directly.

Parameters:

const TRGBColor & destColor -The destination color to be inverted.
TRGBColor & resultingColor -The resulting, inverted color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBInvertDstTransferMode::operator=

TRGBInvertDstTransferMode & operator =(const TRGBInvertDstTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBInvertDstTransferMode & 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: TRGBInvertDstTransferMode::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: TRGBInvertDstTransferMode::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: TRGBInvertDstTransferMode::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 kRGBInvertDstTransferMode.

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.