Class: TRGBSubtractiveTransferMode

Declaration: RGBTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TRGBSubtractiveTransferMode is a concrete class, derived from TTransferMode, that compares the RGB values of a source color and a destination color in order to generate a resulting color. Each of the resulting red, green, and blue values is equal to the corresponding value of the destination minus that of the source. (The source and destination colors need not be TRGBColors, and the resulting color is converted from RGB to the specified color space.) 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: TRGBSubtractiveTransferMode::TRGBSubtractiveTransferMode

TRGBSubtractiveTransferMode ()
TRGBSubtractiveTransferMode (const TRGBSubtractiveTransferMode &)

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

virtual ~ TRGBSubtractiveTransferMode ()

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

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

Interface Category:

API.

Purpose:

Returns a color whose individual RGB and transparency components are the result of subtracting the source's components from the destination's components. Negative components are set to 0.0. All parameters are passed as TColor objects.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The source color to subtract.
const TColor & destColor -The destination color to subtract from.
TColor & resultingColor -The resulting, subtracted color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBSubtractiveTransferMode::GetSubtractiveResult

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

Interface Category:

API.

Purpose:

Calling Context:

Call this function directly.

Parameters:

const TRGBColor & sourceColor -The source color to subtract.
const TRGBColor & destColor -The destination color to subtract from.
TRGBColor & resultingColor -The resulting, subtracted color.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRGBSubtractiveTransferMode::operator=

TRGBSubtractiveTransferMode & operator =(const TRGBSubtractiveTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRGBSubtractiveTransferMode & 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: TRGBSubtractiveTransferMode::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: TRGBSubtractiveTransferMode::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: TRGBSubtractiveTransferMode::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 kRGBSubtractiveTransferMode.

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.