Class: TNoiseProcedureMap

Declaration: MapUtilities.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TProcedureMap

Inherited By:

TMarbleProcedureMap TWrinkleProcedureMap

Purpose:

Derived from TProcedureMap, TNoiseProcedureMap is an abstract base class for procedure maps that use pseudo-random numbers to create textures. The pseudo-random numbers are generated by a TGrafNoise object, which is specified with SetGrafNoise. Derived classes define how the noise is used.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TNoiseProcedureMap::~TNoiseProcedureMap

virtual ~ TNoiseProcedureMap ()

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: TNoiseProcedureMap::SetGrafNoise

virtual void SetGrafNoise (const TGrafNoise & noise)

Interface Category:

API.

Purpose:

Sets the noise generator to the specified TGrafNoise object. This is a pure virtual function that must be overridden by the 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: TNoiseProcedureMap::GetValue

virtual void GetValue (TShadingSample & shadingSample, const TSceneState & sceneState) const

Interface Category:

API.

Purpose:

Returns, in its TShadingSample argument, the modified shading information for the surface point specified in the shading sample. This is a pure virtual function that must be overridden by the 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: TNoiseProcedureMap::GetRequiredShadingVariables

virtual void GetRequiredShadingVariables (TShadingUsageVariables & variables) const

Interface Category:

API.

Purpose:

Returns, in its TShadingUsageVariables argument, a list of the TShadingSample fields that are required by the shader. This is a virtual function that is designed to be overridden by derived classes. However, as a default case it does return the list of variables needed for the WorldPosition only (that is, only the position variable is required).

Calling Context:

Do not call this function directly, it is designed to be overridden by a derived class.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNoiseProcedureMap::GetModifiedShadingVariables

virtual void GetModifiedShadingVariables (TShadingUsageVariables & variables) const

Interface Category:

API.

Purpose:

Returns, in its TShadingUsageVariables argument, a list of the TShadingSample fields that are modified by the shader. This is a pure virtual function that must be overridden by the 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: TNoiseProcedureMap::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: TNoiseProcedureMap::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: TNoiseProcedureMap::TNoiseProcedureMap

  1. TNoiseProcedureMap ()
  2. TNoiseProcedureMap (const TNoiseProcedureMap & map)

Interface Category:

API.

Purpose:

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

Calling Context:

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

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNoiseProcedureMap::operator=

TNoiseProcedureMap & operator =(const TNoiseProcedureMap & source)

Interface Category:

API.

Purpose:

Assignment operator. This is a protected member function that must be overridden by a derived class.

Calling Context:

Do not call this function directly, except from within the operator

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.