RiTransferData

Encapsulate the data representing a transfer.

[ Rad | Source | Search | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

class RiTransferData
{
public:
// Constructors and assignment
RiTransferData();
RiTransferData(const RiTransferData &);
RiTransferData &operator=(const RiTransferData &);
// Accessors
void SetIrradiance(const RiSpectrum &energy, RiReal energyError);
void SetFormFactor(RiReal ff, RiReal ffError);
void SetVisibility(RiReal vis, RiReal visError);
void GetIrradiance(RiSpectrum &energy, RiReal &energyError) const;
void GetFormFactor(RiReal &ff, RiReal &ffError) const;
void GetVisibility(RiReal &vis, RiReal &visError) const;
RiSpectrum GetOccludedIrradiance() const;
RiReal GetOccludedFormFactor() const;
// Members
void operator+==(const RiTransferData &);
void operator*==(RiReal rhs);
void Clear();
bool IsEnergy();
protected:
}; // RiTransferData

DESCRIPTION

This class eliminates the messy problem of how to encapsulate objects that only compute form factors and objects that only compute energy transfered (sky object). All error and data is stored here. This makes it easier to change algorithms without changing quadrature strategies, as basic operation needed to do quadrature on this data are implemented in the class, and can be changed to compute things differently.

RiTransferData();

Default Constructor

    RiTransferData();

RiTransferData(const RiTransferData &);

 Copy Constructor

    RiTransferData(const RiTransferData &);

RiTransferData &operator=(const RiTransferData &);

 Assignment

    RiTransferData &operator=(const RiTransferData &);

void SetIrradiance(const RiSpectrum &energy, RiReal energyError);

 Set energy data

    void  SetIrradiance(const RiSpectrum &energy, RiReal energyError);

void SetFormFactor(RiReal ff, RiReal ffError);

 Set form factor data

    void  SetFormFactor(RiReal ff, RiReal ffError);

void SetVisibility(RiReal vis, RiReal visError);

 Set visibility data

    void  SetVisibility(RiReal vis, RiReal visError);

void GetIrradiance(RiSpectrum &energy, RiReal &energyError) const;

 Get energy data

    void  GetIrradiance(RiSpectrum &energy, RiReal &energyError) const;

void GetFormFactor(RiReal &ff, RiReal &ffError) const;

 Get form factor data

    void  GetFormFactor(RiReal &ff, RiReal &ffError) const;

void GetVisibility(RiReal &vis, RiReal &visError) const;

 Get visibility data

    void  GetVisibility(RiReal &vis, RiReal &visError) const;

RiSpectrum GetOccludedIrradiance() const;

 Get the estimated occluded irradiance

    RiSpectrum 	GetOccludedIrradiance() const;

RiReal GetOccludedFormFactor() const;

 Get the estimated occluded form factor

    RiReal 	GetOccludedFormFactor() const;

void operator+=(const RiTransferData &);

 accumulate the total (handle errors appropriately)

    void  operator+=(const RiTransferData &);

void operator*=(RiReal rhs);

 scale results (handle errors appropriately)

    void  operator*=(RiReal rhs);

void Clear();

 reset everything to zero

    void  Clear();

bool IsEnergy();

 does this hold energy?

    bool  IsEnergy();

All Members

public:
// Constructors and assignment
RiTransferData &operator=(const RiTransferData &);
// Accessors
void SetIrradiance(const RiSpectrum &energy, RiReal energyError);
void SetFormFactor(RiReal ff, RiReal ffError);
void SetVisibility(RiReal vis, RiReal visError);
void GetIrradiance(RiSpectrum &energy, RiReal &energyError) const;
void GetFormFactor(RiReal &ff, RiReal &ffError) const;
void GetVisibility(RiReal &vis, RiReal &visError) const;
RiSpectrum GetOccludedIrradiance() const;
RiReal GetOccludedFormFactor() const;
// Members
void operator+==(const RiTransferData &);
void operator*==(RiReal rhs);
void Clear();
bool IsEnergy();
protected:

Ancestors

Class does not inherit from any other class.

Descendants

Class is not inherited by any others.

Generated from source by the Cocoon utilities on Fri Feb 25 15:15:49 2000 .