CamSim Namespace Reference

Classes
class	Animation
	The Animation class. More...
class	ChipTiming
	Defines chip timings and therefore frames-per-second. More...
class	Context
	Provides a suitable OpenGL context for the simulator and related classes. More...
class	Exporter
	Export simulation results to various file formats. More...
class	Generator
	Generates basic objects to populate a scene. More...
class	Importer
class	Light
	The Light class. More...
class	Material
	The Material class. More...
class	Object
	The Object class. More...
class	Output
	Defines the simulator output. More...
class	Pipeline
	Defines the rendering pipeline. More...
class	PMD
	Defines a PMD chip. More...
class	Projection
	Defines the camera projection onto the image plane. More...
class	Scene
	The Scene class. More...
class	Shape
	The Shape class. More...
class	Simulator
	Simulates a camera frame. More...
class	TexData
	Provides convenient access to data stored in a texture. More...
class	Transformation
	Defines a pose, consisting of translation, rotation, and scaling. More...

Enumerations
enum	LightType { PointLight = 0, SpotLight = 1, DirectionalLight = 2 }
	Light source type. More...
enum	MaterialType { Phong = 0, Microfacets = 1, Measured = 2 }
	Material type. More...
enum	FileFormat {   FileFormat_RAW, FileFormat_CSV, FileFormat_PNM, FileFormat_PNG,   FileFormat_PFS, FileFormat_GTA, FileFormat_MAT, FileFormat_HDF5,   FileFormat_Auto }
	File format. More...

Variables
constexpr double	speedOfLight = 299792458
	Speed of light in m/s. More...
constexpr double	elementaryCharge = 0.1602176565
	Elementary charge in Attocoulomb (1e-18 C). More...

Enumeration Type Documentation

FileFormat

enum CamSim::FileFormat

File format.

Enumerator
FileFormat_RAW	Raw binary data (*.raw), plus a text-based header describing the content (*.raw_header)
FileFormat_CSV	Comma-separated values (*.csv)
FileFormat_PNM	Portable anymap (*.pgm or *.ppm)
FileFormat_PNG	Portable Network Graphics (*.png)
FileFormat_PFS	Portable floatmap streams (*.pfs)
FileFormat_GTA	Generic Tagged Arrays (*.gta); requires libgta.
FileFormat_MAT	Matlab files (*.mat); requires libmatio.
FileFormat_HDF5	HDF5 files (*.h5); requires libhdf5.
FileFormat_Auto	Autodetect file format from file name.

LightType

enum CamSim::LightType

Light source type.

Enumerator
PointLight	A point light source.
SpotLight	A spot light source.
DirectionalLight	A directional light source.

MaterialType

enum CamSim::MaterialType

Material type.

Enumerator
Phong	A BRDF model based on modified Phong lighting.
Microfacets	TODO: A BRDF model based on a microfacet model.
Measured	TODO: A BRDF model based on a measurements of a real material.

Variable Documentation

elementaryCharge

constexpr double CamSim::elementaryCharge = 0.1602176565

constexpr

Elementary charge in Attocoulomb (1e-18 C).

speedOfLight

constexpr double CamSim::speedOfLight = 299792458

constexpr

Speed of light in m/s.