omni Namespace Reference

Header to document namespaces. More...

Namespaces
	canvas
	Namespace for canvases.
	exception
	geometry
	Namespace for geometry functionality.
	input
	Namespace for inputs.
	mapping
	Namespace for mappings.
	media
	patch
	proj
	Namespace for projector related classes.
	render
	serialization
	Namespace for serialization functionality.
	ui
	Namespace for user interface elements and widgets.
	util
	visual
	Namespace for OpenGL visualization.

Data Structures
class	BlendBrush
	BlendBrush for drawing on the blendmask Holds an internal pixel buffer. More...
class	BlendMask
	A blend mask consists of an edge mask and stroke mask with a brush Edge mask and stroke mask are stored in different buffers. More...
class	BlendSettings
	Common blend mask settings for the all tunings in a session. More...
struct	Buffer
	A buffer holds an w x h pixel array. More...
class	Exception
	Base class for all exception. Throws a message with QString type. More...
struct	Id
	Id type for classes An Id must only contain alpha numerical characters and must begin with a letter. More...
class	LengthUnit
	An encapsulation for length units. More...
struct	RGBAFloat
	RGBA float pixel type. More...
struct	PixelConverter
	Template for converting IN pixel type to OUT pixel type. More...
struct	PixelConverter< IN, QColor >
	Convert to QColor. More...
struct	PixelConverter< uint8_t, QColor >
	Convert byte value to grayscale QColor. More...
struct	PixelConverter< RGBAFloat, QColor >
	Convert RGBA to QColor. More...
struct	PixelConverter< int, QColor >
	Convert int value to grayscale QColor. More...
struct	PixelConverter< unsigned int, QColor >
	Convert int value to grayscale QColor. More...
class	PluginInfo
	Holds meta information about a plugins Only plugin loader can construct a plugin info. More...
class	PluginLoader
	PluginLoader singleton to load plugins from multiple directories Plugins have the extension omnix. More...
class	Session
	A session consists of a canvas, a mapping, a list of tunings and one or several inputs. More...
class	TypeIdInterface
	Abstract Interface with a single virtual member function which returns. More...
class	TypeIdMemory
	Helper class to store objects with a certain type id in QBuffer Used in GUI for storing previously selected mapping or canvas types. More...
class	WarpGrid
	A warp grid is a 2D bezier grid with MxN points Default size 6x6 points. Selected points are also stored: More...
class	WarpPoint
	A Warp defines a bezier point with one position and two handles / * Also stores flag if it is selected. More...

Typedefs
typedef canvas::Interface	Canvas
typedef canvas::Factory	CanvasFactory
using	AbstractFactory = boostx::factory< INTERFACE, TypeInfo, ARGS...>
typedef std::set< Id >	IdSet
	Id set typedef. More...
typedef input::Interface	Input
typedef input::Factory	InputFactory
typedef input::List	InputList
typedef mapping::Interface	Mapping
typedef mapping::Factory	MappingFactory
typedef patch::Interface	Patch
typedef patch::Factory	PatchFactory
typedef patch::List	PatchList
typedef proj::Setup	ProjectorSetup
typedef Buffer< RGBAFloat >	RenderBuffer
typedef serialization::Interface	SerializationInterface

Functions
bool	operator== (BlendBrush const &_lhs, BlendBrush const &_rhs)
bool	operator== (BlendMask const &_lhs, BlendMask const &_rhs)
bool	operator== (BlendSettings const &_lhs, BlendSettings const &_rhs)
bool	operator== (LengthUnit const &_lhs, LengthUnit const &_rhs)
	Test for equality. ScreenSetup is ignored. More...
bool	operator== (Session const &_lhs, Session const &_rhs)
bool	operator== (WarpGrid const &_lhs, WarpGrid const &_rhs)
bool	operator== (WarpPoint const &_lhs, WarpPoint const &_rhs)
	BOOSTX_DECL_TYPE_INFO (TypeInfo, Id, typeId, getTypeId) template< typename INTERFACE
	Alias template for factories. More...
template<typename IN , typename OUT >
void	convertPixel (const IN &_in, OUT &_out)
	Convert IN to OUT pixel. More...
template<typename OUT , typename IN >
OUT	convertPixel (const IN &_in)
	Convert pixel IN to OUT pixel and return OUT. More...

Detailed Description

Header to document namespaces.

Main namespace

Typedef Documentation

