mdl_distiller_rules.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2024 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
 
#ifndef MDL_DISTILLER_RULES_H
#define MDL_DISTILLER_RULES_H
 
#include <cstddef>
 
#include <mi/mdl/mdl_distiller_options.h>
 
namespace mi {
namespace mdl {
 
class IDistiller_plugin_api;
class Debug_output_callback;
class DAG_node;
class Node_types;
 
enum Rule_eval_strategy {
    RULE_EVAL_TOP_DOWN, 
    RULE_EVAL_BOTTOM_UP 
};
 
enum Rule_result_code {
    RULE_RECURSE,       
    RULE_REPEAT_RULES,  
    RULE_SKIP_RECURSION 
};
 
enum Distiller_extended_node_semantics {
    DS_DIST_DEFAULT_BSDF = -1000,                    
    DS_DIST_DEFAULT_EDF  = -1001,                    
    DS_DIST_DEFAULT_VDF  = -1002,                    
    DS_DIST_DEFAULT_HAIR_BSDF  = -1003,              
    DS_DIST_STRUCT_MATERIAL_EMISSION = 0x10010,      
    DS_DIST_STRUCT_MATERIAL_SURFACE,                 
    DS_DIST_STRUCT_MATERIAL_VOLUME,                  
    DS_DIST_STRUCT_MATERIAL_GEOMETRY,                
    DS_DIST_STRUCT_MATERIAL,                         
    DS_DIST_BSDF_TINT = 0x10017,                     
    DS_DIST_BSDF_TINT2,                              
    DS_DIST_EDF_TINT,                                
    DS_DIST_VDF_TINT,                                
    DS_DIST_HAIR_BSDF_TINT,                          
    DS_DIST_BSDF_MIX_1 = 0x10020,                    
    DS_DIST_BSDF_MIX_2,                              
    DS_DIST_BSDF_MIX_3,                              
    DS_DIST_BSDF_MIX_4,                              
    DS_DIST_BSDF_CLAMPED_MIX_1,                      
    DS_DIST_BSDF_CLAMPED_MIX_2,                      
    DS_DIST_BSDF_CLAMPED_MIX_3,                      
    DS_DIST_BSDF_CLAMPED_MIX_4,                      
    DS_DIST_BSDF_UNBOUNDED_MIX_1,                    
    DS_DIST_BSDF_UNBOUNDED_MIX_2,                    
    DS_DIST_BSDF_UNBOUNDED_MIX_3,                    
    DS_DIST_BSDF_UNBOUNDED_MIX_4,                    
    DS_DIST_BSDF_COLOR_MIX_1 = 0x10030,              
    DS_DIST_BSDF_COLOR_MIX_2,                        
    DS_DIST_BSDF_COLOR_MIX_3,                        
    DS_DIST_BSDF_COLOR_MIX_4,                        
    DS_DIST_BSDF_COLOR_CLAMPED_MIX_1,                
    DS_DIST_BSDF_COLOR_CLAMPED_MIX_2,                
    DS_DIST_BSDF_COLOR_CLAMPED_MIX_3,                
    DS_DIST_BSDF_COLOR_CLAMPED_MIX_4,                
    DS_DIST_BSDF_COLOR_UNBOUNDED_MIX_1,              
    DS_DIST_BSDF_COLOR_UNBOUNDED_MIX_2,              
    DS_DIST_BSDF_COLOR_UNBOUNDED_MIX_3,              
    DS_DIST_BSDF_COLOR_UNBOUNDED_MIX_4,              
    DS_DIST_EDF_MIX_1 = 0x10040,                     
    DS_DIST_EDF_MIX_2,                               
    DS_DIST_EDF_MIX_3,                               
    DS_DIST_EDF_MIX_4,                               
    DS_DIST_EDF_CLAMPED_MIX_1,                       
    DS_DIST_EDF_CLAMPED_MIX_2,                       
    DS_DIST_EDF_CLAMPED_MIX_3,                       
    DS_DIST_EDF_CLAMPED_MIX_4,                       
    DS_DIST_EDF_UNBOUNDED_MIX_1,                     
    DS_DIST_EDF_UNBOUNDED_MIX_2,                     
    DS_DIST_EDF_UNBOUNDED_MIX_3,                     
    DS_DIST_EDF_UNBOUNDED_MIX_4,                     
    DS_DIST_EDF_COLOR_MIX_1 = 0x10050,               
    DS_DIST_EDF_COLOR_MIX_2,                         
    DS_DIST_EDF_COLOR_MIX_3,                         
    DS_DIST_EDF_COLOR_MIX_4,                         
    DS_DIST_EDF_COLOR_CLAMPED_MIX_1,                 
    DS_DIST_EDF_COLOR_CLAMPED_MIX_2,                 
    DS_DIST_EDF_COLOR_CLAMPED_MIX_3,                 
    DS_DIST_EDF_COLOR_CLAMPED_MIX_4,                 
    DS_DIST_EDF_COLOR_UNBOUNDED_MIX_1,               
    DS_DIST_EDF_COLOR_UNBOUNDED_MIX_2,               
    DS_DIST_EDF_COLOR_UNBOUNDED_MIX_3,               
    DS_DIST_EDF_COLOR_UNBOUNDED_MIX_4,               
    DS_DIST_VDF_MIX_1 = 0x10060,                     
    DS_DIST_VDF_MIX_2,                               
    DS_DIST_VDF_MIX_3,                               
    DS_DIST_VDF_MIX_4,                               
    DS_DIST_VDF_CLAMPED_MIX_1,                       
    DS_DIST_VDF_CLAMPED_MIX_2,                       
    DS_DIST_VDF_CLAMPED_MIX_3,                       
    DS_DIST_VDF_CLAMPED_MIX_4,                       
    DS_DIST_VDF_UNBOUNDED_MIX_1,                     
    DS_DIST_VDF_UNBOUNDED_MIX_2,                     
    DS_DIST_VDF_UNBOUNDED_MIX_3,                     
    DS_DIST_VDF_UNBOUNDED_MIX_4,                     
    DS_DIST_VDF_COLOR_MIX_1 = 0x10070,               
    DS_DIST_VDF_COLOR_MIX_2,                         
    DS_DIST_VDF_COLOR_MIX_3,                         
    DS_DIST_VDF_COLOR_MIX_4,                         
    DS_DIST_VDF_COLOR_CLAMPED_MIX_1,                 
    DS_DIST_VDF_COLOR_CLAMPED_MIX_2,                 
    DS_DIST_VDF_COLOR_CLAMPED_MIX_3,                 
    DS_DIST_VDF_COLOR_CLAMPED_MIX_4,                 
    DS_DIST_VDF_COLOR_UNBOUNDED_MIX_1,               
    DS_DIST_VDF_COLOR_UNBOUNDED_MIX_2,               
    DS_DIST_VDF_COLOR_UNBOUNDED_MIX_3,               
    DS_DIST_VDF_COLOR_UNBOUNDED_MIX_4,               
    DS_DIST_MATERIAL_CONDITIONAL_OPERATOR = 0x10100, 
    DS_DIST_BSDF_CONDITIONAL_OPERATOR,               
    DS_DIST_EDF_CONDITIONAL_OPERATOR,                
    DS_DIST_VDF_CONDITIONAL_OPERATOR,                
    DS_DIST_BSDF_DIRECTIONAL_FACTOR = 0x10110,       
    DS_DIST_EDF_DIRECTIONAL_FACTOR,                  
    DS_DIST_LOCAL_NORMAL = 0x11000                   
};
 
class IRule_matcher_event {
public:
    virtual void path_check_event(
        char const *rule_set_name,
        char const *dag_path) = 0;
 
