Class: TGrayInvertDstTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDstActiveTransferMode

Inherited By:

None.

Purpose:

TGrayInvertDstTransferMode is a concrete class, derived from TDstActiveTransferMode, for inverting a grayscale color. This transfer mode determines the destination color's grayscale value, subtracts it from 1.0, and replaces the destination with it. This transfer mode is suitable for real-time interactions. Once 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: TGrayInvertDstTransferMode::TGrayInvertDstTransferMode

TGrayInvertDstTransferMode ()
TGrayInvertDstTransferMode (const TGrayInvertDstTransferMode &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TGrayInvertDstTransferMode & -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: TGrayInvertDstTransferMode::~TGrayInvertDstTransferMode

virtual ~ TGrayInvertDstTransferMode ()

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: TGrayInvertDstTransferMode::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 the destination color, destColor into the inverted, grayscale value of the original destination color. The resulting TColor is returned in resultingColor. The variable sourceColor is ignored.
Converts the destination color, destColor into the inverted, grayscale value of the original destination color. The resulting TColor is returned in resultingColor.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -Ignored by this function
const TColor & destColor -The color to be converted.
TColor & resultingColor -The converted color.
const TColor & destColor -The color to be converted.
TColor & resultingColor -The converted color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayInvertDstTransferMode::GetInvertDstResult

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

Interface Category:

API.

Purpose:

Converts the destination color, destColor into the inverted, grayscale value of the original destination color. The resulting TGrayColor is returned in resultingColor

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & destColor -The color to be converted.
TGrayColor & resultingColor -The converted TGrayColor.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayInvertDstTransferMode::operator=

TGrayInvertDstTransferMode & operator =(const TGrayInvertDstTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGrayInvertDstTransferMode & 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: TGrayInvertDstTransferMode::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: TGrayInvertDstTransferMode::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: TGrayInvertDstTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of TransferMode this class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID with value kGrayInvertDstTransferMode.

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.