ICustomView Class Reference

Custom View interface to allow plugin core to create safe communication channels with GUI custom view objects. MANY uses! More...

#include <pluginstructures.h>

Inheritance diagram for ICustomView:

Public Member Functions
virtual void	updateView ()=0
virtual void	pushDataValue (double data)
virtual void	sendMessage (void *data)

Detailed Description

Custom View interface to allow plugin core to create safe communication channels with GUI custom view objects. MANY uses!

Author

Will Pirkle http://www.willpirkle.com

Remarks

This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version

Revision : 1.0

Date

Date : 2018 / 09 / 7

Member Function Documentation

pushDataValue()

virtual void ICustomView::pushDataValue ( double  data )

inlinevirtual

push a new data value into the view; call this repeatedly to push multiple values
The derived class should implement a lock-free ring buffer to store the data.
If you need to move giant amounts of data, you might want to alter this interface
and add a mechanism to copy a pointer to a lock-free buffer or some other
thread-safe mechanism that you design

Reimplemented in CustomViewController, CustomViewController, CustomViewController, Steinberg::Vst::ASPiK::CustomViewController, and VSTGUI::WaveView.

sendMessage()

virtual void ICustomView::sendMessage ( void *  data )

inlinevirtual

send a message into the view The derived class should implement a lock-free ring buffer to store the message.
and handle all messaging in a thread-safe manner
argument: void* data
The argument is any struct, object, or variable pointer cloaked as a void*
Note that since the argument is variable and the programmer sets it
you can send information back to the plugin via this call as well
!!! — BE CAREFUL and don't do anything unsafe with this messaging system — !!!

Reimplemented in CustomViewController, CustomViewController, CustomViewController, Steinberg::Vst::ASPiK::CustomViewController, VSTGUI::CustomKnobView, VSTGUI::CustomTextLabel, and VSTGUI::CustomOptionMenu.

updateView()

virtual void ICustomView::updateView ( )

pure virtual

function to tell the view to redraw after pushing data to it, or manipulating it

Implemented in CustomViewController, CustomViewController, CustomViewController, Steinberg::Vst::ASPiK::CustomViewController, VSTGUI::WaveView, VSTGUI::CustomKnobView, VSTGUI::CustomTextLabel, and VSTGUI::CustomOptionMenu.

---

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

• C:/RackAFX_v7/ASPIK_Doxygen/PluginTemplate/project_source/source/PluginKernel/pluginstructures.h