---

OSPRay2Renderer.h

Go to the documentation of this file.

/***************************************************************************
 *cr                                                                       
 *cr            (C) Copyright 1995-2019 The Board of Trustees of the           
 *cr                        University of Illinois                       
 *cr                         All Rights Reserved                        
 *cr                                                                   
 ***************************************************************************/

/***************************************************************************
* RCS INFORMATION:
*
*      $RCSfile: OSPRay2Renderer.h,v $
*      $Author: johns $      $Locker:  $               $State: Exp $
*      $Revision: 1.12 $         $Date: 2021/12/13 07:54:00 $
*
***************************************************************************/
#ifndef LIBOSPRAY2RENDERER
#define LIBOSPRAY2RENDERER

#include <stdio.h>
#include <stdlib.h>
#include <ospray/ospray.h>
#include "Matrix4.h"
#include "ResizeArray.h"
#include "WKFUtils.h"
#if !defined(OSPRAY_VERSION_MAJOR)
#include <ospray/version.h>
#endif

// Prevent interactive RT window code from being compiled when
// VMD isn't compiled with an interactive GUI
#if defined(VMDOPTIX_INTERACTIVE_OPENGL) && !defined(VMDOPENGL)
#undef VMDOPTIX_INTERACTIVE_OPENGL
#endif

#if defined(VMDOSPRAY_INTERACTIVE_OPENGL)
#include "glwin.h"
#endif

typedef struct {
  OSPMaterial mat;
  int isvalid;
  float ambient;
  float diffuse;
  float specular;
  float shininess;
  float reflectivity;
  float opacity;
  float outline;
  float outlinewidth;
  int transmode;
  int ind;
} osp_material;

typedef struct {
  float dir[3];
  float color[3];
} osp_directional_light;

typedef struct {
  float pos[3];
  float color[3];
} osp_positional_light;


typedef struct {
  int num;  
  float *v;
  float *n;
  float *c;
  int   *f;
  OSPGeometry geom;
  OSPData verts;
  OSPData norms;
  OSPData cols;
  OSPData ind;
  OSPGeometricModel model;
  int matindex;
} osp_trimesh_v3f_n3f_c3f;


typedef struct {
  int num;  
  float *xyz;     // xyzr vec3
  float *radii;   // float
  float *colors;  // RGBA vec4
  OSPGeometry geom;
  OSPData cents;
  OSPData rads;
  OSPData cols;
  OSPGeometricModel model;
  int matindex;
} osp_sphere_array_color;


typedef struct {
  int num;       // number of cylinders
  float *vertsrads;  // point a, rad a, point b, rad b
  float *colors; // rgba
  unsigned int *indices;
  OSPGeometry geom;
  OSPData cyls;
  OSPData cols;
  OSPData ind;
  OSPGeometricModel model;
  int matindex;
} osp_cylinder_array_color;


class OSPRay2Renderer {
public: 
  // Use reverse rays by default rather than only when enabled interactively
  enum RtShadowMode { RT_SHADOWS_OFF=0,        
                      RT_SHADOWS_ON=1,         
                    };
  enum FogMode { RT_FOG_NONE=0, RT_FOG_LINEAR=1, RT_FOG_EXP=2, RT_FOG_EXP2=3 };
  enum CameraProjection { RT_PERSPECTIVE=0, 
                          RT_ORTHOGRAPHIC=1 
// ,
//                          RT_CUBEMAP=2,
//                          RT_DOME_MASTER=3,
//                          RT_EQUIRECTANGULAR=4,
//                          RT_OCULUS_RIFT
                        };
  enum Verbosity { RT_VERB_MIN=0, RT_VERB_TIMING=1, RT_VERB_DEBUG=2 };
  enum BGMode { RT_BACKGROUND_TEXTURE_SOLID=0,
                RT_BACKGROUND_TEXTURE_SKY_SPHERE=1,
                RT_BACKGROUND_TEXTURE_SKY_ORTHO_PLANE=2 };
  enum RenderMode { RT_SCIVIS=0, RT_PATHTRACER=1 };

private:
  struct vec3 { float x, y, z; };
  struct rgba { float r, g, b, a; };

  struct Sphere {
    vec3  center;
    float radius;
    rgba  color;
    int   type;        //Material ID
  };

  Verbosity verbose;                      
  int width;                              
  int height;                             

