RixBXLobeSampled Struct Reference

This struct represents the characteristics of just one lobe of a bxdf. More...

#include <RixBxdfLobe.h>

Classes
struct	Bitfield
union	Converter

Public Member Functions
PRMAN_INLINE	RixBXLobeSampled ()
	Constructor; initializes the valid bit to false. More...
PRMAN_INLINE	RixBXLobeSampled (unsigned short serialized)
	Constructor; initializes from serialization as unsigned short. More...
PRMAN_INLINE	RixBXLobeSampled (bool discrete, bool specular, bool reflect, bool user, unsigned char lpeId, unsigned char lobeId)
	Constructor; sets all fields and sets the valid bit to true. More...
PRMAN_INLINE bool	CompareLobeID (RixBXLobeSampled const &rhs) const
PRMAN_INLINE bool	GetValid () const
PRMAN_INLINE bool	GetDiscrete () const
PRMAN_INLINE bool	GetSolidAngle () const
PRMAN_INLINE bool	GetDiffuse () const
PRMAN_INLINE bool	GetSpecular () const
PRMAN_INLINE bool	GetReflect () const
PRMAN_INLINE bool	GetTransmit (bool *entering=NULL) const
PRMAN_INLINE bool	GetEntering () const
PRMAN_INLINE bool	GetContinuation () const
PRMAN_INLINE bool	GetScattering () const
PRMAN_INLINE bool	GetUser () const
PRMAN_INLINE unsigned char	GetLpeId () const
PRMAN_INLINE unsigned char	GetLobeId () const
PRMAN_INLINE bool	LobeIdIsSubsurface () const
PRMAN_INLINE bool	GetThinShadowFlag () const
PRMAN_INLINE unsigned char	GetUnused () const
PRMAN_INLINE void	SetValid (bool val)
PRMAN_INLINE void	SetDiscrete (bool val)
PRMAN_INLINE void	SetSpecular (bool val)
PRMAN_INLINE void	SetReflect ()
PRMAN_INLINE void	SetTransmit (bool entering)
PRMAN_INLINE void	SetEntering (bool entering)
PRMAN_INLINE void	SetContinuation (bool val)
PRMAN_INLINE void	SetUser (bool val)
PRMAN_INLINE void	SetLpeId (unsigned char val)
PRMAN_INLINE void	SetLobeId (unsigned char val)
PRMAN_INLINE void	SetThinShadowFlag (bool val)
PRMAN_INLINE void	SetUnused (unsigned char val)
PRMAN_INLINE void	Set (bool vDiscrete, bool vSpecular, bool vReflect, bool vContinuation, bool vUser, unsigned char vLpeId, unsigned char vLobeId, bool vThinShadowFlag=false)
	Set all fields and also sets the valid bit to true. More...
PRMAN_INLINE unsigned short	Serialize () const

Detailed Description

This struct represents the characteristics of just one lobe of a bxdf.

Constructor & Destructor Documentation

RixBXLobeSampled() [1/3]

PRMAN_INLINE RixBXLobeSampled::RixBXLobeSampled

(

)

Constructor; initializes the valid bit to false.

References RixBXLobeSampled::Converter::us.

RixBXLobeSampled() [2/3]

PRMAN_INLINE RixBXLobeSampled::RixBXLobeSampled

(

unsigned short

serialized

)

Constructor; initializes from serialization as unsigned short.

References RixBXLobeSampled::Converter::us.

RixBXLobeSampled() [3/3]

PRMAN_INLINE RixBXLobeSampled::RixBXLobeSampled	(	bool	discrete,
		bool	specular,
		bool	reflect,
		bool	user,
		unsigned char	lpeId,
		unsigned char	lobeId
	)

Constructor; sets all fields and sets the valid bit to true.

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::continuation, RixBXLobeSampled::Bitfield::discrete, RixBXLobeSampled::Bitfield::entering, RixBXLobeSampled::Bitfield::lobeId, RixBXLobeSampled::Bitfield::lpeId, RixBXLobeSampled::Bitfield::reflect, RixBXLobeSampled::Bitfield::specular, RixBXLobeSampled::Bitfield::thinShadow, RixBXLobeSampled::Bitfield::unused, RixBXLobeSampled::Bitfield::user, and RixBXLobeSampled::Bitfield::valid.

Member Function Documentation

CompareLobeID()

PRMAN_INLINE bool RixBXLobeSampled::CompareLobeID ( RixBXLobeSampled const &  rhs ) const

inline

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::lobeId, RixBXLobeSampled::Bitfield::specular, RixBXLobeSampled::Bitfield::user, and RixBXLobeSampled::Bitfield::valid.

GetContinuation()

PRMAN_INLINE bool RixBXLobeSampled::GetContinuation

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::continuation, and RixBXLobeSampled::Bitfield::valid.

GetDiffuse()

PRMAN_INLINE bool RixBXLobeSampled::GetDiffuse

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::specular, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixBXLobeWeights::AddActiveLobe().

GetDiscrete()

PRMAN_INLINE bool RixBXLobeSampled::GetDiscrete

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::discrete, and RixBXLobeSampled::Bitfield::valid.

GetEntering()

PRMAN_INLINE bool RixBXLobeSampled::GetEntering

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::entering, RixBXLobeSampled::Bitfield::reflect, and RixBXLobeSampled::Bitfield::valid.

GetLobeId()

PRMAN_INLINE unsigned char RixBXLobeSampled::GetLobeId

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::lobeId, and RixBXLobeSampled::Bitfield::valid.

GetLpeId()

