HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HUSD_PreviewShaderTranslator Class Referenceabstract

Creates a standard USD Preview Surface shader from Houdini's node. More...

#include <HUSD_ShaderTranslator.h>

Public Member Functions

virtual ~HUSD_PreviewShaderTranslator ()=default
 Standard virtual destructor for this abstract base class. More...
 
virtual bool matchesRenderContext (const UT_StringRef &render_context)=0
 
virtual void createMaterialPreviewShader (HUSD_AutoWriteLock &lock, const UT_StringRef &usd_material_path, const UT_StringRef &usd_shader_path, const HUSD_TimeCode &time_code)=0
 
virtual void deleteMaterialPreviewShader (HUSD_AutoWriteLock &lock, const UT_StringRef &usd_material_path)=0
 Destroys the USD Preview Surface shader and its input chains. More...
 
virtual void updateMaterialPreviewShaderParameters (HUSD_AutoWriteLock &lock, const UT_StringRef &usd_main_shader_path, const HUSD_TimeCode &time_code)=0
 

Detailed Description

Creates a standard USD Preview Surface shader from Houdini's node.

Definition at line 174 of file HUSD_ShaderTranslator.h.

Constructor & Destructor Documentation

virtual HUSD_PreviewShaderTranslator::~HUSD_PreviewShaderTranslator ( )
virtualdefault

Standard virtual destructor for this abstract base class.

Member Function Documentation

virtual void HUSD_PreviewShaderTranslator::createMaterialPreviewShader ( HUSD_AutoWriteLock &  lock,
const UT_StringRef &  usd_material_path,
const UT_StringRef &  usd_shader_path,
const HUSD_TimeCode &  time_code 
)
pure virtual

Creates a USD Preview Surface shader primitive for the USD material.

usd_material_path - path to the material primitive in which the preview shader primitive should be created. usd_shader_path - path to a specific render context shader primitive based on which the universal render context preview shader should be created. time_code - time code at which to evaluate and author any properties.

virtual void HUSD_PreviewShaderTranslator::deleteMaterialPreviewShader ( HUSD_AutoWriteLock &  lock,
const UT_StringRef &  usd_material_path 
)
pure virtual

Destroys the USD Preview Surface shader and its input chains.

virtual bool HUSD_PreviewShaderTranslator::matchesRenderContext ( const UT_StringRef &  render_context)
pure virtual

Returns true if the translator can create a USD Preview Surface shader for a shader node that reports the given render mask.

virtual void HUSD_PreviewShaderTranslator::updateMaterialPreviewShaderParameters ( HUSD_AutoWriteLock &  lock,
const UT_StringRef &  usd_main_shader_path,
const HUSD_TimeCode &  time_code 
)
pure virtual

Re-translates the shader parameters given the shader VOP node (and its new parameter values). usd_shader_path - the path to the USD main surface shader primitive, based on which the preview shader nput attributes need to be updated, due to node parm value change. time_code - time code at which to evaluate and author any properties.

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