tracktion::engine::PluginWindowState Struct Reference

#include <tracktion_PluginWindowState.h>

Inheritance diagram for tracktion::engine::PluginWindowState:

Public Member Functions
	PluginWindowState (Edit &)
void	incRefCount ()
void	decRefCount ()
bool	isWindowShowing () const
void	showWindowExplicitly ()
void	showWindowIfTemporarilyHidden ()
void	recreateWindowIfShowing ()
void	closeWindowExplicitly ()
void	hideWindowForShutdown ()
void	hideWindowTemporarily ()
juce::Point< int >	choosePositionForPluginWindow ()
void	pluginClicked (const juce::MouseEvent &)
	Can be used to manually fire a mouse event into the window.

Static Public Member Functions
static void	hideAllWindowsTemporarily (Edit &)
	Calls hideWindowTemporarily() for any windows of plugins in this edit.
static void	showAllTemporarilyHiddenWindows (Edit &)
	Calls showWindowIfTemporarilyHidden() for all plugins in this edit.
static void	showOrHideAllWindows (Edit &)
	If any windows are showing, hide them all temporarily, otherwise bring back any temporarily hidden ones.
static std::vector< PluginWindowState * >	getAllWindows (Edit &)
	Finds all windows for all plugins in this edit.
static uint32_t	getNumOpenWindows (Edit &)
	Counts the number of visible windows for plugins in this edit.

Public Attributes
Edit &	edit
Engine &	engine
std::unique_ptr< juce::Component >	pluginWindow
int	windowShowerCount = 0
bool	windowLocked
bool	temporarilyHidden = false
bool	wasExplicitlyClosed = false
std::optional< juce::Rectangle< int > >	lastWindowBounds
juce::Time	windowOpenTime

Constructor & Destructor Documentation

PluginWindowState()

tracktion::engine::PluginWindowState::PluginWindowState

(

Edit &

)

Member Function Documentation

incRefCount()

void tracktion::engine::PluginWindowState::incRefCount

(

)

decRefCount()

void tracktion::engine::PluginWindowState::decRefCount

(

)

isWindowShowing()

bool tracktion::engine::PluginWindowState::isWindowShowing

(

)

const

showWindowExplicitly()

void tracktion::engine::PluginWindowState::showWindowExplicitly

(

)

showWindowIfTemporarilyHidden()

void tracktion::engine::PluginWindowState::showWindowIfTemporarilyHidden

(

)

recreateWindowIfShowing()

void tracktion::engine::PluginWindowState::recreateWindowIfShowing

(

)

closeWindowExplicitly()

void tracktion::engine::PluginWindowState::closeWindowExplicitly

(

)

hideWindowForShutdown()

void tracktion::engine::PluginWindowState::hideWindowForShutdown

(

)

hideWindowTemporarily()

void tracktion::engine::PluginWindowState::hideWindowTemporarily

(

)

hideAllWindowsTemporarily()

static void tracktion::engine::PluginWindowState::hideAllWindowsTemporarily ( Edit &  )

static

Calls hideWindowTemporarily() for any windows of plugins in this edit.

showAllTemporarilyHiddenWindows()

static void tracktion::engine::PluginWindowState::showAllTemporarilyHiddenWindows ( Edit &  )

static

Calls showWindowIfTemporarilyHidden() for all plugins in this edit.

showOrHideAllWindows()

static void tracktion::engine::PluginWindowState::showOrHideAllWindows ( Edit &  )

static

If any windows are showing, hide them all temporarily, otherwise bring back any temporarily hidden ones.

getAllWindows()

static std::vector< PluginWindowState * > tracktion::engine::PluginWindowState::getAllWindows ( Edit &  )

static

Finds all windows for all plugins in this edit.

getNumOpenWindows()

static uint32_t tracktion::engine::PluginWindowState::getNumOpenWindows ( Edit &  )

static

Counts the number of visible windows for plugins in this edit.

choosePositionForPluginWindow()

juce::Point< int > tracktion::engine::PluginWindowState::choosePositionForPluginWindow

(

)

pluginClicked()

void tracktion::engine::PluginWindowState::pluginClicked

(

const juce::MouseEvent &

)

Can be used to manually fire a mouse event into the window.

Member Data Documentation

edit

Edit& tracktion::engine::PluginWindowState::edit

engine

Engine& tracktion::engine::PluginWindowState::engine

pluginWindow

std::unique_ptr<juce::Component> tracktion::engine::PluginWindowState::pluginWindow

windowShowerCount

int tracktion::engine::PluginWindowState::windowShowerCount = 0

windowLocked

bool tracktion::engine::PluginWindowState::windowLocked

temporarilyHidden

bool tracktion::engine::PluginWindowState::temporarilyHidden = false

wasExplicitlyClosed

bool tracktion::engine::PluginWindowState::wasExplicitlyClosed = false

lastWindowBounds

std::optional<juce::Rectangle<int> > tracktion::engine::PluginWindowState::lastWindowBounds

windowOpenTime

juce::Time tracktion::engine::PluginWindowState::windowOpenTime

---

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

• tracktion_PluginWindowState.h