TuttleOFX: tuttle::plugin::histogramKeyer::HistogramKeyerOverlay Class Reference

TuttleOFX 1

#include <HistogramKeyerOverlay.hpp>

Inheritance diagram for tuttle::plugin::histogramKeyer::HistogramKeyerOverlay:

Inheritance graph

Collaboration diagram for tuttle::plugin::histogramKeyer::HistogramKeyerOverlay:

Collaboration graph

Public Member Functions
	HistogramKeyerOverlay (OfxInteractHandle handle, OFX::ImageEffect *effect)
	~HistogramKeyerOverlay ()
bool	draw (const OFX::DrawArgs &args)
	the function called to draw in the interact
bool	penDown (const OFX::PenArgs &args)
bool	penUp (const OFX::PenArgs &args)
bool	penMotion (const OFX::PenArgs &args)
bool	keyDown (const OFX::KeyArgs &args)
bool	keyUp (const OFX::KeyArgs &args)
void	displaySelectedAreas (const OfxPointI &fullImgSize, const OfxPointI &imgSize, const OfxRectI &pixelRoD)
void	displaySelectionZone ()
OverlayData &	getOverlayData ()
Data Fields
HistogramKeyerPlugin *	_plugin
interact::InteractInfos	_infos
bool	_penDown
bool	_keyDown
OfxPointI	_origin
OfxPointI	_end
OfxPointI	_squareBegin
OfxPointI	_squareEnd
bool	_isFirstTime
HSLOverlay	_hslParam
RGBOverlay	_rgbParam
Private Types
typedef double	Scalar
typedef OfxRGBColourF	Color
Private Member Functions
void	drawWarning (const Ofx3DPointD &centerPoint, const double ratio)

Detailed Description

Definition at line 20 of file HistogramKeyerOverlay.hpp.

Member Typedef Documentation

typedef OfxRGBColourF tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::Color [private]

Definition at line 23 of file HistogramKeyerOverlay.hpp.

typedef double tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::Scalar [private]

Definition at line 22 of file HistogramKeyerOverlay.hpp.

Constructor & Destructor Documentation

tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::HistogramKeyerOverlay	(	OfxInteractHandle	handle,
		OFX::ImageEffect *	effect
	)

Definition at line 9 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::histogramKeyer::OverlayData::_isDataInvalid, _isFirstTime, _keyDown, _penDown, _plugin, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::addRefOverlayData(), and getOverlayData().

Here is the call graph for this function:

tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::~HistogramKeyerOverlay ( )

Definition at line 23 of file HistogramKeyerOverlay.cpp.

References _plugin, and tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::releaseOverlayData().

Here is the call graph for this function:

Member Function Documentation

void tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::displaySelectedAreas	(	const OfxPointI &	fullImgSize,
		const OfxPointI &	imgSize,
		const OfxRectI &	pixelRoD
	)

Display the selected areas on the clip (color : gray)

Definition at line 339 of file HistogramKeyerOverlay.cpp.

References getOverlayData(), OfxPointI::x, OfxRectI::x1, OfxRectI::x2, OfxPointI::y, OfxRectI::y1, and OfxRectI::y2.

Referenced by draw().

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::displaySelectionZone ( )

Display the selection zone on the clip (color : border gray)

Definition at line 375 of file HistogramKeyerOverlay.cpp.

References _squareBegin, _squareEnd, OfxPointI::x, and OfxPointI::y.

Referenced by draw().

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::draw ( const OFX::DrawArgs & args ) [virtual]

the function called to draw in the interact

< HACK changeClip method doesn't work in nuke when source clip is changed so we have to check size of imgBool all of the time

Todo:: : remove next lines when Nuke curves overlay works

Todo:: : remove next lines when Nuke curves overlay works

Reimplemented from OFX::InteractI.

Definition at line 28 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, _hslParam, tuttle::plugin::histogramKeyer::OverlayData::_isDataInvalid, _isFirstTime, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_isRendering, _keyDown, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramDisplaySelection, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramGlobalDisplaySelection, _penDown, _plugin, _rgbParam, tuttle::plugin::histogramKeyer::OverlayData::clearAll(), tuttle::plugin::histogramKeyer::OverlayData::computeFullData(), displaySelectedAreas(), displaySelectionZone(), tuttle::plugin::histogramKeyer::HSLOverlay::draw(), tuttle::plugin::histogramKeyer::RGBOverlay::draw(), drawWarning(), getOverlayData(), OFX::Clip::getPixelRod(), OFX::Clip::getPixelRodSize(), OFX::BooleanParam::getValue(), OFX::Clip::isConnected(), tuttle::plugin::histogramKeyer::OverlayData::isCurrentTimeModified(), tuttle::plugin::histogramKeyer::OverlayData::isImageSizeModified(), tuttle::plugin::histogramKeyer::kTranslationHSL, tuttle::plugin::histogramKeyer::kTranslationRGB, OFX::InteractArgs::renderScale, OFX::InteractArgs::time, OfxPointI::x, Ofx3DPointD::x, and Ofx3DPointD::y.

Here is the call graph for this function:

void tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::drawWarning	(	const Ofx3DPointD &	centerPoint,
		const double	ratio
	)		`[private]`

Definition at line 397 of file HistogramKeyerOverlay.cpp.

References Ofx3DPointD::x, and Ofx3DPointD::y.

Referenced by draw().

OverlayData & tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::getOverlayData ( )

Get overlay data from plugin

Returns:

Definition at line 428 of file HistogramKeyerOverlay.cpp.

References _plugin, and tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::getOverlayData().

Referenced by displaySelectedAreas(), draw(), HistogramKeyerOverlay(), keyUp(), penDown(), penMotion(), and penUp().