using omni::AbstractFactory = typedef boostx::factory<INTERFACE, TypeInfo, ARGS ...>

typedef canvas::Interface omni::Canvas

typedef canvas::Factory omni::CanvasFactory

typedef std::set<Id> omni::IdSet

Id set typedef.

typedef input::Interface omni::Input

typedef input::Factory omni::InputFactory

typedef input::List omni::InputList

typedef mapping::Interface omni::Mapping

typedef mapping::Factory omni::MappingFactory

typedef patch::Interface omni::Patch

typedef patch::Factory omni::PatchFactory

typedef patch::List omni::PatchList

typedef proj::Setup omni::ProjectorSetup

typedef Buffer<RGBAFloat> omni::RenderBuffer

typedef serialization::Interface omni::SerializationInterface

Function Documentation

omni::BOOSTX_DECL_TYPE_INFO	(	TypeInfo	,
		Id	,
		typeId	,
		getTypeId
	)

Alias template for factories.

template<typename IN , typename OUT >

void omni::convertPixel	(	const IN &	_in,
		OUT &	_out
	)

Convert IN to OUT pixel.

                                              {
    PixelConverter<IN, OUT>()(_in, _out);
  }

template<typename OUT , typename IN >

OUT omni::convertPixel

(

const IN &

_in

)

Convert pixel IN to OUT pixel and return OUT.

                                  {
    OUT _out;

    convertPixel(_in, _out);
    return _out;
  }

bool omni::operator==	(	BlendSettings const &	_lhs,
		BlendSettings const &	_rhs
	)

                                                                          {
        return
            OMNI_TEST_MEMBER_EQUAL(colorMode_) &&
            OMNI_TEST_MEMBER_EQUAL(showInWarpMode_) &&
            OMNI_TEST_MEMBER_EQUAL(inputOpacity_);
    }

bool omni::operator==	(	WarpPoint const &	_lhs,
		WarpPoint const &	_rhs
	)

    {
        return
            OMNI_TEST_MEMBER_EQUAL(pos_) &&
            OMNI_TEST_MEMBER_EQUAL(c1_) &&
            OMNI_TEST_MEMBER_EQUAL(c2_) &&
            OMNI_TEST_MEMBER_EQUAL(selected_);
    }

bool omni::operator==	(	LengthUnit const &	_lhs,
		LengthUnit const &	_rhs
	)

Test for equality. ScreenSetup is ignored.

                                                                  {
    return OMNI_TEST_MEMBER_EQUAL(type_);
  }

bool omni::operator==	(	BlendMask const &	_lhs,
		BlendMask const &	_rhs
	)

  {
    return
      OMNI_TEST_MEMBER_EQUAL(rect_) &&
      OMNI_TEST_MEMBER_EQUAL(gamma_) &&
      OMNI_TEST_MEMBER_EQUAL(brush_) &&
      OMNI_TEST_MEMBER_EQUAL(strokeBuffer_);
  }

bool omni::operator==	(	Session const &	_lhs,
		Session const &	_rhs
	)

  {
    return
      OMNI_TEST_MEMBER_EQUAL(tunings_) &&
      OMNI_TEST_PTR_MEMBER_EQUAL(mapping_) &&
      OMNI_TEST_MEMBER_EQUAL(inputs_) &&
      OMNI_TEST_PTR_MEMBER_EQUAL(canvas_) &&
      OMNI_TEST_MEMBER_EQUAL(mode_) &&
      OMNI_TEST_MEMBER_EQUAL(scene_) &&
      OMNI_TEST_MEMBER_EQUAL(blendSettings_) &&
      OMNI_TEST_MEMBER_EQUAL(exportSettings_)
      ;
  }

bool omni::operator==	(	WarpGrid const &	_lhs,
		WarpGrid const &	_rhs
	)

    {
        return
            OMNI_TEST_MEMBER_EQUAL(horizontal_) &&
            OMNI_TEST_MEMBER_EQUAL(vertical_) &&
            OMNI_TEST_MEMBER_EQUAL(points_);
    }

bool omni::operator==	(	BlendBrush const &	_lhs,
		BlendBrush const &	_rhs
	)

    {
        return
            OMNI_TEST_MEMBER_EQUAL(size_) &&
            OMNI_TEST_MEMBER_EQUAL(feather_) &&
            OMNI_TEST_MEMBER_EQUAL(opacity_) &&
            OMNI_TEST_MEMBER_EQUAL(invert_);
    }