omni::BlendSettings Class Reference

Common blend mask settings for the all tunings in a session. More...

#include <BlendSettings.h>

Public Types
enum	ColorMode { ColorMode::COLORED, ColorMode::WHITE }
	Blend Mask display colorColorMode. More...

Public Member Functions
ColorMode	colorMode () const
	Return colorColorMode of blend mask colorColorMode. More...
void	setColorMode (ColorMode)
	Set blend mask colorColorMode. More...
float	inputOpacity () const
	Return input opacity of blend mask. More...
void	setInputOpacity (float _input)
	Opacity of input when in blend mask colorColorMode. More...
bool	showInWarpMode () const
	Show blend mask in warp colorColorMode. More...
void	setShowInWarpMode (bool)
	Set flag if blend mask is visible in warp colorColorMode. More...
void	fromStream (QDataStream &)
	Deserialize from stream. More...
void	toStream (QDataStream &) const
	Serialize to stream. More...

Private Attributes
ColorMode	colorMode_ = ColorMode::COLORED
bool	showInWarpMode_ = false
float	inputOpacity_ = 0.0

Friends
bool	operator== (BlendSettings const &, BlendSettings const &)
	Test for equality. More...

Detailed Description

Common blend mask settings for the all tunings in a session.

Member Enumeration Documentation

enum omni::BlendSettings::ColorMode

strong

Blend Mask display colorColorMode.

Enumerator
COLORED
WHITE

      {
        COLORED, // Displays blend mask with color of tuning
        WHITE    // Displays white blend mask
      };

Member Function Documentation

BlendSettings::ColorMode omni::BlendSettings::colorMode

(

)

const

Return colorColorMode of blend mask colorColorMode.

    {
        return colorMode_;
    }

void omni::BlendSettings::fromStream

(

QDataStream &

_is

)

Deserialize from stream.

                                                   {
        PropertyMap _map;
        _is >> _map;

        colorMode_ = util::intToEnum<ColorMode>(_map.getValue<int>("colorMode"));
        _map.get("showInWarpMode",showInWarpMode_);
        _map.get("inputOpacity",inputOpacity_);
    }

float omni::BlendSettings::inputOpacity

(

)

const

Return input opacity of blend mask.

    {
        return inputOpacity_;
    }

void omni::BlendSettings::setColorMode

(

ColorMode

_colorMode

)

Set blend mask colorColorMode.

    {
        colorMode_ = _colorMode;
    }

void omni::BlendSettings::setInputOpacity

(

float

_input

)

Opacity of input when in blend mask colorColorMode.

    {
        inputOpacity_ = _inputOpacity;
    }

void omni::BlendSettings::setShowInWarpMode

(

bool

_showInWarpMode

)

Set flag if blend mask is visible in warp colorColorMode.

Set flag if blend mask is visible in warp colorMode.

                                                              {
        showInWarpMode_ = _showInWarpMode;
    }

bool omni::BlendSettings::showInWarpMode

(

)

const

Show blend mask in warp colorColorMode.

Show blend mask in warp colorMode.

                                             {
        return showInWarpMode_;
    }

void omni::BlendSettings::toStream

(

QDataStream &

_os

)

const

Serialize to stream.

                                                       {
        PropertyMap _map;
        _map("colorMode",util::enumToInt(colorMode_));
        _map("showInWarpMode",showInWarpMode_);
        _map("inputOpacity",inputOpacity_);
        _os << _map;
    }

Friends And Related Function Documentation

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

friend

Test for equality.

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

Field Documentation

ColorMode omni::BlendSettings::colorMode_ = ColorMode::COLORED

private

float omni::BlendSettings::inputOpacity_ = 0.0

private

bool omni::BlendSettings::showInWarpMode_ = false

private

---

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

• include/omni/BlendSettings.h
• src/lib/BlendSettings.cpp