Here is the call graph for this function:

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::keyDown ( const OFX::KeyArgs & args ) [virtual]

Ctrl key is pressed down

Parameters:

args	current arg

Returns:: event capted (y or n)

Reimplemented from OFX::InteractI.

Definition at line 303 of file HistogramKeyerOverlay.cpp.

References _keyDown, OFX::KeyArgs::keySymbol, kOfxKey_Control_L, and kOfxKey_Control_R.

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::keyUp ( const OFX::KeyArgs & args ) [virtual]

Ctrl key is released

Parameters:

args	current arg

Returns:: event capted (y or n)

Reimplemented from OFX::InteractI.

Definition at line 319 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::histogramKeyer::OverlayData::_isDataInvalid, _keyDown, _penDown, _plugin, getOverlayData(), OFX::KeyArgs::keySymbol, kOfxKey_Control_L, kOfxKey_Control_R, and OFX::ImageEffect::redrawOverlays().

Here is the call graph for this function:

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penDown ( const OFX::PenArgs & args ) [virtual]

When the pen/mouse is clicking down

Parameters:

args	current arg

Returns:: event capted (y or n)

Reimplemented from OFX::InteractI.

Definition at line 156 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, _end, _keyDown, _origin, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramDisplaySelection, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramSelectionMode, _penDown, _plugin, _squareBegin, _squareEnd, tuttle::plugin::histogramKeyer::OverlayData::clearSelection(), getOverlayData(), OFX::Clip::getPixelRodSize(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), OFX::PenArgs::penPosition, OFX::InteractArgs::renderScale, OFX::InteractArgs::time, OfxPointI::x, OfxPointD::x, OfxPointI::y, and OfxPointD::y.

Here is the call graph for this function:

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penMotion ( const OFX::PenArgs & args ) [virtual]

When the pen/mouse is under motion

Parameters:

args	current arg

Returns:: event capted (y or n)

Reimplemented from OFX::InteractI.

Definition at line 118 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, tuttle::plugin::histogramKeyer::OverlayData::_imgBool, _keyDown, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramSelectionMode, _penDown, _plugin, _squareEnd, getOverlayData(), OFX::Clip::getPixelRod(), OFX::ChoiceParam::getValue(), OFX::PenArgs::penPosition, OFX::InteractArgs::renderScale, OFX::InteractArgs::time, OfxPointI::x, OfxPointD::x, OfxRectI::x1, OfxPointI::y, OfxPointD::y, and OfxRectI::y1.

Here is the call graph for this function:

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::penUp ( const OFX::PenArgs & args ) [virtual]

When the pen/mouse is clicking up

Parameters:

args	current arg

Returns:: event capted (y or n)

Reimplemented from OFX::InteractI.

Definition at line 205 of file HistogramKeyerOverlay.cpp.

References tuttle::plugin::ImageEffectGilPlugin::_clipSrc, _end, tuttle::plugin::histogramKeyer::OverlayData::_imgBool, tuttle::plugin::histogramKeyer::OverlayData::_isDataInvalid, _keyDown, _origin, tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::_paramSelectionMode, _penDown, _plugin, getOverlayData(), OFX::Clip::getPixelRod(), OFX::Clip::getPixelRodSize(), OFX::ChoiceParam::getValue(), OFX::PenArgs::penPosition, OFX::ImageEffect::redrawOverlays(), OFX::InteractArgs::renderScale, OFX::InteractArgs::time, OfxPointI::x, OfxPointD::x, OfxRectI::x1, OfxPointI::y, OfxPointD::y, and OfxRectI::y1.

Here is the call graph for this function:

Field Documentation

OfxPointI tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_end

Definition at line 33 of file HistogramKeyerOverlay.hpp.

Referenced by penDown(), and penUp().

HSLOverlay tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_hslParam

Definition at line 40 of file HistogramKeyerOverlay.hpp.

Referenced by draw().

interact::InteractInfos tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_infos

Definition at line 28 of file HistogramKeyerOverlay.hpp.

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_isFirstTime

Definition at line 37 of file HistogramKeyerOverlay.hpp.

Referenced by draw(), and HistogramKeyerOverlay().

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_keyDown

Definition at line 31 of file HistogramKeyerOverlay.hpp.

Referenced by draw(), HistogramKeyerOverlay(), keyDown(), keyUp(), penDown(), penMotion(), and penUp().

OfxPointI tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_origin

Definition at line 32 of file HistogramKeyerOverlay.hpp.

Referenced by penDown(), and penUp().

bool tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_penDown

Definition at line 30 of file HistogramKeyerOverlay.hpp.

Referenced by draw(), HistogramKeyerOverlay(), keyUp(), penDown(), penMotion(), and penUp().

HistogramKeyerPlugin* tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_plugin

Definition at line 27 of file HistogramKeyerOverlay.hpp.

Referenced by draw(), getOverlayData(), HistogramKeyerOverlay(), keyUp(), penDown(), penMotion(), penUp(), and ~HistogramKeyerOverlay().

RGBOverlay tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_rgbParam

Definition at line 41 of file HistogramKeyerOverlay.hpp.

Referenced by draw().

OfxPointI tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_squareBegin

Definition at line 34 of file HistogramKeyerOverlay.hpp.

Referenced by displaySelectionZone(), and penDown().

OfxPointI tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::_squareEnd

Definition at line 35 of file HistogramKeyerOverlay.hpp.

Referenced by displaySelectionZone(), penDown(), and penMotion().

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

plugins/image/process/color/HistogramKeyer/src/HistogramKeyerOverlay.hpp
plugins/image/process/color/HistogramKeyer/src/HistogramKeyerOverlay.cpp

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by 1.7.5.1