Class: TMinZDepthComposite

Declaration: TransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTransferMode

Inherited By:

None.

Purpose:

TMinZDepthComposite is a concrete class, derived from TTransferMode. The TMinZDepthComposite class provides a compositing algorithm that uses the depth values in a z-Buffer to replace the destination color when the source z value is less than the destination z value. This transfer mode is independent of a color space, and is used to assemble a 3-D scene from individually rendered elements. For example, you can take two 3-D rendered objects and copy only the unobscured portions of one object onto the other.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMinZDepthComposite::TMinZDepthComposite

TMinZDepthComposite ()
TMinZDepthComposite (const TMinZDepthComposite &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators. You can also call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TMinZDepthComposite & -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: TMinZDepthComposite::~TMinZDepthComposite

virtual ~ TMinZDepthComposite ()

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

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

Interface Category:

API.

Purpose:

Returns, in the specified parameter, the TColor that results when the MinZDepth transfer mode is applied to the destination color using the specified source color.

Calling Context:

Call this function directly.

Parameters:

const TColor & sourceColor -The color to be applied using this transfer mode.
const TColor & destColor -The destination color.
TColor & resultingColor -The resulting color after application of the transfer mode.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMinZDepthComposite::operator=

TMinZDepthComposite & operator =(const TMinZDepthComposite & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TMinZDepthComposite & 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: TMinZDepthComposite::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: TMinZDepthComposite::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: TMinZDepthComposite::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 of value kMinZDepthComposite.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMinZDepthComposite::GetBaseTemporaryTypeID

virtual ETransferModeClassID GetBaseTemporaryTypeID () const

Interface Category:

API.

Purpose:

Returns the transfer mode that the class' parent class represents.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an ETransferModeClassID of value kCustomTransferMode.

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.