Class: TGrayFilteredReplaceTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSrcActiveTransferMode

Inherited By:

None.

Purpose:

TGrayFilteredReplaceTransferMode is a concrete class, derived from TSrcActiveTransferMode, for converting a color to grayscale. It takes the source color and filters it through grayscale space to yield the corresponding gray color. The destination color is ignored.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGrayFilteredReplaceTransferMode::TGrayFilteredReplaceTransferMode

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

virtual ~ TGrayFilteredReplaceTransferMode ()

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

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

Interface Category:

API.

Purpose:

Converts a color to grayscale. It takes the source color and filters it through grayscale space to yield the corresponding gray color. The destination color, destColor, is ignored.
Converts a color to grayscale. It takes the source color and filters it through grayscale space to yield the corresponding gray color.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -The color to be converted to gray scale.
const TColor & destColor -Ignored by this function.
TColor & resultingColor -The grayscale color corresponding to the sourceColor.
const TColor & sourceColor -The color to be converted to gray scale.
TColor & resultingColor -The grayscale color corresponding to the sourceColor.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayFilteredReplaceTransferMode::operator=

TGrayFilteredReplaceTransferMode & operator =(const TGrayFilteredReplaceTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGrayFilteredReplaceTransferMode & 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: TGrayFilteredReplaceTransferMode::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 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: TGrayFilteredReplaceTransferMode::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 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: TGrayFilteredReplaceTransferMode::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 kGrayFilteredTransferMode.

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.