Class: TDstActiveTransferMode

Declaration: TransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

TInvertTransferMode TGrayInvertDstTransferMode TRGBInvertDstTransferMode

Purpose:

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

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

Provided classes are TGrayInvertDstTransferMode and TRGBInvertDstTransferMode.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDstActiveTransferMode::~TDstActiveTransferMode

virtual ~ TDstActiveTransferMode ()

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

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

Calling Context:

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

const TColor & sourceColor -The source color (not used in this transfer mode).
const TColor & destColor -The destination color to be applied using this transfer mode.
TColor & resultingColor -The resulting color after application of the transfer mode.
const TColor & destColor -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: TDstActiveTransferMode::operator=

TDstActiveTransferMode & operator =(const TDstActiveTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TDstActiveTransferMode & 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: TDstActiveTransferMode::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: TDstActiveTransferMode::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: TDstActiveTransferMode::TDstActiveTransferMode

TDstActiveTransferMode ()
TDstActiveTransferMode (const TDstActiveTransferMode &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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.
Called by derived classes to copy an object. Because this is a protected member function, do not call this function directly.

Parameters:

Takes no parameters.
const TDstActiveTransferMode & -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: TDstActiveTransferMode::TemporaryTypeID

virtual ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the type of transfer mode this class represents.

Calling Context:

Abstract class. Do not call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID of value kDstActiveTransferMode. Derived classes will 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: TDstActiveTransferMode::GetBaseTemporaryTypeID

virtual ETransferModeClassID GetBaseTemporaryTypeID () const

Interface Category:

API.

Purpose:

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

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID value of type kDstActiveTransferMode. 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.