Class: TShaderColorSpline

Declaration: ShaderColorSpline.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TRGBShaderColorSpline

Purpose:

TShaderColorSpline is an abstract base class for classes that return a color to the caller, based on a parameter from 0 to 1. The name of the class suggests that derived classes use parametric curves to implement the mathematical functions. For example, the derived class TRGBShaderColorSpline lets you specify three curves--one for determining the red component, one for green, and one for blue.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TShaderColorSpline::~TShaderColorSpline

virtual ~ TShaderColorSpline ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShaderColorSpline::GetColor

virtual void GetColor (GParametric val, TColor & retVal) const

Interface Category:

API.

Purpose:

Returns, in its TColor argument, the color corresponding to the specified parametric value. This is a pure virtual function and must be overridden by derived classes.

Calling Context:

Do not call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShaderColorSpline::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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: TShaderColorSpline::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

  1. TShaderColorSpline ()
  2. TShaderColorSpline (const TShaderColorSpline &)

Interface Category:

API.

Purpose:

  1. Default constructor. This is protected constructor that must be overridden by derived classes.
  2. Copy constructor. This is a protected constructor that must be overridden by derived classes.

Calling Context:

  1. Called by the stream-in operators. Do not call this function directly.
  2. Called to copy an object. Do not call this function directly, except from within the copy constructor of a derived object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TShaderColorSpline::operator=

TShaderColorSpline & operator =(const TShaderColorSpline & source)

Interface Category:

API.

Purpose:

Assignment operator. This is a protected member function, designed to be overridden by derived classes.

Calling Context:

Do not call this function directly, except from the operator =function of a derived class.

Parameters:

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.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.