Developer documentation
Version 3.0.3-105-gd3941f44
MR::GUI::MRView::ColourBars Class Reference

#include "gui/mrview/colourbars.h"

Public Types

enum  Position {
  None = 0x00 , Top = 0x01 , Bottom = 0x02 , Left = 0x04 ,
  Right = 0x08 , TopLeft = Top | Left , TopRight = Top | Right , BottomLeft = Bottom | Left ,
  BottomRight = Bottom | Right
}
 

Public Member Functions

 ColourBars ()
 
void begin (Projection *projection, const Position position, const size_t ncolourbars)
 
void render (size_t colourmap, bool inverted, float local_min_value, float local_max_value, float global_min_value, float global_range, Eigen::Array3f colour={ NAN, NAN, NAN })
 
void render (const Displayable &object, bool inverted)
 
void end ()
 

Protected Member Functions

void setup (size_t index, bool inverted)
 

Protected Attributes

GL::VertexBuffer VB
 
GL::VertexArrayObject VAO
 
GL::Shader::Program frame_program
 
GL::Shader::Program program
 
size_t current_colourmap_index
 
bool current_colourmap_inverted
 
const GLfloat width
 
const GLfloat height
 
const GLfloat inset
 
const GLfloat text_offset
 
const GLfloat colourbar_padding
 

Detailed Description

Definition at line 45 of file colourbars.h.

Member Enumeration Documentation

◆ Position

Enumerator
None 
Top 
Bottom 
Left 
Right 
TopLeft 
TopRight 
BottomLeft 
BottomRight 

Definition at line 48 of file colourbars.h.

Constructor & Destructor Documentation

◆ ColourBars()

MR::GUI::MRView::ColourBars::ColourBars ( )

Member Function Documentation

◆ begin()

void MR::GUI::MRView::ColourBars::begin ( Projection projection,
const Position  position,
const size_t  ncolourbars 
)
inline

Definition at line 62 of file colourbars.h.

◆ end()

void MR::GUI::MRView::ColourBars::end ( )
inline

Definition at line 78 of file colourbars.h.

◆ render() [1/2]

void MR::GUI::MRView::ColourBars::render ( const Displayable object,
bool  inverted 
)

◆ render() [2/2]

void MR::GUI::MRView::ColourBars::render ( size_t  colourmap,
bool  inverted,
float  local_min_value,
float  local_max_value,
float  global_min_value,
float  global_range,
Eigen::Array3f  colour = { NAN, NAN, NAN } 
)

◆ setup()

void MR::GUI::MRView::ColourBars::setup ( size_t  index,
bool  inverted 
)
protected

Member Data Documentation

◆ colourbar_padding

const GLfloat MR::GUI::MRView::ColourBars::colourbar_padding
protected

Definition at line 91 of file colourbars.h.

◆ current_colourmap_index

size_t MR::GUI::MRView::ColourBars::current_colourmap_index
protected

Definition at line 89 of file colourbars.h.

◆ current_colourmap_inverted

bool MR::GUI::MRView::ColourBars::current_colourmap_inverted
protected

Definition at line 90 of file colourbars.h.

◆ frame_program

GL::Shader::Program MR::GUI::MRView::ColourBars::frame_program
protected

Definition at line 88 of file colourbars.h.

◆ height

const GLfloat MR::GUI::MRView::ColourBars::height
protected

Definition at line 91 of file colourbars.h.

◆ inset

const GLfloat MR::GUI::MRView::ColourBars::inset
protected

Definition at line 91 of file colourbars.h.

◆ program

GL::Shader::Program MR::GUI::MRView::ColourBars::program
protected

Definition at line 88 of file colourbars.h.

◆ text_offset

const GLfloat MR::GUI::MRView::ColourBars::text_offset
protected

Definition at line 91 of file colourbars.h.

◆ VAO

GL::VertexArrayObject MR::GUI::MRView::ColourBars::VAO
protected

Definition at line 87 of file colourbars.h.

◆ VB

GL::VertexBuffer MR::GUI::MRView::ColourBars::VB
protected

Definition at line 86 of file colourbars.h.

◆ width

const GLfloat MR::GUI::MRView::ColourBars::width
protected

Definition at line 91 of file colourbars.h.


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