Class: TSrcActiveTransferMode

Declaration: TransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

TCMYKBlackToGrayTransferMode TCMYKCyanToGrayTransferMode TCMYKMagentaToGrayTransferMode TCMYKYellowToGrayTransferMode TGrayFilteredReplaceTransferMode TGrayInvertSrcTransferMode TRGBInvertSrcTransferMode TSrcCopyTransferMode

Purpose:

TSrcActiveTransferMode is an abstract base class, derived from TTransferMode, used for transfer modes that depend only upon the source color, not upon the destination.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSrcActiveTransferMode::~TSrcActiveTransferMode

virtual ~ TSrcActiveTransferMode ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSrcActiveTransferMode::GetResultingColor

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

Interface Category:

API.

Purpose:

  1. Returns, in the specified parameter, the TColor that results when the particular source transfer mode is applied using the specified source color. This function is undefined for this abstract class. It is intended to be overridden in a derived class.
  2. Returns, in the specified parameter, the TColor that results when the particular source transfer mode is applied using the specified source color. This function is undefined for this abstract class.

Calling Context:

  1. Because this is a pure virtual function, it cannot be called in this form. Derived classes must override it. When using derived classes, you can directly call their implementation of this function whenever you need to determine the color resulting from a transfer such as a compositing operation.
  2. Because this is a pure virtual function, it cannot be called in this form. Derived classes must override it. When using derived classes, you can directly call their implementation of this function whenever you need to determine the color resulting from a transfer such as a compositing operation.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSrcActiveTransferMode::operator=

TSrcActiveTransferMode & operator =(const TSrcActiveTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

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: TSrcActiveTransferMode::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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: TSrcActiveTransferMode::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

  1. TSrcActiveTransferMode ()
  2. TSrcActiveTransferMode (const TSrcActiveTransferMode &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called by the stream-in operators and by the constructors of derived classes. Because this is a protected member function, do not call this function directly.
  2. Called by derived classes to copy an object. Because this is a protected member function, do not call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TSrcActiveTransferMode is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TSrcActiveTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of transfer mode this class represents.

Calling Context:

Abstract base class. Do not call this function directly.

Parameters:

Return Value:

Returns an ETransferModeClassID value of type kSrcActiveTransferMode. Derived classes return the appropriate value for their particular class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSrcActiveTransferMode::GetBaseTemporaryTypeID

virtual ETransferModeClassID GetBaseTemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of TransferMode this class' parent class represents. Because this is an abstract class derived directly from TTransferMode, the return value is set to this class type, kSrcActiveTransferMode.

Calling Context:

Abstract base class. Do not call this function directly.

Parameters:

Return Value:

Returns an ETransferModeClassID value of type kSrcActiveTransferMode. Derived classes return the appropriate value for their particular class.

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.
Copyright©1995 Taligent,Inc. All rights reserved.