ShadeOutput Class Reference

#include <ShadeContext.h>

Inheritance diagram for ShadeOutput:

Public Member Functions
CoreExport void	MixIn (ShadeOutput &a, float f)
	ShadeOutput ()
	ShadeOutput (int nEle)
void	Reset (int nEle=-1)
CoreExport ShadeOutput *	Clone ()
int	NewElementVal ()
int	NElementVals ()
void	SetNElements (int n)
AColor	ElementVal (int n)
void	SetElementVal (int n, AColor color)
void	AccumElementVal (int n, AColor color)
void	Sum (ShadeOutput *pSample)
void	Scale (float x)
void	SumClr (ShadeOutput *pSample)
ShadeOutput &	operator+= (ShadeOutput &a)
ShadeOutput &	operator*= (Color x)
ShadeOutput &	operator= (const ShadeOutput &a)
Public Member Functions inherited from BaseInterfaceServer
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport int	NumInterfaces () const
virtual UtilExport BaseInterface *	GetInterfaceAt (int i) const
virtual UtilExport	~BaseInterfaceServer ()
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Attributes
ULONG	flags
Color	c
Color	t
float	ior
int	gbufId
int	nElements
AColor	elementVals [N_MAX_RENDER_ELEMENTS]

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Protected Attributes inherited from BaseInterfaceServer
Tab< BaseInterface * >	interfaces

Detailed Description

See also

Class ShadeContext, Class Color.

Description:

An instance of this class is a data member of the ShadeContext. This is used to contain the computed color and transparency of the pixel being shaded by a material. All methods of this class are implemented by the system.

Data Members:

ULONG flags;

These flags are not currently used.

Color c;

Shaded color of the pixel.

Color t;

Transparency of the pixel.

float ior;

Index of refraction of the pixel.

int gbufId;

The G-buffer ID. This allows the MixIn() method to pick the id of the material which was blended in the highest proportion.

Constructor & Destructor Documentation

ShadeOutput() [1/2]

ShadeOutput ( )

inline

:nElements(0), flags(0), gbufId(0){};

ShadeOutput() [2/2]

ShadeOutput ( int  nEle )

inline

:flags(0), gbufId(0){ nElements = nEle; }

Member Function Documentation

MixIn()

CoreExport void MixIn	(	ShadeOutput &	a,
		float	f
	)

Remarks

This method is used to blend the output of two texmaps, for example, in the Mix texmap. The function is as follows:

void ShadeOutput::MixIn(ShadeOutput &a, float f)
{
    if (f<=0.0f) {
        (*this) = a;
        return;
    }
    else if (f>=1.0f) {
        return;
    }
    else {
        float s = 1.0f - f;
        flags |= a.flags;
        c = s*a.c + f*c;
        t = s*a.t + f*t;
        ior = s*a.ior + f*ior;
        if (f<=0.5f) gbufId = a.gbufId;
    }
}

This does a blend of a with (*this). This blend is applied to the color, transparency, and index of refraction. The flags of are OR'ed together.

Parameters:

ShadeOutput& a

The output of the texmap to blend in.

float f

The amount to blend in, i.e.:

a.MixIn(b, 1.0f) results in 100% of a and none of b.

Reset()

void Reset ( int  nEle = -1 )

inline

Remarks

Implemented by the System.

This method resets the data member such that: c is set to black, t is set to black, ior is set to 1.0, gbufId is set to 0, and the flags are set to 0.

Parameters:

int n = -1

By supplying a negative value this method will clear elements but leave the number of elements unchanged.

            { 
                 flags = 0;
                 gbufId = 0;
                 c.Black(); t.Black(); ior = 1.0f;
                 // clear nEle's worth of render elements
                 if (nEle >= 0)
                        nElements = nEle;
                 for( int i=0; i < nElements; ++i )
                        elementVals[i].r = elementVals[i].g =
                             elementVals[i].b = elementVals[i].a = 0.0f;
            }

Clone()

CoreExport ShadeOutput * Clone

(

)

NewElementVal()

int NewElementVal ( )

inline

                               {
                 DbgAssert((nElements+1)<N_MAX_RENDER_ELEMENTS); 
                 return nElements++; 
            }

NElementVals()

int NElementVals ( )

inline

{ return nElements; }

SetNElements()

void SetNElements ( int  n )

inline

                                      {
                 DbgAssert( n>=0 && n<N_MAX_RENDER_ELEMENTS); 
                 nElements = n;
            }

ElementVal()

AColor ElementVal ( int  n )

inline

                                      { 
                 DbgAssert( n>=0 && n<N_MAX_RENDER_ELEMENTS); 
                 return elementVals[n]; 
            }

SetElementVal()

void SetElementVal ( int  n, AColor  color  )

inline

                                                     { 
                 DbgAssert( n>=0 && n<N_MAX_RENDER_ELEMENTS); 
                 elementVals[n] = color;
            }

AccumElementVal()

void AccumElementVal ( int  n, AColor  color  )

inline

                                                      {
                 DbgAssert( n>=0 && n<N_MAX_RENDER_ELEMENTS); 
                 elementVals[n] += color;
            }

Sum()

void Sum ( ShadeOutput *  pSample )

inline

                                            {
                 c += pSample->c; t += pSample->t;
                 for( int i = 0; i < nElements; ++i )
                        elementVals[i] += pSample->elementVals[i];
            }

Scale()

void Scale ( float  x )

inline

                                 {
                 c *= x; t *= x;
                 for( int i = 0; i < nElements; ++i )
                        elementVals[i] *= x;
            }

SumClr()

void SumClr ( ShadeOutput *  pSample )

inline

                                               {
                 c += pSample->c; 
                 for( int i = 0; i < nElements; ++i ){
                        elementVals[i].r += pSample->elementVals[i].r;
                        elementVals[i].g += pSample->elementVals[i].g;
                        elementVals[i].b += pSample->elementVals[i].b;
                 }
            }

operator+=()

ShadeOutput & operator+= ( ShadeOutput &  a )

inline

                                                       {
                 c += a.c;  
                 t += a.t; 
                 for( int i = 0; i < nElements; ++i )
                        elementVals[i] += a.elementVals[i];
                 return *this;
            }

operator*=()

ShadeOutput & operator*= ( Color  x )

inline

                                                {
                 c *= x; // t *= x; 
                 AColor ac( x );
                 ac.a = Intens( x );
                 for( int i = 0; i < nElements; ++i )
                        elementVals[i] *= ac;
                 return *this;
            }

operator=()

ShadeOutput & operator= ( const ShadeOutput &  a )

inline

                                                            {
                 flags = a.flags;
                 c = a.c; t = a.t; 
                 ior = a.ior;
                 gbufId = a.gbufId;
                 nElements = a.nElements;
                 for( int i = 0; i < nElements; ++i )
                        elementVals[i] = a.elementVals[i];
                 return *this;
            }

Member Data Documentation

flags

ULONG flags

c

Color c

t

Color t

ior

float ior

gbufId

int gbufId

nElements

int nElements

elementVals

AColor elementVals[N_MAX_RENDER_ELEMENTS]