Class: TGraySubtractiveTransferMode

Declaration: GrayTransferModes.h

Taxonomy Categories:

Member Functions:

TGraySubtractiveTransferMode
~TGraySubtractiveTransferMode
GetResultingColor
GetSubtractiveResult
operator=
operator>>=
operator<<=
TemporaryTypeID

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TGraySubtractiveTransferMode 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 destination's grayscale value minus the source's. (The source and destination need not be grayscale colors, but the resulting color is always a gray.) Similarly, the transparency value of the result is that of the destination minus that of the source. If the result of a subtraction is a negative number, the value is set to zero instead.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGraySubtractiveTransferMode::TGraySubtractiveTransferMode

TGraySubtractiveTransferMode ()
TGraySubtractiveTransferMode (const TGraySubtractiveTransferMode &)

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

virtual ~ TGraySubtractiveTransferMode ()

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

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

Interface Category:

API.

Purpose:

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

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The color to be subtracted.
const TColor & destColor -The original destination color.
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: TGraySubtractiveTransferMode::GetSubtractiveResult

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

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TGrayColor & sourceColor -The color to be subtracted.
const TGrayColor & destColor -The original destination color.
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: TGraySubtractiveTransferMode::operator=

TGraySubtractiveTransferMode & operator =(const TGraySubtractiveTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TGraySubtractiveTransferMode & 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: TGraySubtractiveTransferMode::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: TGraySubtractiveTransferMode::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: TGraySubtractiveTransferMode::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 kGraySubtractiveTransferMode.

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.