Class: TCMYKMagentaToGrayTransferMode

Declaration: CMYKTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSrcActiveTransferMode

Inherited By:

None.

Purpose:

TCMYKMagentaToGrayTransferMode is a concrete class derived from TSrcActiveTransferMode, for converting the magenta component of a CMYK color to a grayscale value. This is useful for color separation applications.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TCMYKMagentaToGrayTransferMode::TCMYKMagentaToGrayTransferMode

TCMYKMagentaToGrayTransferMode ()
TCMYKMagentaToGrayTransferMode (const TCMYKMagentaToGrayTransferMode &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and directly.
Called to copy an object.

Parameters:

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

virtual ~ TCMYKMagentaToGrayTransferMode ()

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: TCMYKMagentaToGrayTransferMode::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 the magenta component of a given CMYK color and returns the grayscale equivalent. The destination color is ignored.
Converts the magenta component of a given CMYK color and returns the grayscale equivalent.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -The source color to be converted.
const TColor & destColor -Not used by this function.
TColor & resultingColor -The resulting grayscale color.
const TColor & sourceColor -The source color to be converted.
TColor & resultingColor -The resulting grayscale color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCMYKMagentaToGrayTransferMode::operator=

TCMYKMagentaToGrayTransferMode & operator =(const TCMYKMagentaToGrayTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCMYKMagentaToGrayTransferMode & source -The object whose contents are to be assigned to this object.

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: TCMYKMagentaToGrayTransferMode::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: TCMYKMagentaToGrayTransferMode::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: TCMYKMagentaToGrayTransferMode::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 kCMYKMagentaToGrayTransferMode.

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.