    virtual void rule_match_event(
        char const *rule_set_name,
        unsigned   rule_id,
        char const *rule_name,
        char const *file_name,
        unsigned   line_number) = 0;
 
    virtual void postcondition_failed(
        char const *rule_set_name) = 0;
 
    virtual void postcondition_failed_path(
        char const *path) = 0;
 
    virtual void debug_print(
        IDistiller_plugin_api &plugin_api,
        char const *rule_set_name,
        unsigned   rule_id,
        char const *rule_name,
        char const *file_name,
        unsigned   line_number,
        char const *var_name,
        DAG_node const *value) = 0;
 
};
 
class IRule_matcher {
public:
    typedef bool (*Checker_function)(
        IDistiller_plugin_api &plugin_api,
        DAG_node const        *node);
 
    virtual Rule_eval_strategy get_strategy() const = 0;
 
    virtual size_t get_target_material_name_count() const = 0;
 
    virtual char const *get_target_material_name(size_t i) const = 0;
 
    virtual DAG_node const *matcher(
        IRule_matcher_event     *event_handler,
        IDistiller_plugin_api   &plugin_api,
        DAG_node const          *node,
        mi::mdl::Distiller_options const *options,
        Rule_result_code        &result_code) const = 0;
 
    virtual bool postcond(
        IRule_matcher_event     *event_handler,
        IDistiller_plugin_api   &plugin_api,
        DAG_node const          *root,
        mi::mdl::Distiller_options const *options) const = 0;
 
    virtual char const *get_rule_set_name() const = 0;
 
    virtual void set_node_types(Node_types *node_types) = 0;
};
 
} // mdl
} // mi
 
#endif // MDL_DISTILLER_RULES_H