Class: TGrayAdditiveTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TGrayAdditiveTransferMode is a concrete class, derived from TTransferMode, that yields a grayscale result given a source color and a destination color. The resulting grayscale value is equal to the sum of the destination's and source's grayscale values. (The source and destination need not be grayscale colors, but the resulting color is always a gray.) The transparency values are similarly added. If the result of an addition is greater than 1.0, the value is set to 1.0 instead.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGrayAdditiveTransferMode::TGrayAdditiveTransferMode

TGrayAdditiveTransferMode ()
TGrayAdditiveTransferMode (const TGrayAdditiveTransferMode &)

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

virtual ~ TGrayAdditiveTransferMode ()

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

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

Interface Category:

API.

Purpose:

Returns the grayscale value equal to the sum of the destination's and source's grayscale values. Similarly, the transparency value is equal to the sum of the destination's and source's transparency value. All parameters are specified as TColor objects, even though only the grayscale values are used.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -One of the colors to be added.
const TColor & destColor -The other color to be added.
TColor & resultingColor -The resulting grayscale color, returned in a TColor object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayAdditiveTransferMode::GetAdditiveResult

static void GetAdditiveResult (const TGrayColor & sourceColor, const TGrayColor & destColor, TGrayColor & resultingColor)

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & sourceColor -One of the grayscale colors to be added.
const TGrayColor & destColor -The other grayscale color to be added.
TGrayColor & resultingColor -The resulting grayscale color, returned in a TGrayColor object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrayAdditiveTransferMode::operator=

TGrayAdditiveTransferMode & operator =(const TGrayAdditiveTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGrayAdditiveTransferMode & 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: TGrayAdditiveTransferMode::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: TGrayAdditiveTransferMode::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: TGrayAdditiveTransferMode::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 kGrayAdditiveTransferMode.

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.