RenderManAPI  24.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixLightContext Class Referenceabstract

RixLightContext This class provides access to the rendering context during light sampling and evaluation. More...

#include <RixLight.h>

Inherits RixContext.

Public Member Functions

RixPhotonGuiding const * GetPhotonGuiding () const
 Public interface. More...
 
virtual float GetTime () const =0
 
virtual RtFloat2 GetSample2D () const =0
 
virtual void GetSample4D (RtFloat2 &xy, RtFloat2 &zw) const =0
 
virtual void GetWorldBBox (RtBBox &worldBBox) const =0
 
virtual void GetFromToTransform (RtUString from, RtUString to, const float time, RtMatrix4x4 &xform) const =0
 
virtual void GetFromToTransform (RtUString from, RtUString to, RtMatrix4x4 &xform) const =0
 
virtual void GetLightToCurrentTransform (RtMatrix4x4 &lightToCurrent) const =0
 
virtual void GetLightToCurrentTransform (float const time, RtMatrix4x4 &lightToCurrent) const =0
 
virtual void GetCurrentToLightTransform (RtMatrix4x4 &lightToCurrent) const =0
 
virtual void GetCurrentToLightTransform (float const time, RtMatrix4x4 &lightToCurrent) const =0
 
virtual RixInterface * GetRixInterface (RixInterfaceId id) const =0
 Get the specified interface from this context. More...
 

Protected Member Functions

 RixLightContext ()
 
 ~RixLightContext () override
 

Protected Attributes

RixPhotonGuiding const * m_pPhotonGuiding
 

Detailed Description

RixLightContext This class provides access to the rendering context during light sampling and evaluation.

Constructor & Destructor Documentation

◆ RixLightContext()

RixLightContext::RixLightContext ( )
inlineprotected

◆ ~RixLightContext()

RixLightContext::~RixLightContext ( )
inlineoverrideprotected

Member Function Documentation

◆ GetCurrentToLightTransform() [1/2]

virtual void RixLightContext::GetCurrentToLightTransform ( RtMatrix4x4 &  lightToCurrent) const
pure virtual

◆ GetCurrentToLightTransform() [2/2]

virtual void RixLightContext::GetCurrentToLightTransform ( float const  time,
RtMatrix4x4 &  lightToCurrent 
) const
pure virtual

◆ GetFromToTransform() [1/2]

virtual void RixLightContext::GetFromToTransform ( RtUString  from,
RtUString  to,
const float  time,
RtMatrix4x4 &  xform 
) const
pure virtual

◆ GetFromToTransform() [2/2]

virtual void RixLightContext::GetFromToTransform ( RtUString  from,
RtUString  to,
RtMatrix4x4 &  xform 
) const
pure virtual

◆ GetLightToCurrentTransform() [1/2]

virtual void RixLightContext::GetLightToCurrentTransform ( RtMatrix4x4 &  lightToCurrent) const
pure virtual

◆ GetLightToCurrentTransform() [2/2]

virtual void RixLightContext::GetLightToCurrentTransform ( float const  time,
RtMatrix4x4 &  lightToCurrent 
) const
pure virtual

◆ GetPhotonGuiding()

RixPhotonGuiding const* RixLightContext::GetPhotonGuiding ( ) const
inline

Public interface.

References m_pPhotonGuiding.

◆ GetRixInterface()

virtual RixInterface* RixContext::GetRixInterface ( RixInterfaceId  id) const
pure virtualinherited

Get the specified interface from this context.

The generic interface that is returned must be cast to the appropriate type before use.

Referenced by PxrGeoAOV::disableIntegratorAOVs(), RixIES::ReadIESProfile(), RixBXLookupLobeByName(), RixDebugBasis(), RixGetSceneColorSpace(), RixIsHoldout(), and RixIsMatte().

◆ GetSample2D()

virtual RtFloat2 RixLightContext::GetSample2D ( ) const
pure virtual

◆ GetSample4D()

virtual void RixLightContext::GetSample4D ( RtFloat2 &  xy,
RtFloat2 &  zw 
) const
pure virtual

◆ GetTime()

virtual float RixLightContext::GetTime ( ) const
pure virtual

◆ GetWorldBBox()

virtual void RixLightContext::GetWorldBBox ( RtBBox &  worldBBox) const
pure virtual

Member Data Documentation

◆ m_pPhotonGuiding

RixPhotonGuiding const* RixLightContext::m_pPhotonGuiding
protected

Referenced by GetPhotonGuiding().

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