Class: TSrcCopyTransferMode

Declaration: TransferModes.h

Taxonomy Categories:

Member Functions:

TSrcCopyTransferMode
~TSrcCopyTransferMode
GetResultingColor
operator=
operator>>=
operator<<=
TemporaryTypeID
GetBaseTemporaryTypeID

Interface Category:

API.

Inherits From:

TSrcActiveTransferMode

Inherited By:

None.

Purpose:

TSrcCopyTransferMode is a concrete class, derived from TSrcActiveTransferMode. It implements the source copy transfer mode, which simply copies the source color to the destination, without regard to the original destination color.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSrcCopyTransferMode::TSrcCopyTransferMode

TSrcCopyTransferMode ()
TSrcCopyTransferMode (const TSrcCopyTransferMode &)

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

virtual ~ TSrcCopyTransferMode ()

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: TSrcCopyTransferMode::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:

Returns, in the specified parameter, the TColor that results when the source copy transfer mode is applied using the specified source color. The resulting color is always equal to the source color, regardless of the destination color.
Returns, in the specified parameter, the TColor that results when the source copy transfer mode is applied using the specified source color. The resulting color is always equal to the source color.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TColor & sourceColor -The color to be applied using this transfer mode.
const TColor & destColor -The destination color (not used in this mode).
TColor & resultingColor -The resulting color after application of the transfer mode.
const TColor & sourceColor -The color to be applied using this transfer mode.
TColor & resultingColor -The resulting color after application of this transfer mode.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSrcCopyTransferMode::operator=

TSrcCopyTransferMode & operator =(const TSrcCopyTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TSrcCopyTransferMode & 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: TSrcCopyTransferMode::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: TSrcCopyTransferMode::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: TSrcCopyTransferMode::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 of value kSrcCopyTransferMode.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSrcCopyTransferMode::GetBaseTemporaryTypeID

virtual ETransferModeClassID GetBaseTemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of transfer mode this class' parent class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID of value kSrcCopyTransferMode.

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.