  wkf_timerhandle osp_timer;              
  double time_ctx_create;                 
  double time_ctx_setup;                  
  double time_ctx_validate;               
  double time_ctx_AS_build;               
  double time_ctx_destroy_scene;          
  double time_ray_tracing;                
  double time_image_io;                   

  // OSPRay objects managed by VMD
  RenderMode osp_rendermode;              
  int context_created;                    
  OSPRenderer ospRenderer;                
  OSPWorld ospWorld;                      
  ResizeArray<OSPInstance> ospInstances;  

  ResizeArray<OSPLight> ospLights;        
  OSPData ospLightData;                   
  OSPCamera ospCamera;                    
  OSPFrameBuffer ospFrameBuffer;          

  int interactive_renderer;               

  int lasterror;                          
  int buffers_allocated;                  
  int headlight_enabled;                  

  float ao_ambient;                       
  float ao_direct;                        

  // cylinder array primitive
  long cylinder_array_cnt;                 

  // color-per-cylinder array primitive
  long cylinder_array_color_cnt;           

  // color-per-ring array primitive
  long ring_array_color_cnt;              

  // sphere array primitive
  long sphere_array_cnt;                  

  // color-per-sphere array primitive
  long sphere_array_color_cnt;            


  // triangle mesh primitives of various types
  long tricolor_cnt;                      
  long trimesh_c4u_n3b_v3f_cnt;           
  long trimesh_n3b_v3f_cnt;               
  long trimesh_n3f_v3f_cnt;               
  long trimesh_v3f_cnt;                   

  // state variables to hold scene geometry
  int scene_created;

  //
  // OSPRay shader state variables and the like
  //

  // shadow rendering mode 
  int shadows_enabled;                  
  float cam_zoom;                       

  float cam_stereo_eyesep;              
  float cam_stereo_convergence_dist;    

  int dof_enabled;                      
  float cam_dof_focal_dist;             
  float cam_dof_fnumber;                

  CameraProjection camera_projection;   

  int ext_aa_loops;                     
  int aa_samples;                       
  int ao_samples;                       

  // background color and/or gradient parameters
  BGMode scene_background_mode;         
  float scene_bg_color[3];              
  float scene_bg_grad_top[3];           
  float scene_bg_grad_bot[3];           
  float scene_gradient[3];              
  float scene_gradient_topval;          
  float scene_gradient_botval;          
  float scene_gradient_invrange;        

  // fog / depth cueing parameters
  int fog_mode;                         
  float fog_start;                      
  float fog_end;                        
  float fog_density;                    

  ResizeArray<osp_material> materialcache; 

  ResizeArray<osp_directional_light> directional_lights; 
  ResizeArray<osp_positional_light> positional_lights;   

  // keep track of all of the OSPRay objects we create on-the-fly...
  ResizeArray<osp_trimesh_v3f_n3f_c3f> trimesh_v3f_n3f_c3f;
  ResizeArray<osp_sphere_array_color> spheres_color;
  ResizeArray<osp_cylinder_array_color> cylinders_color;

public:
  static int OSPRay_Global_Init(void);      
  static void OSPRay_Global_Shutdown(void); 

  OSPRay2Renderer(void);
  ~OSPRay2Renderer(void);

  void check_verbose_env();

  void setup_context(int width, int height);
  
  void reposp_context_stats(void);

  void shadows_on(int onoff) { shadows_enabled = (onoff != 0); }

  void set_aa_samples(int cnt) { aa_samples = cnt; }

  void set_camera_projection(CameraProjection m) { camera_projection = m; }

  void set_camera_zoom(float zoomfactor) { cam_zoom = zoomfactor; }

  void set_camera_stereo_eyesep(float eyesep) { cam_stereo_eyesep = eyesep; }
  
  void set_camera_stereo_convergence_dist(float dist) {
    cam_stereo_convergence_dist = dist;
  }

  void dof_on(int onoff) { dof_enabled = (onoff != 0); }

  void set_camera_dof_focal_dist(float d) { cam_dof_focal_dist = d; }

  void set_camera_dof_fnumber(float n) { cam_dof_fnumber = n; }

  void set_ao_samples(int cnt) { ao_samples = cnt; }

  void set_ao_ambient(float aoa) { ao_ambient = aoa; }

  void set_ao_direct(float aod) { ao_direct = aod; }