PRMAN_INLINE unsigned char RixBXLobeSampled::GetLpeId

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::lpeId, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixBXLobeWeights::AddActiveLobe(), RixBXChooseLobe(), RixBXLobeTraits::RixBXLobeTraits(), and RixLPEScatterEvent::RixLPEScatterEvent().

GetReflect()

PRMAN_INLINE bool RixBXLobeSampled::GetReflect

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::reflect, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixLPEScatterEvent::RixLPEScatterEvent(), and RtRayGeometry::SetRaySpread().

GetScattering()

PRMAN_INLINE bool RixBXLobeSampled::GetScattering

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::continuation, and RixBXLobeSampled::Bitfield::valid.

GetSolidAngle()

PRMAN_INLINE bool RixBXLobeSampled::GetSolidAngle

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::discrete, and RixBXLobeSampled::Bitfield::valid.

Referenced by RtRayGeometry::SetRaySpread().

GetSpecular()

PRMAN_INLINE bool RixBXLobeSampled::GetSpecular

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::specular, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixBXChooseLobe().

GetThinShadowFlag()

PRMAN_INLINE bool RixBXLobeSampled::GetThinShadowFlag

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::thinShadow, and RixBXLobeSampled::Bitfield::valid.

GetTransmit()

PRMAN_INLINE bool RixBXLobeSampled::GetTransmit

(

bool *

entering = NULL

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::entering, RixBXLobeSampled::Bitfield::reflect, and RixBXLobeSampled::Bitfield::valid.

Referenced by RtRayGeometry::InitOrigination(), and RtRayGeometry::SetRaySpread().

GetUnused()

PRMAN_INLINE unsigned char RixBXLobeSampled::GetUnused

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::unused, and RixBXLobeSampled::Bitfield::valid.

GetUser()

PRMAN_INLINE bool RixBXLobeSampled::GetUser

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::user, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixBXLobeWeights::AddActiveLobe(), RixBXLobeTraits::RixBXLobeTraits(), and RixLPEScatterEvent::RixLPEScatterEvent().

GetValid()

PRMAN_INLINE bool RixBXLobeSampled::GetValid

(

)

const

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::valid.

Referenced by RixBXLobeWeights::AddActiveLobe(), RixBXLobeTraits::RixBXLobeTraits(), and RixLPEScatterEvent::RixLPEScatterEvent().

LobeIdIsSubsurface()

PRMAN_INLINE bool RixBXLobeSampled::LobeIdIsSubsurface

(

)

const

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::lobeId, and RixBXLobeSampled::Bitfield::valid.

Serialize()

PRMAN_INLINE unsigned short RixBXLobeSampled::Serialize

(

)

const

References RixBXLobeSampled::Converter::us.

Set()

PRMAN_INLINE void RixBXLobeSampled::Set	(	bool	vDiscrete,
		bool	vSpecular,
		bool	vReflect,
		bool	vContinuation,
		bool	vUser,
		unsigned char	vLpeId,
		unsigned char	vLobeId,
		bool	vThinShadowFlag = false
	)

Set all fields and also sets the valid bit to true.

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::continuation, RixBXLobeSampled::Bitfield::discrete, RixBXLobeSampled::Bitfield::entering, RixBXLobeSampled::Bitfield::lobeId, RixBXLobeSampled::Bitfield::lpeId, RixBXLobeSampled::Bitfield::reflect, RixBXLobeSampled::Bitfield::specular, RixBXLobeSampled::Bitfield::thinShadow, RixBXLobeSampled::Bitfield::unused, RixBXLobeSampled::Bitfield::user, and RixBXLobeSampled::Bitfield::valid.

Referenced by RtRayGeometry::InitTransmitOrigination().

SetContinuation()

PRMAN_INLINE void RixBXLobeSampled::SetContinuation

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::continuation.

SetDiscrete()

PRMAN_INLINE void RixBXLobeSampled::SetDiscrete

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::discrete.

SetEntering()

PRMAN_INLINE void RixBXLobeSampled::SetEntering

(

bool

entering

)

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::entering, and RixBXLobeSampled::Bitfield::reflect.

Referenced by RtRayGeometry::InitOrigination(), and RtRayGeometry::InitTransmitOrigination().

SetLobeId()

PRMAN_INLINE void RixBXLobeSampled::SetLobeId

(

unsigned char

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::lobeId.

SetLpeId()

PRMAN_INLINE void RixBXLobeSampled::SetLpeId

(

unsigned char

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::lpeId.

Referenced by RixBXChooseLobe().

SetReflect()

PRMAN_INLINE void RixBXLobeSampled::SetReflect

(

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::reflect.

SetSpecular()

PRMAN_INLINE void RixBXLobeSampled::SetSpecular

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::specular.

Referenced by RixBXChooseLobe().

SetThinShadowFlag()

PRMAN_INLINE void RixBXLobeSampled::SetThinShadowFlag

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::thinShadow.

SetTransmit()

PRMAN_INLINE void RixBXLobeSampled::SetTransmit

(

bool

entering

)

References RixBXLobeSampled::Converter::bits, RixBXLobeSampled::Bitfield::entering, and RixBXLobeSampled::Bitfield::reflect.

SetUnused()

PRMAN_INLINE void RixBXLobeSampled::SetUnused

(

unsigned char

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::unused.

SetUser()

PRMAN_INLINE void RixBXLobeSampled::SetUser

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::user.

SetValid()

PRMAN_INLINE void RixBXLobeSampled::SetValid

(

bool

val

)

References RixBXLobeSampled::Converter::bits, and RixBXLobeSampled::Bitfield::valid.

---

The documentation for this struct was generated from the following file:

• RixBxdfLobe.h