The Vuo Editor's QApplication subclass.
Singleton. Provides the standard menu bar.
Definition at line 30 of file VuoEditor.hh.
Public Types | |
enum | subscriptionLevel { CommunityUser, ProSubscriber } |
Possible user subscription levels: More... | |
Public Slots | |
void | about (void) |
Displays an "About" box. More... | |
void | newComposition (void) |
Creates an empty composition editor window. More... | |
void | newCompositionWithProtocol (void) |
Creates an empty composition editor window with the active protocol template indicated by the sender. More... | |
void | newCompositionWithTemplate (void) |
Creates an empty composition editor window with the active window template indicated by the sender. More... | |
void | openUrl (const QString &url) |
Determines what type of url has been provided: More... | |
void | openFile (void) |
Displays an "Open File" dialog, and if a composition or shader is selected, opens it in an editor window. More... | |
void | openExampleComposition (QString filename, VuoNodeSet *nodeSet, string nodeClassToHighlight) |
Opens a composition editor window for an example composition. More... | |
void | showNodeLibrary (void) |
Shows the Node Class Library browser and focuses its text filter. More... | |
void | addFileToAllOpenRecentFileMenus (QString filePath) |
Adds the file at filePath to the application-global "File > Open Recent" menu list, and synchronizes each editor window's "File > Open Recent" menu with the global version. More... | |
void | addFileToRecentlyClosedList (QString filePath) |
Adds the provided filePath to the list of composition files that have been closed during this editor session since the list was last cleared. More... | |
void | clearAllOpenRecentFileMenus () |
Clears the list of recently opened files from the application-global "File > Open Recent" menu list, and synchronizes each editor window's "File > Open Recent" menu with the global version. More... | |
void | pruneAllOpenRecentFileMenus () |
Prunes the list of recently opened files from the application-global "File > Open Recent" menu list, removing any that no longer exist, and synchronizes each editor window's "File > Open Recent" menu with the global version. More... | |
void | synchronizeOpenRecentFileMenus () |
Synchronizes each editor window's "File > Open Recent" menu with the global version, and saves the updated file list to the stored application settings. More... | |
void | showNodeSetDocumentationFromUrl (const QUrl &url) |
Activates the "vuo-nodeset" URL handler to handle the input url . More... | |
void | showNodeDocumentationFromUrl (const QUrl &url) |
Activates the "vuo-node" URL handler to handle the input url . More... | |
void | openFileFromSenderData () |
Opens the local file at the path associated with the sender action that triggered the call to this slot. More... | |
void | removeFileFromSenderData () |
Removes (by moving to the Trash) the file at the path associated with the sender action that triggered the call to this slot. More... | |
void | openExternalUrlFromSenderData () |
Uses an external browser to open the URL associated with the sender action that triggered the call to this slot. More... | |
void | openExampleCompositionFromUrl (const QUrl &url) |
Activates the "vuo-example" URL handler to handle the input url . More... | |
void | openMostRecentFile () |
Opens the most recent file. More... | |
void | openRandomExample () |
Opens a random example composition. More... | |
void | quitCleanly () |
Initiates final cleanup, and attempts to close all windows. More... | |
void | continueQuit (QMainWindow *window) |
Called by VuoEditorWindow or VuoCodeWindow after the user has confirmed a window-close request. More... | |
void | cancelQuit () |
Called by VuoEditorWindow after the user has cancelled a window-close request. More... | |
Q_INVOKABLE void | openHelpBook () |
Launches HelpViewer.app and opens the Vuo Manual to the introduction / table of contents. More... | |
Signals | |
void | globalNodeLibraryStateChanged (VuoNodeLibrary::nodeLibraryState newState, VuoNodeLibrary *floater, bool previousFloaterDestroyed) |
Emitted after updateGlobalNodeLibraryState() is called. More... | |
void | activeApplicationStateChanged (bool active) |
Emitted when the application gains or loses focus. More... | |
void | darkInterfaceToggled (bool isDark) |
Emitted when the user changes the "Dark Interface" menu item. More... | |
void | showGridToggled () |
Emitted when the user toggles the "Grid > Lines" or "Grid > Points" menu item. More... | |
void | canvasOpacityChanged () |
Emitted when the user selects a new "Canvas Transparency" menu item. More... | |
void | applicationWillHide () |
Emitted when macOS hides the application. More... | |
void | applicationDidUnhide () |
Emitted when macOS unhides the application. More... | |
Public Member Functions | |
VuoEditor (int &argc, char *argv[]) | |
Sets up the Vuo Editor at launch time. More... | |
~VuoEditor () | |
Destructor. More... | |
Q_INVOKABLE void | processQueuedCompositionsToOpen () |
Iterates through the queue of pending files to open and tries to open each one. More... | |
Q_INVOKABLE void | reevaluateWelcomePrecedence () |
Allow pending file-open events to override the welcome window display if the welcome window is in a state where it is allowed to be closed. More... | |
string | getUserName () |
Returns the username associated with this editor session. More... | |
string | getStoredUserProfileURL () |
Returns the user profile URL associated with this editor session. More... | |
QString | getSubcompositionPrefix () |
Returns the string to be used as the subcomposition prefix for this user. More... | |
QString | getDefaultSubcompositionPrefix () |
Returns the default string to be used as the subcomposition prefix for this user if it has not been customized by the user. More... | |
map< QString, QString > | getUberExampleCompositions () |
Returns a map containing the uberexamplecompositions to be displayed at the top level within the "File > Open Example" menu, and the node sets to which they belong. More... | |
map< QString, QString > | getExampleCompositionsForProtocol (VuoProtocol *protocol) |
Returns a map containing the example compositions to be listed in association with the provided protocol in the "File > Open Example" menu, and the node sets to which they belong. More... | |
int | getPreferredNodeDocumentationPanelHeight () |
Returns the preferred node documentation panel height as indicated in stored user preferences and/or actions performed since the stored preferences were last applied. More... | |
int | getPreferredNodeLibraryWidth () |
Returns the preferred node library width as indicated in stored user preferences and/or actions performed since the stored preferences were last applied. More... | |
void | highlightNewNodeClassInAllLibraries (string nodeClassName) |
Highlights the requested new node class in all visible node libraries where it is listed, via callback made by each node library's module manager once installation has completed. More... | |
void | updateSubcompositionPrefix (QString prefix) |
Sets the global subcomposition prefix to the value provided; stores the provided value as a preference in the settings. More... | |
void | updateGlobalShaderDocumentationVisibility (bool isVisible) |
Updates the global shader documentation setting to match isVisible. More... | |
bool | getGlobalShaderDocumentationVisibility () |
Returns the current global shader documentation setting. More... | |
void | getGlobalMovieExportSettings (int &width, int &height, double &time, double &duration, double &framerate, int &spatialSupersample, int &temporalSupersample, float &shutterAngle, QString &imageFormat, double &quality) |
Returns the current global movie export settings. More... | |
string | getResourceDirectoryForNodeSet (string nodeSetName) |
Returns the resource directory associated with the provided nodeSetName . More... | |
void | setResourceDirectoryForNodeSet (string nodeSetName, string directory) |
Sets the resource directory associated with the provided nodeSetName to the provided directory . More... | |
void | generateMainHtmlPageForNodeSet (VuoNodeSet *nodeSet, string saveFileName, bool publishInternalVuoLinks) |
Generates the main HTML documentation page for the provided nodeSet , and saves it at the provided saveFileName . More... | |
void | generateNodeClassHtmlPagesForNodeSet (VuoNodeSet *nodeSet, string saveDir, bool publishInternalVuoLinks) |
Generates the HTML documentation pages for non-deprecated node classes belonging to the provided nodeSet , and saves them in provided saveDir . More... | |
VuoSubcompositionMessageRouter * | getSubcompositionRouter (void) |
Returns the subcomposition message router shared by all open compositions. More... | |
VuoCompilerDriver * | getBuiltInDriverForProtocol (VuoProtocol *protocol) |
Returns the built-in driver for the provided protocol , or NULL if none. More... | |
dispatch_queue_t | getDocumentationQueue () |
Returns the dispatch queue to be used for documentation-related tasks, such as extracting resources from node set archives. More... | |
bool | isNodeLibraryCurrentlyDocked () |
Returns true if the node library is docked, or false if it is floating. More... | |
void | registerOpenDocument (QMainWindow *window) |
Updates the application UI immediately (on creation of window) and when window is destroyed. More... | |
VuoEditorWindow * | newCompositionWithContent (string content, string compositionDir="") |
Creates a composition editor window with the provided content. More... | |
QMainWindow * | openFileWithName (QString filename, bool addToRecentFileMenu=true) |
Opens a composition editor window with the specified filename . More... | |
void | populateNewCompositionWithTemplateMenu (QMenu *m) |
Populates the provided menu m with the editor's built-in templates. More... | |
void | populateNewShaderMenu (QMenu *m) |
Populates the provided menu with the templates for shaders. More... | |
void | populateCanvasTransparencyMenu (QMenu *m) |
Populates the provided menu m with items related to canvas transparency. More... | |
void | populateWindowMenu (QMenu *m, QMainWindow *currentWindow) |
Populates the provided menu with window-related items, including the list of open documents. More... | |
void | populateHelpMenu (QMenu *m) |
Populates the provided menu m with support-related items. More... | |
bool | isInterfaceDark (void) |
Returns true if the user interface is in dark mode. More... | |
int | getCanvasOpacity (void) |
Returns the current opacity level of the canvas, where 0 is fully transparent and 255 is fully opaque. More... | |
Q_INVOKABLE QStringList | recentFiles () |
Returns the list of recently-opened files. More... | |
Static Public Member Functions | |
static void | setDocumentationGenerationDirectory (string dir) |
Sets the directory in which to save generated node documentation. More... | |
static QString | getDefaultCompositionStorageDirectory () |
Returns the default directory to be used for opening and saving Vuo compositions. More... | |
static string | removeVuoLinks (string markdownText) |
Filters out internal vuo-node:// and vuo-nodeset:// links within the provided markdownText , encapsulating the previously linked text in backticks. More... | |
static QString | getURLForExampleComposition (QString compositionName, QString nodeSetName) |
Returns the example composition URL corresponding to the example composition with the provided name and node set. More... | |
static QString | getVuoManualURL () |
Returns the path of the locally bundled Vuo manual if it exists, or the URL of the manual hosted on vuo.org otherwise. More... | |
static QString | getClipboardText () |
Returns the text content of the clipboard, or the empty string if the clipboard does not contain text content. More... | |
static QString | generateHtmlDocumentationStyles (bool forBrowser=true, bool isDark=false) |
Returns the HTML <style> block for use in node set and node documentation. More... | |
Public Attributes | |
QAction * | showGridLinesAction |
Toggles grid line rendering. More... | |
QAction * | showGridPointsAction |
Toggles grid point rendering. More... | |
QAction * | snapToGridAction |
Toggles grid snapping. More... | |
QActionGroup * | canvasTransparencyOptions |
Actions for changing canvas transparency. More... | |
QAction * | canvasTransparencyNoneAction |
Makes the canvas opaque. More... | |
QAction * | canvasTransparencySlightAction |
Makes the canvas slightly transparent. More... | |
QAction * | canvasTransparencyHighAction |
Makes the canvas highly transparent. More... | |
Static Public Attributes | |
static const QString | vuoHelpBookScheme = "vuo-help" |
The URL scheme used for opening a section of the user manual. More... | |
static const QString | vuoNodeSetDocumentationScheme = "vuo-nodeset" |
The URL scheme used for opening node set documentation. More... | |
static const QString | vuoNodeDocumentationScheme = "vuo-node" |
The URL scheme used for opening node documentation. More... | |
static const QString | vuoExampleCompositionScheme = "vuo-example" |
The URL scheme used for opening example compositions. More... | |
static const QString | vuoExampleHighlightedNodeClassQueryItem = "nodeClass" |
The query item expected to indicate what node class to highlight within an example composition. More... | |
static const QString | vuoCompositionFileExtension = "vuo" |
The file extension for Vuo compositions. More... | |
static const QString | vuoNodeClassFileExtension = "vuonode" |
The file extension for Vuo node classes. More... | |
static const QString | vuoTutorialURL = "https://vuo.org/tutorials" |
The URL for Vuo tutorial videos. More... | |
Protected Member Functions | |
bool | event (QEvent *e) VuoWarnUnusedResult |
Reimplements QApplication::event(), to handle application-wide events. More... | |
Friends | |
class | TestVuoEditor |
Possible user subscription levels:
Definition at line 35 of file VuoEditor.hh.
|
explicit |
Sets up the Vuo Editor at launch time.
Definition at line 87 of file VuoEditor.cc.
VuoEditor::~VuoEditor | ( | ) |
Destructor.
Definition at line 512 of file VuoEditor.cc.
|
slot |
Displays an "About" box.
Definition at line 748 of file VuoEditor.cc.
|
signal |
Emitted when the application gains or loses focus.
|
slot |
Adds the file at filePath
to the application-global "File > Open Recent" menu list, and synchronizes each editor window's "File > Open Recent" menu with the global version.
Definition at line 2100 of file VuoEditor.cc.
|
slot |
Adds the provided filePath
to the list of composition files that have been closed during this editor session since the list was last cleared.
Definition at line 2110 of file VuoEditor.cc.
|
signal |
Emitted when macOS unhides the application.
|
signal |
Emitted when macOS hides the application.
|
slot |
Called by VuoEditorWindow after the user has cancelled a window-close request.
If a quit is in progress, it is cancelled (by clearing the list of windows awaiting user action), and the node library is reenabled.
Definition at line 625 of file VuoEditor.cc.
|
signal |
Emitted when the user selects a new "Canvas Transparency" menu item.
|
slot |
Clears the list of recently opened files from the application-global "File > Open Recent" menu list, and synchronizes each editor window's "File > Open Recent" menu with the global version.
Definition at line 2120 of file VuoEditor.cc.
|
slot |
Called by VuoEditorWindow or VuoCodeWindow after the user has confirmed a window-close request.
If a quit is in progress, the specified window is removed from the list of windows awaiting user action. Then we try closing the next window (or if the list is now empty, we really quit).
Definition at line 651 of file VuoEditor.cc.
|
signal |
Emitted when the user changes the "Dark Interface" menu item.
|
protected |
Reimplements QApplication::event(), to handle application-wide events.
Definition at line 1496 of file VuoEditor.cc.
|
static |
Returns the HTML <style>
block for use in node set and node documentation.
When forBrowser
is true, the styles are adjusted for viewing in a large web browser. When false, the styles are adjusted for viewing in the small node documentation panel
Definition at line 2319 of file VuoEditor.cc.
void VuoEditor::generateMainHtmlPageForNodeSet | ( | VuoNodeSet * | nodeSet, |
string | saveFileName, | ||
bool | publishInternalVuoLinks | ||
) |
Generates the main HTML documentation page for the provided nodeSet
, and saves it at the provided saveFileName
.
Definition at line 2346 of file VuoEditor.cc.
void VuoEditor::generateNodeClassHtmlPagesForNodeSet | ( | VuoNodeSet * | nodeSet, |
string | saveDir, | ||
bool | publishInternalVuoLinks | ||
) |
Generates the HTML documentation pages for non-deprecated node classes belonging to the provided nodeSet
, and saves them in provided saveDir
.
If publishInternalVuoLinks
is true, maps internal vuo-node:// and vuo-nodeset:// links to the appropriate relative links for use within web documentation. This function is not responsible for ensuring that the target files referenced by those links actually exist.
If publishInternalVuoLinks
is false, filters out internal links instead of mapping them to external links.
Definition at line 2493 of file VuoEditor.cc.
VuoCompilerDriver * VuoEditor::getBuiltInDriverForProtocol | ( | VuoProtocol * | protocol | ) |
Returns the built-in driver for the provided protocol
, or NULL if none.
Definition at line 2813 of file VuoEditor.cc.
int VuoEditor::getCanvasOpacity | ( | void | ) |
Returns the current opacity level of the canvas, where 0 is fully transparent and 255 is fully opaque.
Definition at line 3065 of file VuoEditor.cc.
|
static |
Returns the text content of the clipboard, or the empty string if the clipboard does not contain text content.
Definition at line 2696 of file VuoEditor.cc.
|
static |
Returns the default directory to be used for opening and saving Vuo compositions.
Definition at line 2170 of file VuoEditor.cc.
QString VuoEditor::getDefaultSubcompositionPrefix | ( | ) |
Returns the default string to be used as the subcomposition prefix for this user if it has not been customized by the user.
Definition at line 3265 of file VuoEditor.cc.
dispatch_queue_t VuoEditor::getDocumentationQueue | ( | ) |
Returns the dispatch queue to be used for documentation-related tasks, such as extracting resources from node set archives.
Definition at line 3044 of file VuoEditor.cc.
map< QString, QString > VuoEditor::getExampleCompositionsForProtocol | ( | VuoProtocol * | protocol | ) |
Returns a map containing the example compositions to be listed in association with the provided protocol
in the "File > Open Example" menu, and the node sets to which they belong.
Definition at line 3181 of file VuoEditor.cc.
void VuoEditor::getGlobalMovieExportSettings | ( | int & | width, |
int & | height, | ||
double & | time, | ||
double & | duration, | ||
double & | framerate, | ||
int & | spatialSupersample, | ||
int & | temporalSupersample, | ||
float & | shutterAngle, | ||
QString & | imageFormat, | ||
double & | quality | ||
) |
Returns the current global movie export settings.
Definition at line 1795 of file VuoEditor.cc.
bool VuoEditor::getGlobalShaderDocumentationVisibility | ( | ) |
Returns the current global shader documentation setting.
Definition at line 1695 of file VuoEditor.cc.
int VuoEditor::getPreferredNodeDocumentationPanelHeight | ( | ) |
Returns the preferred node documentation panel height as indicated in stored user preferences and/or actions performed since the stored preferences were last applied.
Definition at line 2711 of file VuoEditor.cc.
int VuoEditor::getPreferredNodeLibraryWidth | ( | ) |
Returns the preferred node library width as indicated in stored user preferences and/or actions performed since the stored preferences were last applied.
Definition at line 2720 of file VuoEditor.cc.
string VuoEditor::getResourceDirectoryForNodeSet | ( | string | nodeSetName | ) |
Returns the resource directory associated with the provided nodeSetName
.
If no such resource directory exists, returns the empty string. The existence of the resource directory implies that all resources (e.g., images) associated with the node set have already been extracted, and all HTML pages for the node set and its node classes have already been generated and saved within this directory.
Definition at line 2732 of file VuoEditor.cc.
string VuoEditor::getStoredUserProfileURL | ( | ) |
Returns the user profile URL associated with this editor session.
Definition at line 3233 of file VuoEditor.cc.
QString VuoEditor::getSubcompositionPrefix | ( | ) |
Returns the string to be used as the subcomposition prefix for this user.
Definition at line 3256 of file VuoEditor.cc.
VuoSubcompositionMessageRouter * VuoEditor::getSubcompositionRouter | ( | void | ) |
Returns the subcomposition message router shared by all open compositions.
Definition at line 2752 of file VuoEditor.cc.
map< QString, QString > VuoEditor::getUberExampleCompositions | ( | ) |
Returns a map containing the uberexamplecompositions to be displayed at the top level within the "File > Open Example" menu, and the node sets to which they belong.
Definition at line 3167 of file VuoEditor.cc.
|
static |
Returns the example composition URL corresponding to the example composition with the provided name and node set.
Definition at line 3208 of file VuoEditor.cc.
string VuoEditor::getUserName | ( | ) |
Returns the username associated with this editor session.
Definition at line 3221 of file VuoEditor.cc.
|
static |
Returns the path of the locally bundled Vuo manual if it exists, or the URL of the manual hosted on vuo.org otherwise.
Definition at line 2153 of file VuoEditor.cc.
|
signal |
Emitted after updateGlobalNodeLibraryState()
is called.
void VuoEditor::highlightNewNodeClassInAllLibraries | ( | string | nodeClassName | ) |
Highlights the requested new node class in all visible node libraries where it is listed, via callback made by each node library's module manager once installation has completed.
Definition at line 2011 of file VuoEditor.cc.
bool VuoEditor::isInterfaceDark | ( | void | ) |
Returns true if the user interface is in dark mode.
Definition at line 3052 of file VuoEditor.cc.
bool VuoEditor::isNodeLibraryCurrentlyDocked | ( | ) |
Returns true if the node library is docked, or false if it is floating.
Definition at line 688 of file VuoEditor.cc.
|
slot |
Creates an empty composition editor window.
Definition at line 1108 of file VuoEditor.cc.
VuoEditorWindow * VuoEditor::newCompositionWithContent | ( | string | content, |
string | compositionDir = "" |
||
) |
Creates a composition editor window with the provided content.
Returns a pointer to the new window.
Definition at line 1146 of file VuoEditor.cc.
|
slot |
Creates an empty composition editor window with the active protocol template indicated by the sender.
Definition at line 1157 of file VuoEditor.cc.
|
slot |
Creates an empty composition editor window with the active window template indicated by the sender.
Definition at line 1187 of file VuoEditor.cc.
|
slot |
Opens a composition editor window for an example composition.
filename | The name of the example composition. |
nodeSet | The node set that containst the example composition. |
nodeClassToHighlight | The node class name to initially select. |
Definition at line 1368 of file VuoEditor.cc.
|
slot |
Activates the "vuo-example" URL handler to handle the input url
.
Extracts the node set name and example composition name from the URL and opens the example composition.
Sample url
format: "vuo-example://vuo.text/RevealWord.vuo"
Definition at line 2672 of file VuoEditor.cc.
|
slot |
Uses an external browser to open the URL associated with the sender action that triggered the call to this slot.
Definition at line 1527 of file VuoEditor.cc.
|
slot |
Displays an "Open File" dialog, and if a composition or shader is selected, opens it in an editor window.
Definition at line 1276 of file VuoEditor.cc.
|
slot |
Opens the local file at the path associated with the sender action that triggered the call to this slot.
Definition at line 1537 of file VuoEditor.cc.
QMainWindow * VuoEditor::openFileWithName | ( | QString | filename, |
bool | addToRecentFileMenu = true |
||
) |
Opens a composition editor window with the specified filename
.
Definition at line 1297 of file VuoEditor.cc.
|
slot |
Launches HelpViewer.app
and opens the Vuo Manual to the introduction / table of contents.
Definition at line 901 of file VuoEditor.cc.
|
slot |
Opens the most recent file.
Definition at line 3273 of file VuoEditor.cc.
|
slot |
Opens a random example composition.
Definition at line 3281 of file VuoEditor.cc.
|
slot |
Determines what type of url
has been provided:
url
using the appropriate handler. Definition at line 1581 of file VuoEditor.cc.
void VuoEditor::populateCanvasTransparencyMenu | ( | QMenu * | m | ) |
Populates the provided menu m
with items related to canvas transparency.
Definition at line 761 of file VuoEditor.cc.
void VuoEditor::populateHelpMenu | ( | QMenu * | m | ) |
Populates the provided menu m
with support-related items.
Definition at line 806 of file VuoEditor.cc.
void VuoEditor::populateNewCompositionWithTemplateMenu | ( | QMenu * | m | ) |
Populates the provided menu m
with the editor's built-in templates.
Definition at line 2827 of file VuoEditor.cc.
void VuoEditor::populateNewShaderMenu | ( | QMenu * | m | ) |
Populates the provided menu with the templates for shaders.
Definition at line 2992 of file VuoEditor.cc.
void VuoEditor::populateWindowMenu | ( | QMenu * | m, |
QMainWindow * | currentWindow | ||
) |
Populates the provided menu with window-related items, including the list of open documents.
Definition at line 771 of file VuoEditor.cc.
void VuoEditor::processQueuedCompositionsToOpen | ( | ) |
Iterates through the queue of pending files to open and tries to open each one.
Definition at line 524 of file VuoEditor.cc.
|
slot |
Prunes the list of recently opened files from the application-global "File > Open Recent" menu list, removing any that no longer exist, and synchronizes each editor window's "File > Open Recent" menu with the global version.
Definition at line 2131 of file VuoEditor.cc.
|
slot |
Initiates final cleanup, and attempts to close all windows.
Definition at line 595 of file VuoEditor.cc.
QStringList VuoEditor::recentFiles | ( | ) |
Returns the list of recently-opened files.
Definition at line 586 of file VuoEditor.cc.
void VuoEditor::reevaluateWelcomePrecedence | ( | ) |
Allow pending file-open events to override the welcome window display if the welcome window is in a state where it is allowed to be closed.
Definition at line 540 of file VuoEditor.cc.
void VuoEditor::registerOpenDocument | ( | QMainWindow * | window | ) |
Updates the application UI immediately (on creation of window) and when window is destroyed.
Definition at line 1093 of file VuoEditor.cc.
|
slot |
Removes (by moving to the Trash) the file at the path associated with the sender action that triggered the call to this slot.
Definition at line 1552 of file VuoEditor.cc.
|
static |
Filters out internal vuo-node:// and vuo-nodeset:// links within the provided markdownText
, encapsulating the previously linked text in backticks.
Definition at line 2653 of file VuoEditor.cc.
|
static |
Sets the directory in which to save generated node documentation.
If this value is non-empty when the VuoEditor is instantiated, the editor will generate the full collection of node class and node set documentation, save it within the provided directory, and exit.
Definition at line 3157 of file VuoEditor.cc.
void VuoEditor::setResourceDirectoryForNodeSet | ( | string | nodeSetName, |
string | directory | ||
) |
Sets the resource directory associated with the provided nodeSetName
to the provided directory
.
Definition at line 2744 of file VuoEditor.cc.
|
signal |
Emitted when the user toggles the "Grid > Lines" or "Grid > Points" menu item.
|
slot |
Activates the "vuo-node" URL handler to handle the input url
.
Extracts the node class name from the URL and displays its documentation in the node library documentation pane.
Sample url
format: "vuo-node://vuo.math.calculate"
Definition at line 2302 of file VuoEditor.cc.
|
slot |
Shows the Node Class Library browser and focuses its text filter.
Definition at line 1409 of file VuoEditor.cc.
|
slot |
Activates the "vuo-nodeset" URL handler to handle the input url
.
Extracts the node set name from the URL and displays its documentation in an external browser.
Sample url
format: "vuo-nodeset://vuo.math"
Definition at line 2260 of file VuoEditor.cc.
|
slot |
Synchronizes each editor window's "File > Open Recent" menu with the global version, and saves the updated file list to the stored application settings.
Definition at line 2141 of file VuoEditor.cc.
void VuoEditor::updateGlobalShaderDocumentationVisibility | ( | bool | isVisible | ) |
Updates the global shader documentation setting to match isVisible.
Definition at line 1686 of file VuoEditor.cc.
void VuoEditor::updateSubcompositionPrefix | ( | QString | prefix | ) |
Sets the global subcomposition prefix to the value provided; stores the provided value as a preference in the settings.
Definition at line 3246 of file VuoEditor.cc.
QAction* VuoEditor::canvasTransparencyHighAction |
Makes the canvas highly transparent.
Definition at line 91 of file VuoEditor.hh.
QAction* VuoEditor::canvasTransparencyNoneAction |
Makes the canvas opaque.
Definition at line 89 of file VuoEditor.hh.
QActionGroup* VuoEditor::canvasTransparencyOptions |
Actions for changing canvas transparency.
Definition at line 88 of file VuoEditor.hh.
QAction* VuoEditor::canvasTransparencySlightAction |
Makes the canvas slightly transparent.
Definition at line 90 of file VuoEditor.hh.
QAction* VuoEditor::showGridLinesAction |
Toggles grid line rendering.
Definition at line 82 of file VuoEditor.hh.
QAction* VuoEditor::showGridPointsAction |
Toggles grid point rendering.
Definition at line 83 of file VuoEditor.hh.
QAction* VuoEditor::snapToGridAction |
Toggles grid snapping.
Definition at line 84 of file VuoEditor.hh.
|
static |
The file extension for Vuo compositions.
Definition at line 97 of file VuoEditor.hh.
|
static |
The URL scheme used for opening example compositions.
Definition at line 95 of file VuoEditor.hh.
|
static |
The query item expected to indicate what node class to highlight within an example composition.
Definition at line 96 of file VuoEditor.hh.
|
static |
The URL scheme used for opening a section of the user manual.
Definition at line 92 of file VuoEditor.hh.
|
static |
The file extension for Vuo node classes.
Definition at line 98 of file VuoEditor.hh.
|
static |
The URL scheme used for opening node documentation.
Definition at line 94 of file VuoEditor.hh.
|
static |
The URL scheme used for opening node set documentation.
Definition at line 93 of file VuoEditor.hh.
|
static |
The URL for Vuo tutorial videos.
Definition at line 99 of file VuoEditor.hh.