  void set_bg_mode(BGMode m) { scene_background_mode = m; }
  void set_bg_color(float *rgb) { memcpy(scene_bg_color, rgb, sizeof(scene_bg_color)); }
  void set_bg_color_grad_top(float *rgb) { memcpy(scene_bg_grad_top, rgb, sizeof(scene_bg_grad_top)); }
  void set_bg_color_grad_bot(float *rgb) { memcpy(scene_bg_grad_bot, rgb, sizeof(scene_bg_grad_bot)); }
  void set_bg_gradient(float *vec) { memcpy(scene_gradient, vec, sizeof(scene_gradient)); }
  void set_bg_gradient_topval(float v) { scene_gradient_topval = v; }
  void set_bg_gradient_botval(float v) { scene_gradient_botval = v; }

  void set_cue_mode(FogMode mode, float start, float end, float density) {
    fog_mode = mode;
    fog_start = start;
    fog_end = end;
    fog_density = density;
  }

  void init_materials();
  void add_material(int matindex, float ambient, float diffuse,
                    float specular, float shininess, float reflectivity,
                    float opacity, float outline, float outlinewidth, 
                    int transmode);
  void set_material(OSPGeometricModel &model, int matindex, float *uniform_color);
  void attach_sphere_array(int numsp, int matindex,
                           osp_sphere_array_color &sparray);
  void attach_cylinder_array(int numcyl, int matindex,
                             osp_cylinder_array_color &cylarray);
  void attach_mesh(int numverts, int numfacets, int matindex,
                   osp_trimesh_v3f_n3f_c3f &mesh);


  void clear_all_lights() { 
    headlight_enabled = 0;
    directional_lights.clear(); 
    positional_lights.clear(); 
  }
  void headlight_onoff(int onoff) { headlight_enabled = (onoff==1); };
  void add_directional_light(const float *dir, const float *color);
  void add_positional_light(const float *pos, const float *color);

  void update_rendering_state(int interactive);

  void framebuffer_config(int fbwidth, int fbheight);
  void framebuffer_resize(int fbwidth, int fbheight);
  void framebuffer_destroy(void);

  void render_compile_and_validate(void);
  void render_to_file(const char *filename); 
#if defined(VMDOSPRAY_INTERACTIVE_OPENGL)
  void render_to_glwin(const char *filename);
#endif

  void destroy_scene(void);

#if 1
  void cylinder_array(Matrix4 *wtrans, float rscale, float *uniform_color,
                      int cylnum, float *points, int matindex);
#endif

  void cylinder_array_color(Matrix4 & wtrans, float rscale, int cylnum, 
                            float *points, float *radii, float *colors,
                            int matindex);

#if 0
  void ring_array_color(Matrix4 & wtrans, float rscale, int rnum, 
                        float *centers, float *norms, float *radii, 
                        float *colors, int matindex);
#endif

  void sphere_array(Matrix4 *wtrans, float rscale, float *uniform_color,
                    int spnum, float *centers, float *radii, int matindex);

  void sphere_array_color(Matrix4 & wtrans, float rscale, int spnum, 
                          float *centers, float *radii, float *colors, 
                          int matindex);

  void tricolor_list(Matrix4 & wtrans, int numtris, float *vnc, int matindex);

  void trimesh_c4n3v3(Matrix4 & wtrans, int numverts,
                      float *cnv, int numfacets, int * facets, int matindex);

  void trimesh_c4u_n3b_v3f(Matrix4 & wtrans, unsigned char *c, signed char *n, 
                           float *v, int numfacets, int matindex);

  void trimesh_c4u_n3f_v3f(Matrix4 & wtrans, unsigned char *c, 
                           float *n, float *v, int numfacets, int matindex);

  void trimesh_n3b_v3f(Matrix4 & wtrans, float *uniform_color, 
                       signed char *n, float *v, int numfacets, int matindex);

  void trimesh_n3f_v3f(Matrix4 & wtrans, float *uniform_color, 
                       float *n, float *v, int numfacets, int matindex);

#if 0
  void trimesh_v3f(Matrix4 & wtrans, float *uniform_color, 
                   float *v, int numfacets, int matindex);
#endif

  void tristrip(Matrix4 & wtrans, int numverts, const float * cnv,
                int numstrips, const int *vertsperstrip,
                const int *facets, int matindex);

}; 

#endif

---