SPH
Public Member Functions | Public Attributes | List of all members
RenderParams Struct Reference

Parameters of the rendered image. More...

#include <IRenderer.h>

Public Member Functions

void initialize (const GuiSettings &gui)
 Sets up parameters using values stored in settings. More...
 

Public Attributes

AutoPtr< ICameracamera
 Camera used for rendering. More...
 
AutoPtr< ITrackertracker
 Tracker used for camera motion. More...
 
Rgba background = Rgba::black()
 Background color of the rendered image. More...
 
bool showKey = true
 If true, a color palette and a distance scale is included in the image. More...
 
struct {
   float   scale = 1.f
 Scaling factor of drawn particles relative to 1. More...
 
   Optional< Size >   selected = NOTHING
 Highlighted particle (only for interactive view). More...
 
   bool   grayScale = false
 If true, the palette is converted to grayscale. More...
 
   bool   doAntialiasing = false
 If true, the particles will be drawn with antialiasing. More...
 
   bool   smoothed = false
 If true, particles will be smoothed using cubic spline. More...
 
   bool   renderGhosts = true
 If true, ghost particles (if present) will be rendered as empty circles. More...
 
particles
 Parameters of the particle renderer. More...
 
struct {
   float   length = 100.f
 Length of the drawn vectors in pixels;. More...
 
vectors
 Parameters of rendered vectors. More...
 
struct {
   float   level = 0.15f
 Value of the iso-surface defining the rendered surface. More...
 
   float   ambientLight = 0.3f
 Intensity of the ambient light, illuminating every point unconditionally. More...
 
   float   sunLight = 0.7f
 Intensity of the sunlight. More...
 
   float   emission = 1.f
 Emission multiplier. More...
 
   float   filterWidth = 2.f
 Width of the image reconstruction filter. More...
 
surface
 Parameters of rendered surface. More...
 
struct {
   float   emission = 1.f
 Emission per unit distance [m^-1]. More...
 
   float   absorption = 0.f
 Absorption coefficient [m^-1]. More...
 
   float   compressionFactor = 2.f
 Compression factor of the logarithmic tonemapper. More...
 
volume
 Parameters of volumetric renderer. More...
 
struct {
   float   isoStep = 30.f
 Step between subsequent iso-lines. More...
 
   Size   gridSize = 100
 Horizontal resolution of the grid. More...
 
   bool   showLabels = true
 Show numerical values of iso-lines. More...
 
contours
 

Detailed Description

Parameters of the rendered image.

Partially overlaps with GuiSettings, but it's better to have render specific settings in one struct than one huge catch-all settings.

Definition at line 60 of file IRenderer.h.

Member Function Documentation

◆ initialize()

NAMESPACE_SPH_BEGIN void RenderParams::initialize ( const GuiSettings gui)

Sets up parameters using values stored in settings.

This does NOT initialize camera and resolution of the render.

Definition at line 11 of file IRenderer.cpp.

Member Data Documentation

◆ absorption

float RenderParams::absorption = 0.f

Absorption coefficient [m^-1].

Definition at line 140 of file IRenderer.h.

◆ ambientLight

float RenderParams::ambientLight = 0.3f

Intensity of the ambient light, illuminating every point unconditionally.

Definition at line 121 of file IRenderer.h.

◆ background

Rgba RenderParams::background = Rgba::black()

Background color of the rendered image.

Definition at line 71 of file IRenderer.h.

◆ camera

AutoPtr<ICamera> RenderParams::camera

Camera used for rendering.

Definition at line 63 of file IRenderer.h.

◆ compressionFactor

float RenderParams::compressionFactor = 2.f

Compression factor of the logarithmic tonemapper.

Definition at line 143 of file IRenderer.h.

◆ 

struct { ... } RenderParams::contours

◆ doAntialiasing

bool RenderParams::doAntialiasing = false

If true, the particles will be drawn with antialiasing.

This will generally improve quality, but may slow down the rendering.

Definition at line 94 of file IRenderer.h.

◆ emission

float RenderParams::emission = 1.f

Emission multiplier.

Emission per unit distance [m^-1].

Definition at line 127 of file IRenderer.h.

◆ filterWidth

float RenderParams::filterWidth = 2.f

Width of the image reconstruction filter.

Definition at line 130 of file IRenderer.h.

◆ grayScale

bool RenderParams::grayScale = false

If true, the palette is converted to grayscale.

Definition at line 89 of file IRenderer.h.

◆ gridSize

Size RenderParams::gridSize = 100

Horizontal resolution of the grid.

Definition at line 152 of file IRenderer.h.

◆ isoStep

float RenderParams::isoStep = 30.f

Step between subsequent iso-lines.

Definition at line 149 of file IRenderer.h.

◆ length

float RenderParams::length = 100.f

Length of the drawn vectors in pixels;.

Definition at line 110 of file IRenderer.h.

◆ level

float RenderParams::level = 0.15f

Value of the iso-surface defining the rendered surface.

Definition at line 118 of file IRenderer.h.

◆ 

struct { ... } RenderParams::particles

Parameters of the particle renderer.

◆ renderGhosts

bool RenderParams::renderGhosts = true

If true, ghost particles (if present) will be rendered as empty circles.

Definition at line 102 of file IRenderer.h.

◆ scale

float RenderParams::scale = 1.f

Scaling factor of drawn particles relative to 1.

Can be (in theory) any positive value.

Definition at line 81 of file IRenderer.h.

◆ selected

Optional<Size> RenderParams::selected = NOTHING

Highlighted particle (only for interactive view).

If NOTHING, no particle is selected.

Definition at line 86 of file IRenderer.h.

◆ showKey

bool RenderParams::showKey = true

If true, a color palette and a distance scale is included in the image.

Definition at line 74 of file IRenderer.h.

◆ showLabels

bool RenderParams::showLabels = true

Show numerical values of iso-lines.

Definition at line 155 of file IRenderer.h.

◆ smoothed

bool RenderParams::smoothed = false

If true, particles will be smoothed using cubic spline.

Only used if doAntialiasing is true.

Definition at line 99 of file IRenderer.h.

◆ sunLight

float RenderParams::sunLight = 0.7f

Intensity of the sunlight.

Definition at line 124 of file IRenderer.h.

◆ 

struct { ... } RenderParams::surface

Parameters of rendered surface.

◆ tracker

AutoPtr<ITracker> RenderParams::tracker

Tracker used for camera motion.

May be nullptr for static camera.

Definition at line 68 of file IRenderer.h.

◆ 

struct { ... } RenderParams::vectors

Parameters of rendered vectors.

◆ 

struct { ... } RenderParams::volume

Parameters of volumetric renderer.


The documentation for this struct was generated from the following files: