nml_scene.h

// -*-c++-*-
#ifndef STORMM_NML_SCENE_H
#define STORMM_NML_SCENE_H
 
#include "copyright.h"
#include "Constants/behavior.h"
#include "Parsing/parsing_enumerators.h"
#include "Parsing/textfile.h"
#include "Reporting/render_options.h"
#include "Reporting/reporting_enumerators.h"
#include "namelist_emulator.h"
 
namespace stormm {
namespace namelist {
 
using constants::ExceptionResponse;
using parse::TextFile;
using parse::WrapTextSearch;
using review::RenderOptions;
using review::SurfaceRender;
using review::LinePlotStyle;

class SceneControls {
public:
  
  SceneControls(ExceptionResponse policy_in = ExceptionResponse::DIE,
                WrapTextSearch wrap = WrapTextSearch::NO);
  SceneControls(const TextFile &tf, int *start_line, bool *found_nml,
                ExceptionResponse policy_in = ExceptionResponse::DIE,
                WrapTextSearch wrap = WrapTextSearch::NO);

  SceneControls(const SceneControls &original) = default;
  SceneControls(SceneControls &&original) = default;
  SceneControls& operator=(const SceneControls &original) = default;
  SceneControls& operator=(SceneControls &&original) = default;

  const std::string& getLabel() const;

  RenderOptions exportData() const;

  void setLabel(const std::string &label_in);
  
private:

  std::string label;
 
  // The following member variables control the rendering weights and cartoon representations of
  // molecules and other objects in the scene.
  double receptor_line_width;       
  double ligand_line_width;         
  double receptor_light_atom_size;  
  double receptor_heavy_atom_size;  
  double ligand_light_atom_size;    
  double ligand_heavy_atom_size;    
  double added_point_weight;        
  bool display_field_borders;       
  double border_line_width;         
  LinePlotStyle border_line_style;  
  std::string receptor_highlight;   
  std::string ligand_highlight;     
 
  // The following member variables control the coloration and lighting of the scene.
  uchar4 receptor_line_color;     
  uchar4 ligand_line_color;       
  uchar4 added_point_color;       
  uchar4 border_line_color;       
  std::string lighting_mode;      
  std::string camlight_position;  
 
  // The following member variables control isosurfaces to be plotted from some field associated
  // with the scene.
  int isosurface_count;                        
  std::vector<double> isosurface_values;       
  std::vector<uchar4> isosurface_colors;       
  std::vector<SurfaceRender> isosurface_mats;  

  NamelistEmulator nml_transcript;
};
  
uchar4 extractColorInformation(const NamelistEmulator &t_nml, const std::string &target_key,
                               int target_entry = 0,
                               const uchar4 init_value = { 255, 255, 255, 255 });

NamelistEmulator sceneInput(const TextFile &tf, int *start_line, bool *found,
                            ExceptionResponse policy = ExceptionResponse::DIE,
                            WrapTextSearch wrap = WrapTextSearch::NO);
  
} // namespace namelist
} // namespace stormm
 
#endif