RenderMan API  23.0
RixSGAnalyticLight Class Referenceabstract

#include <RixSceneGraph.h>

Inheritance diagram for RixSGAnalyticLight:
RixSGGroup

Public Member Functions

virtual RixSGError SetLight (unsigned num, RixSGShader const *nodes)=0
 
virtual RixSGError SetLightFilter (unsigned num, RixSGShader const *nodes)=0
 
virtual RixSGError SetOrientTransform (RtMatrix4x4 const &localxform)=0
 
- Public Member Functions inherited from RixSGGroup
virtual RixSGDagType GetDagType () const =0
 
virtual RtUString GetIdentifier () const =0
 
virtual RixSGError SetIdentifier (RtUString identifier)=0
 
virtual RixSGError SetTransform (unsigned numsamples, RtMatrix4x4 const *xforms, float const *times)=0
 
virtual RixSGError SetTransformNumSamples (unsigned numsamples)=0
 
virtual RixSGError SetTransformSample (unsigned sample, RtMatrix4x4 const &xform, float time)=0
 
RixSGError SetTransform (RtMatrix4x4 const &xform)
 
RixSGError SetIdentity ()
 
virtual RixSGError SetHidden (int state)=0
 
virtual int GetHidden () const =0
 
virtual RixSGError AddCoordinateSystem (RixSGGroup *coordsys)=0
 
virtual RixSGError RemoveCoordinateSystem (RixSGGroup *coordsys)=0
 
virtual unsigned GetNumCoordinateSystems () const =0
 
virtual RixSGGroupGetCoordinateSystem (unsigned idx) const =0
 
virtual RixSGError AddChild (RixSGGroup *child)=0
 
virtual RixSGError RemoveChild (RixSGGroup *child)=0
 
virtual unsigned GetNumChildren () const =0
 
virtual RixSGGroupGetChild (unsigned idx) const =0
 
virtual unsigned GetNumParents () const =0
 
virtual RixSGGroupGetParent (unsigned idx) const =0
 
virtual RixSGGroupFindDagNode (char const *path) const =0
 
virtual RixSGMaterialGetMaterial () const =0
 
virtual RixSGError SetMaterial (RixSGMaterial *material)=0
 
virtual RixSGError OverrideMaterial (RixSGMaterial *material, unsigned depth, RixSGGroup **path)=0
 
virtual RtParamList const & GetAttributes () const =0
 
virtual RixSGError SetAttributes (RtParamList const &attributes)=0
 
virtual RixSGError SetNested (bool state)=0
 
virtual bool GetNested () const =0
 
virtual RixSGError SetInheritTransform (bool value)=0
 
 RixSGGroup ()=default
 
virtual ~RixSGGroup ()=default
 

Protected Member Functions

 RixSGAnalyticLight ()=default
 
virtual ~RixSGAnalyticLight ()=default
 

Detailed Description

Analytic light DAG node support RixLight plug-ins

Definition at line 762 of file RixSceneGraph.h.

Constructor & Destructor Documentation

◆ RixSGAnalyticLight()

RixSGAnalyticLight::RixSGAnalyticLight ( )
inlineprotecteddefault

◆ ~RixSGAnalyticLight()

virtual RixSGAnalyticLight::~RixSGAnalyticLight ( )
protectedvirtualdefault

Member Function Documentation

◆ SetLight()

virtual RixSGError RixSGAnalyticLight::SetLight ( unsigned  num,
RixSGShader const *  nodes 
)
pure virtual

Set analytic light shading graph

Analytic light shading graphs may contain RixSGShaderType::k_Light and RixSGShaderType::k_Pattern nodes with a terminal RixSGShaderType::k_Light. There is no default analytic light.

See also
RixSGAnalyticLight::SetLightFilter
Parameters
[in]numThe number of nodes in the shading graph
[in]nodesThe analytic light shading graph nodes
Returns
Error code

◆ SetLightFilter()

virtual RixSGError RixSGAnalyticLight::SetLightFilter ( unsigned  num,
RixSGShader const *  nodes 
)
pure virtual

Set analytic light filter shading graph

Analytic light filter shading graphs may contain RixSGShaderType::k_LightFilter and RixSGShaderType::k_Pattern nodes. There is no default analytic light filter.

See also
RixSGAnalyticLight::SetLight
Parameters
[in]numThe number of nodes in the shading graph
[in]nodesThe analytic light filter shading graph nodes
Returns
Error code

◆ SetOrientTransform()

virtual RixSGError RixSGAnalyticLight::SetOrientTransform ( RtMatrix4x4 const &  localxform)
pure virtual

Set orientation transform

Orientation transforms are static transforms that are applied to the light description but are not inherited as part of the DAG hierarchy. This is typically used to match one light description to another, e.g. dome light up and forward directions.

Parameters
[in]localxformThe orientation transform
Returns
Error code

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