User Interface Functions

The functions detailed in this section provide access to information about and enable customization of the user interface.

AppComponentNameGet

std::string AppComponentNameGet()

Returns the name of which VIDA component currently has the mouse focus.

AppComponentNameSet

void AppComponentNameSet(const std::string &name)

Stores the name of which VIDA component currently has the mouse focus. This function is called internally whenever the mouse focus changes to a new widget within the application. This is primarily intended for internal use and as such should not be called.

AppGeometryGet

std::vector<unsigned int> AppGeometryGet()

Returns a list of four unsigned integers corresponding to the width, height, x and y positions of the application.

AppGeometrySet

std::vector<unsigned int> AppGeometrySet( const std::vector<unsigned int> &geom )
std::vector<unsigned int> AppGeometrySet( unsigned int width,
                                          unsigned int height,
                                          unsigned int x,
                                          unsigned int y,
                                          unsigned int mainx ,
                                          unsigned int mainy )

Sets the width, height, x position, y position, central widget width, and central widget height of the application.

AppGlobalFontGet

std::string AppGlobalFontGet()

Returns the current global font used in the application.

AppGlobalFontSet

void AppGlobalFontSet(const std::string &font)

Sets the global font to be used in the application.

AppLayoutGet

std::string AppLayoutGet()

Returns a hexadecimal encoded string representation of the current layout.

AppLayoutSet

std::string AppLayoutSet(const std::string &geom)

Sets the current layout of the application based on the hexadecimal encoded layout specified by geom. Ordinarily this function should not need to be called by the user; however, in the event that it is called, the input to this function should always be the return value from a previous call to .

AppLayoutToIcon

std::vector<std::string> AppLayoutToIcon(unsigned int width  = 24,
                                         unsigned int height = 24 )

Returns an cartoon representation of the current layout as an image of size width and height. The image is returned in XPM format.

AppMainWindowGet

std::string AppMainWindowGet()

Returns the name of the current main window.

AppMainWindowSet

std::string AppMainWindowSet(const std::string &mainWindow)

Sets the current main window. The name of the desired main window is the input to this function.

AppMovableWindowsGet

bool AppMovableWindowsGet()

Returns whether or not the layout of the individual windows in the application can be changed by clicking and dragging the window to the desired location.

AppMovableWindowsSet

bool AppMovableWindowsSet(bool)

Sets whether or not the layout of the individual windows in the application can be changed by clicking and dragging the window to the desired location.

AppPerspectiveSet

std::string AppPerspectiveSet(const std::string &perspective)

Sets the current layout of the application based on the hexadecimal encoded layout specified by perspective while maintaining the current geometry (width, height, x and y positions). Ordinarily this function should not need to be called by the user; however, in the event that it is called, the input to this function should always be the return value of a previous call to .

AppRecordWindowEventsGet

bool AppRecordWindowEventsGet()

Returns whether or not window events are currently being recorded in the application history.

AppRecordWindowEventsSet

bool AppRecordWindowEventsSet(bool record)

Sets whether or not window events are recorded in the application history.

AppShowGet

std::string AppShowGet()

Returns the display status of the application. Potential return values are:

  • “normal”
  • “minimized”
  • “maximized”
  • “fullscreen”

AppShowMenuBarGet

bool AppShowMenuBarGet()

Returns whether or not the main menubar is currently visible.

AppShowMenuBarSet

void AppShowMenuBarSet(bool)

Sets whether or not the main menubar is currently visible.

AppShowSet

void AppShowSet(const std::string &style)

Sets the display status of the application. Valid options are:

  • “normal”
  • “minimized”
  • “maximized”
  • “fullscreen”

AppShowStatusBarGet

bool AppShowStatusBarGet()

Returns whether or not the main status bar is currently visible.

AppShowStatusBarSet

void AppShowStatusBarSet(bool)

Sets whether or not the main status bar is currently visible.

AppSloppyFocusGet

bool AppSloppyFocusGet()

Returns whether or not the window focus is changed by simply positioning the mouse over a window as opposed to requiring a click in the window to change focus (the default behavior).

AppSloppyFocusSet

bool AppSloppyFocusSet(bool sloppy)

Sets whether or not the window focus is changed by simply positioning the mouse over a window as opposed to requiring a click in the window to change focus (the default behavior).

AppStatusTextSet

void AppStatusTextSet(const std::string &text, unsigned int seconds)

Sets the displayed text in the status bar of the main application window to the specified text. If the seconds parameter is 0, this text will replace the default SMILES display in the status bar. If the seconds parameter is greater than 0, the text will only be displayed for the specified period of time, returning to the default SMILES display when the time has elapsed.

AppWindowStyleGet

std::string AppWindowStyleGet()

Returns the application window display style of the application. These styles typically correspond to specific operating system window managers.

AppWindowStyleSet

std::string AppWindowStyleSet(const std::string &windowStyle)

Sets the application window display style of the application. These styles typically correspond to specific operating system window managers.

BlockBegin

void BlockBegin()

Blocks user interaction with the GUI with the exception of the abort button. This function is used internally and should only be called by the user to restore already existing blocking behavior that may have been temporarily overridden to enable user interaction within a user specified script.

BlockEnd

void BlockEnd()

Restores user interaction with the GUI that was previously blocked by . This function is used internally and should only be called to enable user interaction (if needed) within a user specified script. Any script which calls this function should restore the blocking behavior by calling BlockBegin once the user interaction portion is complete. However, it is important to make sure that blocking is actually active in the first place (see ) before calling this function and then later calling BlockBegin.

BlockExemptGet

bool BlockExemptGet(const std::string &name)

Returns whether or not the GUI object specified by name is exempt from GUI blocking when Python commands are being executed.

BlockExemptSet

void BlockExemptSet(const std::string &name, bool value)

Sets whether or not the GUI object specified by name is exempt from GUI blocking when Python commands are being executed.

BlockGet

bool BlockGet()

Returns whether or not user interaction with the GUI is currently being blocked. User interaction is typically blocked while Python commands and scripts are being executed.

BuilderFocusOnProperties

void BuilderFocusOnProperties()

Displays the Properties tab in the Builder Window.

BuilderFocusOnSketcher

void BuilderFocusOnSketcher()

Displays the Sketcher tab in the Builder Window.

IconGetXPM

std::vector<std::string> IconGetXPM(const std::string &name)

Returns an XPM representation of the icon specified by name.

InterpreterClear

void InterpreterClear()

Clears the contents of the scripting window.

InterpreterDebugTextColorGet

OESystem::OEColor InterpreterDebugTextColorGet()

Returns the text color used when displaying debugging messages in the scripting window.

InterpreterDebugTextColorSet

void InterpreterDebugTextColorSet(const OESystem::OEColor &c)

Sets the text color used when displaying debugging messages in the scripting window.

InterpreterErrorTextColorGet

OESystem::OEColor InterpreterErrorTextColorGet()

Returns the text color used when displaying error messages in the scripting window.

InterpreterErrorTextColorSet

void InterpreterErrorTextColorSet(const OESystem::OEColor &c)

Sets the text color used when displaying debugging messages in the scripting window.

InterpreterOutputTextColorGet

OESystem::OEColor InterpreterOutputTextColorGet()

Returns the text color used when displaying output messages in the scripting window.

InterpreterOutputTextColorSet

void InterpreterOutputTextColorSet(const OESystem::OEColor &c)

Sets the text color used when displaying output messages in the scripting window.

InterpreterPopUpdateGUI

  void InterpreterPopUpdateGUI()

Specifies to the application that the normal interface updating behavior
should occur after issued commands. This function is normally called in
conjunction with
:oefunc:`InterpreterPushUpdateGUI` to
terminate the non-updating behavior triggered by that function. It is
important to note that these functions can be nested.

InterpreterPushUpdateGUI

void InterpreterPushUpdateGUI(bool update)

Specifies to the application whether or not the application should be updating the interface after this function is called. This is normally called to allow multiple commands to be issued in a row without causing an interface update after each individual call. A call to will resume the normal updating behavior. It is important to note that these calls can be nested.

InterpreterShowDebugTextGet

bool InterpreterShowDebugTextGet()

Returns whether or not debugging text will be displayed in the scripting window.

InterpreterShowDebugTextSet

void InterpreterShowDebugTextSet(bool show)

Sets whether or not debugging text will be displayed in the scripting window.

InterpreterTimerGet

bool InterpreterTimerGet()

Returns whether or not the application reports the time elapsed after every user entered command.

InterpreterTimerSet

bool InterpreterTimerSet(bool enable)

Sets whether or not the application reports the time elapsed after every user entered command.

InterpreterUpdatesGUI

bool InterpreterUpdatesGUI()

Returns whether or not VIDA is updating the interface after every command is completed.

LayoutCurrentGet

std::string LayoutCurrentGet()

Returns the name of the most recently applied named layout.

LayoutExists

bool LayoutExists(const std::string &name)

Returns whether or not the specified named layout exists.

LayoutGet

std::string LayoutGet(const std::string &name)

Returns a string representation of the specified name layout. The value returned by this function can be used as input to the following functions:

LayoutIcon

std::vector<std::string> LayoutIcon(const std::string &name)

Returns the icon associated with the specified named layout in XPM format.

LayoutLoad

bool LayoutLoad(const std::string &name)

Loads the specified named layout.

LayoutOrganizePrompt

std::string LayoutOrganizePrompt()

Launches the layout organization dialog.

LayoutOverrideOrder

void LayoutOverrideOrder(const std::vector<std::string> &names)

Sets the order to be used when displaying the named layouts in the layout button.

LayoutRemove

bool LayoutRemove(const std::string &name)

Removes the specified named layout.

LayoutRename

bool LayoutRename(const std::string &oldName, const std::string &newName)

Renames the specified named layout.

LayoutSaveCurrent

bool LayoutSaveCurrent(const std::string &name)

Saves the current application’s layout using the specified name.

LayoutSet

void LayoutSet(const std::string &name, const std::string &data)

Creates a named layout using the specified name and layout data. The input for the data parameter can be obtained from command.

LayoutStickyGet

bool LayoutStickyGet()

LayoutStickySet

void LayoutStickySet(bool sticky)

Layouts

std::vector<std::string> Layouts()

Returns a list of the available named layouts.

ListWindowCollapseAll

void ListWindowCollapseAll()

Collapses all the visible nodes in the List Window to show only the top-level list entries.

ListWindowCollapseCurrent

void ListWindowCollapseCurrent()

Collapses the currently active list node in the List Window to a single top-level entry.

ListWindowExpandAll

void ListWindowExpandAll()

Expands all the top-level list nodes in the List Window to show their contents.

ListWindowExpandCurrent

void ListWindowExpandCurrent()

Expands the currently active list node in the List Window to show its contents.

ListWindowFirstList

void ListWindowFirstList()

Makes active the first item in the first list.

ListWindowFirstListItem

void ListWindowFirstListItem()

Makes active the first item in the current list.

ListWindowFocusOnOERID

void ListWindowFocusOnOERID(unsigned int id)

Changes the view of the list window to ensure that the specified ID is visible.

ListWindowGetCurrentPos

std::vector<unsigned int> ListWindowGetCurrentPos()

Returns the current active position with the list window. This function is primarily intended for internal use only.

ListWindowHideColumn

void ListWindowHideColumn(unsigned int column)

Hides the specified column from view in the list window.

ListWindowIsVisible

bool ListWindowIsVisible()

Returns whether or not the list window is currently visible.

ListWindowLastList

void ListWindowLastList()

Makes active the first item in the last list.

ListWindowLastListItem

void ListWindowLastListItem()

Makes active the last item in the current list.

ListWindowNavigateChildrenGet

bool ListWindowNavigateChildrenGet()

Returns whether or not to navigate through an object’s children when browsing through the list window.

ListWindowNavigateChildrenSet

void ListWindowNavigateChildrenSet(bool nav)

Sets whether or not to navigate through an object’s children when browsing through the list window.

ListWindowNavigateLeft

void ListWindowNavigateLeft()

Navigate to a new active object as if the user had pressed the left arrow key inside of the list window.

ListWindowNavigateRight

void ListWindowNavigateRight()

Navigate to a new active object as if the user had pressed the right arrow key inside of the list window.

ListWindowNextList

bool ListWindowNextList()

Makes active the first item in the next list.

ListWindowNextListItem

bool ListWindowNextListItem()

Makes active the next item in the current list.

ListWindowPrevList

bool ListWindowPrevList()

Makes active the first item in the previous list.

ListWindowPrevListItem

bool ListWindowPrevListItem()

Makes active the previous item in the current list.

ListWindowRowColoringGet

bool ListWindowRowColoringGet()

Returns whether or not the list window uses an alternating row coloring scheme.

ListWindowRowColoringSet

void ListWindowRowColoringSet(bool on)

Sets whether or not the list window uses an alternating row coloring scheme.

ListWindowSetCurrentPos

void ListWindowSetCurrentPos(std::vector<unsigned int> pos)

Sets the current active position within the list window. This is intended for internal use only.

ListWindowShowColumn

void ListWindowShowColumn(unsigned int column)

Shows the specified column in the list window.

MainWindowScreenshot

bool MainWindowScreenshot(const std::string &filename="")

Captures an image of the current main window and saves that image to the specified file.

MainWindowScreenshotPrompt

bool MainWindowScreenshotPrompt()

Opens a dialog which allows the user to specify multiple parameters regarding the creation of a screenshot of the main window.

Pick

void Pick(unsigned int action, const std::string &source,
          const std::vector<OEPropDB::OEKey> &keys, int replicate)
void Pick(unsigned int action, unsigned int startX, unsigned int startY,
          unsigned int endX, unsigned int endY, unsigned int width,
          unsigned int height)

Picks a small rectangular region on the 3D display specified by the start and end coordinates. This function is primarily intended for internal use.

PickAgain

void PickAgain(unsigned int action)

Repeats the previous action.

PopIgnoreHint

void PopIgnoreHint()

This function, paired with PushIgnoreHint, minimizes application response to the functions called between them. Every PushIgnoreHint must be matched with a PopIgnoreHint and vice versa.

PopupAddButton

std::string PopupAddButton(const std::string &button,
                           const std::string &command, bool showOnce=false)

This function adds a clickable menu entry that runs the specified command to the popup menu. The last optional parameter specifies that this menu entry should only last one show of the popup menu.

PopupAddRadioButton

std::string PopupAddRadioButton(const std::string &button,
                                const std::string &command,
                                const std::string &updateCommand,
                                bool showOnce=false)

This function adds an exclusive clickable menu entry to the popup menu. The last optional parameter specifies that this menu entry should only last one show of the popup menu. It should only be called between and .

PopupAddSeparator

std::string PopupAddSeparator(bool once=false, bool conditional=false)

This function adds a non-clickable line menu entry to the popup menu. The last optional parameter specifies that this menu entry should only last one show of the popup menu.

PopupAddSetupFunc

void PopupAddSetupFunc(const std::string &function)

This function specifies a worker function to be called before the popup menu is shown. It is called with no arguments. It is designed to allow context sensitive menu entries to be added to the popup menu.

PopupAddSubmenu

std::string PopupAddSubmenu(const std::string &child, bool showOnce=false)

This function adds a submenu to the popup menu. The last optional parameter specifies that this menu entry should only last one show of the popup menu.

PopupAddToggleButton

std::string PopupAddToggleButton(const std::string &button,
                                 const std::string &command,
                                 const std::string &updateCommand,
                                 bool showOnce=false, bool state=false)

This function adds a clickable menu entry that runs the specified command to the popup menu. The last optional parameter specifies that this menu entry should only last one show of the popup menu. The state of the toggle is passed as either 0 or 1 in the variable OEInternal.MenuVal. The return value of the update command is used to set the state of the toggle. Returning 1 or True from the update function sets the toggle on.

PopupBeginRadioGroup

void PopupBeginRadioGroup()

This function specifies that the following added radio buttons are exclusive.

PopupDisplayName

void PopupDisplayName(const std::string &item, const std::string &display_name)

This function modifies the display name of a popup menu entry.

PopupEnableItem

void PopupEnableItem(const std::string &item, bool enabled)

This function enables or disables the specified popup menu entry.

PopupEnableItemCommand

void PopupEnableItemCommand(const std::string &item,
                            const std::string &command)

This function sets the update command on the given entry in the popup menu.

PopupEndRadioGroup

void PopupEndRadioGroup()

This function ends the radio group begun by .

PopupRemoveAll

void PopupRemoveAll()

This function removes all entries from the popup menu.

PopupRemoveItem

void PopupRemoveItem(const std::string &item)

This function removes the specified entry from the popup menu.

ProgressbarUpdate

bool ProgressbarUpdate(int count, int total)

Updates the application progress bar based on the specified count and total parameters.

PromptAtomicNum

unsigned int PromptAtomicNum(const std::string &caption, unsigned int def=6)

Prompts the user to specify an element from a periodic table dialog.

PromptColor

OEColor PromptColor(const OEColor &deflt=OEColor())

Prompts the user to specify a color.

PromptError

bool PromptError(const std::string &)

This function prompts the user with an error message.

PromptFilename

std::string PromptFilename(const std::string &def="",
                           const std::string &mode="Open",
                           const std::string &type="all",
                           const std::string &msg="")

This function prompts the user for a filename. The parameters specify the default value, whether it should be an ‘Open’ or ‘Save’ dialog, and what kind of file.

PromptFilenames

std::vector<std::string>
  PromptFilenames(const std::vector<std::string> &def=std::vector<std::string>(),
                  const std::string &type="all", const std::string &msg="")

This function prompts the user for a collection of filenames. The parameters specify the default value, whether it should be an ‘Open’ or ‘Save’ dialog, and what kind of files.

PromptFloat

float PromptFloat(const std::string &prompt, float def=0.0f,
                  unsigned int prec=5)

This function prompts the user for a floating point number.

PromptFont

std::string PromptFont()

Prompts the user to specify a desired font.

PromptID

unsigned int PromptID(unsigned int filters=0xF0FF, bool preview=true)
unsigned int PromptID(std::vector<std::string> filterList, bool preview=true)

This function prompts the user for an ID from the currently loaded set.

Unsigned integer filters are an OR’ed combination of the following values.

  • PromptFilter_Molecules
  • PromptFilter_Surfaces
  • PromptFilter_Grids
  • PromptFilter_Lists
  • PromptFilter_Reflections
  • PromptFilter_Selected
  • PromptFilter_Active
  • PromptFilter_Marked
  • PromptFilter_Visible
  • PromptFilter_Unknown
  • PromptFilter_All

String filters are just placed in a list:

  • ‘M’ or ‘m’ for molecules
  • ‘S’ or ‘s’ for surfaces
  • ‘R’ or ‘r’ for reflections
  • ‘G’ or ‘g’ for grids
  • ‘L’ or ‘l’ for lists
  • ‘O’ or ‘o’ for Unknown objects

For example, to prompt for Molecules and Surfaces:

id = PromptID(PromptFilter_Molecules | PromptFilter_Surfaces)

or

id = PromptID([‘M’,’S’])

PromptIDWriteFilters

std::vector<std::string> PromptIDWriteFilters(const std::string &fname)

This function returns the valid types that can be written to the type of file specified by the filename parameter.

PromptIDs

std::vector<unsigned int> PromptIDs(unsigned int filters=0xF0FF,
                                    bool preview=true)
std::vector<unsigned int> PromptIDs(const std::vector<std::string> &filterList,
                                    bool preview=true)

This function prompts the user for several IDs from the currently loaded set.

See PromptID for the list of available filters.

PromptInteger

int PromptInteger(const std::string &msg, int def=0)

This function prompts the user for an integer.

PromptKey

OEPropDB::OEKey PromptKey(unsigned int filters=0xF0FF, bool preview=true)
OEPropDB::OEKey PromptKey(const std::vector<std::string> &filterList,
                          bool preview=true)

This function prompts the user for a key.

See PromptID for the list of available filters.

PromptKeys

std::vector<OEPropDB::OEKey>
  PromptKeys(const std::vector<std::string> &filterList, bool preview=true)
std::vector<OEPropDB::OEKey> PromptKeys(unsigned int filters=0xF0FF,
                                        bool preview=true)

This function prompts the user for a collection of key.

See PromptID for the list of available filters.

PromptMessage

bool PromptMessage(const std::string &msg)

This function alerts the user with a message and an OK button.

PromptModeGet

std::string PromptModeGet()

PromptModeSet

bool PromptModeSet(const std::string &mod)

PromptFragment

std::string PromptMolecule(const std::string &caption)

Prompts the user to input a molecule fragment using the built-in molecule input dialog. Returns a hexadecimal encoded OEB string representation of the fragment. In addition to specifying a molecular fragment, the user will be required to define an attachment point, either by including a dummy atom or a selected atom or bond.

PromptMolecule

std::string PromptMolecule(const std::string &caption,
                           const std::string &def="", unsigned int options=21)

Prompts the user to specify a molecule using the built-in molecule input dialog. Returns a hexadecimal encoded OEB string representation of the molecule.

PromptMoleculeSplit

std::string PromptMoleculeSplit(unsigned int id)

Launches a dialog to assist in the splitting of the specified molecule.

PromptMulti

bool PromptMulti(const std::string &prompt, std::vector<std::string> names,
                 std::vector<std::string> types,
                 std::vector<std::string> defs,
                 std::vector<OEInterpreter::OEMultiTypeVar> &out)

This function prompts the user for several different types of variables and returns them in a list.

PromptQuery

std::string PromptQuery(const std::string &def="")

This function prompts the user for a query string for calls to .

PromptResponseBool

void PromptResponseBool(const std::string &msg, bool v, bool forceInter)

This function pushes a boolean response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseCanceled

void PromptResponseCanceled(const std::string &)

This function pushes a cancel response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseColor

void PromptResponseColor(const std::string &type, const OESystem::OEColor &c,
                         bool forceInteractive)

This function pushes a color response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseFloat

void PromptResponseFloat(const std::string &type, float v, bool forceInter)

This function pushes a floating point response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseInt

void PromptResponseInt(const std::string &type, int v, bool forceInter=false)

This function pushes an integer response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseKey

void PromptResponseKey(const std::string &type, const OEPropDB::OEKey &key,
                       bool forceInteractive=false)

This function pushes an key response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseKeys

void PromptResponseKeys(const std::string &type,
                        std::vector<OEPropDB::OEKey> &keys,
                        bool forceInteractive=false)

This function pushes a collection of keys response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseString

void PromptResponseString(const std::string &type, const std::string &v,
                          bool forceInteractive=false)

This function pushes a string response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseUInt

void PromptResponseUInt(const std::string &type, unsigned int v,
                        bool forceInteractive=false)

This function pushes a positive integer response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseVectInt

void PromptResponseVectInt(const std::string &type,
                           const std::vector<int> &value,
                           bool forceInteractive=false)

This function pushes a list-of-integers response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseVectMulti

void PromptResponseVectMulti(const std::string &type,
                             const std::vector<OEInterpreter::OEMultiTypeVar> &value,
                             bool forceInteractive=false)

PromptResponseVectString

void PromptResponseVectString(const std::string &type,
                              const std::vector<std::string> &value,
                              bool forInteractive=false)

This function pushes a list-of-strings response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptResponseVectUInt

void PromptResponseVectUInt(const std::string &type,
                            const std::vector<unsigned int> &value,
                            bool forceInteractive=false)

This function pushes a list-of-positive-integers response to an upcoming Prompt, allowing it to be skipped in scripts. Ordinarily this function should not need to be called by the user.

PromptSaveFilename

std::string PromptSaveFilename(const std::vector<unsigned int> &ids,
                               const std::string &msg="")
std::string PromptSaveFilename(const std::vector<OEPropDB::OEKey> &keys,
                               const std::string &msg="")
std::vector<std::string> PromptSaveFilename(const std::string &filters,
                                            const std::string &msg="")

This function prompts the user to select a file for saving. The filters parameter allows for specification of filter types to be shown in the file dialog. Individual filters should be separated by a pair of semicolons like this:

“OpenEye OEBinary (.oeb);;All Files (.*)”

The msg parameter allows for specification of the caption of the file dialog. This function returns a list where the first member is the selected filename and the second is the selected filter. If the user cancels the prompt, the returned list will be empty.

See PromptID for the list of available filters.

PromptSmiles

std::string PromptSmiles(const std::string &caption, const std::string &def="",
                         unsigned int options=21)

Prompts the user to specify a molecule using the built-in molecule input dialog. The molecule is returned as a SMILES string.

PromptString

std::string PromptString(const std::string &prompt="",
                         const std::string &def="", bool lineMode=true,
                         bool editable=true)

This function prompts the user for a string.

PromptStringListFromString

void PromptStringListFromString(const std::string &in,
                                std::vector<std::string> &options,
                                unsigned int &def)

This function prompts the user for a string.

PromptStringListToString

std::string PromptStringListToString(const std::vector<std::string> &options,
                                     unsigned int def)
std::string PromptStringListToString(const std::vector<std::string> &options,
                                     const std::string &def)

This function generates a list of strings from a formatted string. Ordinarily this function should not need to be called by the user.

PromptYesNo

bool PromptYesNo(const std::string &prompt, const std::string &key="")
bool PromptYesNo(const std::string &prompt, bool &check,
                 const std::string &key="")

This function prompts the user for a yes or no answer.

PromptYesNoSetDefault

bool PromptYesNoSetDefault(const std::string &key, bool def)

This function prompts the user for a yes or no answer.

PushIgnoreHint

void PushIgnoreHint(bool ignore)

This function delays update actions for the following commands until a PopIgnoreHint is called. PushIgnoreHint and PopIgnoreHints MUST match.

SetProgressbar

void SetProgressbar(int index, int total)

This function sets the progress bar to the specified value.

ToolbarAdd

void ToolbarAdd(const std::vector<std::string> &icon,
                const std::string &command, const std::string &tooltip="",
                const std::string &toolbar="Application",
                const std::string &name="")
void ToolbarAdd(const std::string &text, const std::string &command,
                const std::string &tooltip="",
                const std::string &toolbar="Application",
                const std::string &name="", int margin=5)

Adds a single standard push button to the specified toolbar. The button can be represented by either the passed icon (in XPM format) or the passed text string. The specified command will be executed when the button is pushed.

ToolbarAddAbort

void ToolbarAddAbort(const std::string &toolbar)

Adds an abort button to the specified toolbar.

ToolbarAddCombo

void ToolbarAddCombo(const std::vector<std::string> &choices,
                     const std::vector<std::string> &commands,
                     const std::string &update,
                     const std::string &toolbar="Application",
                     const std::string &name="")

Adds a combo box (a.k.a. dropdown box) with the specified list of options and their associated commands to the specified toolbar. The update parameter contains a command that will be executed to update the widget.

ToolbarAddMenu

void ToolbarAddMenu(const std::vector<std::string> &text,
                    const std::vector<std::string> &command,
                    const std::vector<std::string> &tooltip,
                    const std::string &update,
                    const std::string &toolbar="Application",
                    const std::string &name="", int margin=5)
void ToolbarAddMenu(const std::vector<std::vector<std::string> > &icon,
                    const std::vector<std::string> &text,
                    const std::vector<std::string> &command,
                    const std::vector<std::string> &tooltip,
                    const std::string &update,
                    const std::string &toolbar="Application",
                    const std::string &name="")

Adds a button with a dropdown menu to the toolbar. Each menu item is represented by a name, a Python command, and a tooltip. One implementation also allows specification of an icon for each item. The update parameter contains a command that will be executed to update the button and the associated menu.

ToolbarAddMenuViaNamedIcons

void ToolbarAddMenuViaNamedIcons(const std::vector<std::string> &iconName,
                                 const std::vector<std::string> &text,
                                 const std::vector<std::string> &command,
                                 const std::vector<std::string> &tooltip,
                                 const std::string &update,
                                 const std::string &toolbar="Application",
                                 const std::string &name="")

Adds a button with a dropdown menu to the toolbar. Each menu item is represented by a name, a named icon, a Python command, and a tooltip. The update parameter contains a command that will be executed to update the button and the associated menu.

ToolbarAddSeparator

void ToolbarAddSeparator(const std::string &toolbar="Application")

Adds a separator to the specified toolbar.

ToolbarAddSheet

StyleSheet *ToolbarAddSheet(const std::string &icon,
                            const std::string &toolbar)

Adds a new style sheet to the specified toolbar represented by the specified icon.

ToolbarAddSlider

void ToolbarAddSlider(const std::string &applyCommand,
                      const std::string &getCount, const std::string &getMin,
                      const std::string &getMax, const std::string &getCurrent,
                      const std::string &sliderToVal,
                      const std::string &valToSlider,
                      const std::string &toolbar="Application",
                      const std::string &name="")

Adds a slider bar to the specified toolbar. The applyCommand will be executed whenever the slider bar is changed. The getCount parameter is a command that returns how many things the slider is currently controlling. The getMin, getMax, and getCurrent parameters are commands that will be executed to determine the bounds of the slider. The sliderToVal parameter is a command that converts the slider position to a meaningful value for the applyCommand function. The valToSlider parameter is a command that converts the value returned by getCurrent to a meaningful value to be shown on the slider bar.

ToolbarAddToggle

void ToolbarAddToggle(const std::string &onText, const std::string &offText,
                      const std::string &onCommand,
                      const std::string &offCommand, const std::string &desc,
                      const std::string &update,
                      const std::string &toolbar="Application",
                      const std::string &name="", int margin=5)
void ToolbarAddToggle(const std::vector<std::string> &onIcon,
                      const std::vector<std::string> &offIcon,
                      const std::string &onCommand,
                      const std::string &offCommand, const std::string &desc,
                      const std::string &update,
                      const std::string &toolbar="Application",
                      const std::string &name="")

Adds a single standard toggle button to the specified toolbar. Both on and off icons can be specified as parameters (in XPM format). Commands for both the on and off states can be specified and will be executed when the associated button enters that state.

ToolbarAddToggleViaNamedIcons

void ToolbarAddToggleViaNamedIcons(const std::string &onIconName,
                                   const std::string &ofIconfName,
                                   const std::string &onCommand,
                                   const std::string &offCommand,
                                   const std::string &desc,
                                   const std::string &update,
                                   const std::string &toolbar="Application",
                                   const std::string &name="")

Equivalent to except that instead of having to pass in an icon pixmaps, icons are specified by name. For a table of available icons, please see the Icons chapter in the main VIDA manual.

ToolbarAddViaNamedIcon

void ToolbarAddViaNamedIcon(const std::string &iconName,
                            const std::string &command,
                            const std::string &tooltip="",
                            const std::string &toolbar="Application",
                            const std::string &name="")

Equivalent to except that instead of having to pass in an icon pixmap, the icon is specified by name. For a table of available icons, please see the Icons chapter in the main VIDA manual.

ToolbarBeginRadio

  void ToolbarBeginRadio(const std::string &name,
                         const std::string &toolbar="Application")

Begins a named group of mutually exclusive radio buttons in the specified
toolbar.

ToolbarButtonEnableGet

bool ToolbarButtonEnableGet(const std::string &name,
                            const std::string &toolbar="Application")

Returns whether or not the specified button in the specified toolbar is currently enabled.

ToolbarButtonEnableSet

void ToolbarButtonEnableSet(const std::string &name, bool enabled,
                            const std::string &toolbar="Application")

Sets whether or not the specified button in the specified toolbar is currently enabled.

ToolbarComboAddChoice

bool ToolbarComboAddChoice(const std::string &choice,
                           const std::string &command,
                           const std::string &after,
                           const std::string toolbar="Application",
                           const std::string &combo_name="")

Adds a new option specified by choice to the specified combo box in the specified toolbar. The command parameter contains the Python function to be called when this choice is selected. The after parameter specifies after which other choice this new option should be added.

ToolbarComboClear

bool ToolbarComboClear(const std::string toolbar="Application",
                       const std::string &combo_name="")

Clears the contents of the specified combo box in the specified toolbar.

ToolbarComboRemoveChoice

bool ToolbarComboRemoveChoice(const std::string &choice,
                              const std::string toolbar="Application",
                              const std::string &combo_name="")

Removes the specified choice from the specified combo box in the specified toolbar.

ToolbarCreate

void ToolbarCreate(const std::string &toolbar)

Creates a new toolbar with the specified name.

ToolbarEnabledGet

bool ToolbarEnabledGet(const std::string &toolbar="Application")

Returns whether or not the specified toolbar is currently enabled.

ToolbarEnabledSet

bool ToolbarEnabledSet(bool vis, const std::string &toolbar="Application")

Sets whether or not the specified toolbar is currently enabled.

ToolbarEndRadio

void ToolbarEndRadio(const std::string &name,
                     const std::string &toolbar="Application")

Ends the named group of mutually exclusive radio buttons in the specified toolbar.

ToolbarGetAll

std::vector<std::string> ToolbarGetAll()

Returns a list of all the existing toolbars in VIDA.

ToolbarItemCheckedGet

bool ToolbarItemCheckedGet(const std::string &name, const std::string &toolbar)

Returns whether or not the specified toolbar item in the specified toolbar is currently checked.

ToolbarItemCheckedSet

bool ToolbarItemCheckedSet(bool, const std::string &name,
                           const std::string &toolbar)

Sets whether or not the specified toolbar item in the specified toolbar is currently checked.

ToolbarItemUpdate

void ToolbarItemUpdate(const std::string &name, const std::string &toolbar)

Causes the specified toolbar item in the specified toolbar to update itself.

ToolbarItemVisibleGet

bool ToolbarItemVisibleGet(const std::string &name, const std::string &toolbar)

Returns whether or no the specified toolbar item in the specified toolbar is currently visible.

ToolbarItemVisibleSet

bool ToolbarItemVisibleSet(bool, const std::string &name,
                           const std::string &toolbar)

Sets whether or not the specified toolbar item in the specified toolbar is currently visible.

ToolbarRemove

void ToolbarRemove(const std::string &toolbar)
void ToolbarRemove(const std::string &toolbar, const std::string &name)

Removes the specified toolbar from VIDA. Please not that when a toolbar is removed, it is deleted from the application and not simply hidden.

ToolbarUpdate

void ToolbarUpdate(const std::string &toolbar)

Updates the specified toolbar.

ToolbarVisibleGet

bool ToolbarVisibleGet(const std::string &toolbar="Application")

Returns whether or not the specified toolbar is currently visible.

ToolbarVisibleSet

bool ToolbarVisibleSet(bool vis, const std::string &toolbar="Application")

Sets whether or not the specified toolbar is currently visible.

UpdateStyleWidget

void UpdateStyleWidget()

This function notifies the style widget that it should update itself due to changes that might affect its display.

UpdateUndo

void UpdateUndo()

This function updates the undo menu. Ordinarily this function should not need to be called by the user.

ViewerActiveAnnotation

OEGLTextBox *ViewerActiveAnnotation(int x=-1, int y=-1, int w=-1, int h=-1)

Create the active annotation.

ViewerActiveAnnotationBackgroundColorGet

OESystem::OEColor ViewerActiveAnnotationBackgroundColorGet()

Return the background color for the active annotation.

ViewerActiveAnnotationBackgroundColorSet

void ViewerActiveAnnotationBackgroundColorSet(const OESystem::OEColor &clr)

Set the background color for the active annotation.

ViewerActiveAnnotationClose

void ViewerActiveAnnotationClose()

Close the active annotation window.

ViewerActiveAnnotationFontGet

std::string ViewerActiveAnnotationFontGet()

Return the font used for the active annotation.

ViewerActiveAnnotationFontSet

void ViewerActiveAnnotationFontSet(const std::string &font)

Set the font used for the active annotation. Uses fonts as returned by the scripting command.

ViewerActiveAnnotationForegroundColorGet

OESystem::OEColor ViewerActiveAnnotationForegroundColorGet()

Returns the foreground (text) color used in the active annotation.

ViewerActiveAnnotationForegroundColorSet

void ViewerActiveAnnotationForegroundColorSet(const OESystem::OEColor &clr)

Sets the foreground (text) color for the active annotation.

ViewerActiveAnnotationVisible

bool ViewerActiveAnnotationVisible()

Returns whether or not the active annotation is visible.

ViewerActiveDataFontSizeGet

unsigned int ViewerActiveDataFontSizeGet()

Returns the font size for the active data display.

ViewerActiveDataFontSizeSet

void ViewerActiveDataFontSizeSet(unsigned int sz)

Sets the font size for the active data display.

ViewerActiveDataHide

OEGLDataView *ViewerActiveDataHide()

Hides the active data display.

ViewerActiveDataShow

OEGLDataView *ViewerActiveDataShow()
OEGLDataView *ViewerActiveDataShow(int x, int y, int h, int w)

Returns and shows the active data display.

ViewerActiveDataVisible

bool ViewerActiveDataVisible()

Returns whether or not the active data display is currently visible in the 3D display.

ViewerBookmarkWidget

OEGLHList *ViewerBookmarkWidget()

Returns a reference to the bookmark control widget.

ViewerBookmarkWidgetFontSizeGet

unsigned int ViewerBookmarkWidgetFontSizeGet()

Returns the size of the font used in the bookmark control widget.

ViewerBookmarkWidgetFontSizeSet

void ViewerBookmarkWidgetFontSizeSet(unsigned int sz)

Sets the size of the font used in the bookmark control widget.

ViewerBookmarkWidgetHide

OEGLHList *ViewerBookmarkWidgetHide()

Hides the bookmark control widget from the 3D display.

ViewerBookmarkWidgetShow

OEGLHList *ViewerBookmarkWidgetShow()

Shows the bookmark control widget in the 3D display.

ViewerButtonImage

OEGLButton *ViewerButtonImage(const std::string &image,
                              const std::string &callback,
                              int x, int y, int w=-1, int h=-1)

Creates and returns a clickable button in the 3D display. The image parameter specifies the name of the icon to be displayed on the button. The callback parameter specifies the Python function to be executed when the button is clicked on. The position and dimensions of the button are specified by the parameters x, y, w, and h.

ViewerClick

void ViewerClick(int fxn, int x, int y, int gX, int gY, int w, int h)

This function performs an action in the display corresponding to a mouse click event in the 3D display window. Ordinarily, this function should not need to be called by the user.

ViewerCursorSet

void ViewerCursorSet(const std::string &mode)

This function sets the cursor style based on the mode parameter. Valid mode parameters are:

  • arrow - sets the cursor to the standard arrow cursor
  • back diagonal arrow - sets the cursor to a backwards diagonal double-ended arrow
  • blank - sets the cursor to a blank cursor (no cursor will appear)
  • busy - sets the cursor to be a busy indicator (an hourglass on many systems)
  • closed hand - sets the cursor to be a closed hand
  • cross - sets the cursor to two crossed lines
  • double arrow - sets the cursor to two crossed double-ended arrows
  • forbidden - sets the cursor to be a circle with a cross line through it
  • forward diagonal arrow - sets the cursor to a forwards diagonal double-ended arrow
  • horizontal arrow - sets the cursor to a horizontal double-ended arrow
  • ibeam - sets the cursor to an ibeam style cursor
  • open hand - sets the cursor to be an open hand
  • pointing - sets the cursor to be a pointing hand
  • rotation - same as cross
  • split horizontal - sets the cursor to two parallel horizontal lines with perpendicular arrows coming out of each line
  • split vertical - sets the cursor to two parallel vertical lines with perpendicular arrows coming out of each line
  • translation - same as double arrow
  • up arrow - sets the cursor to an upwards point arrow
  • vertical arrow - sets the cursor to a vertical double-ended arrow
  • wait - sets the cursor to a waiting indicator (an hourglass on many systems)
  • whats this - sets the cursor to be an arrow with an adjacent question mark

ViewerDepict

OEGLImage *ViewerDepict(const OEPropDB::OEKey &key, int x, int y, int width,
                        int height)

Creates and returns a depiction widget for the 3D display. The key parameter specifies which molecule to use for the depiction. The position and dimensions of the widget are specified by the x, y, width, and height parameters.

ViewerDepictionAntiAliasGet

bool ViewerDepictionAntiAliasGet()

Returns whether or not the lines used in drawing depictions in the 3D display should be anti-aliased.

ViewerDepictionAntiAliasSet

void ViewerDepictionAntiAliasSet(bool s)

Sets whether or not the lines used in drawing depictions in the 3D display should be anti-aliased.

ViewerDepictionHeightGet

float ViewerDepictionHeightGet()

Returns the percent of the total height of the 3D display that the active depiction display uses when drawing onto the 3D display.

ViewerDepictionLineWidthGet

float ViewerDepictionLineWidthGet()

Returns the width of the lines used in drawing depictions in the 3D display.

ViewerDepictionLineWidthSet

void ViewerDepictionLineWidthSet(float lw)

Sets the width of the lines used in drawing depictions in the 3D display.

ViewerDepictionSizeSet

float ViewerDepictionSizeSet(float percent)
float ViewerDepictionSizeSet(float perc_w, float perc_h)

Sets the percents of the total width and height of the 3D display that the active depiction display uses when drawing onto the 3D display. The perc_w parameter specifies the percent width and the perc_h specifies the percent height.

ViewerDepictionWidthGet

float ViewerDepictionWidthGet()

Returns the percent of the total width of the 3D display that the active depiction display uses when drawing onto the 3D display.

ViewerLabel

OEGLLabel *ViewerLabel(const std::string &message, int x, int y)

Creates and returns a text label which is displayed in the 3D window. The text is specified by the message parameter and the position is specified by the x and y parameters.

ViewerLabelDialog

void ViewerLabelDialog(const std::string &type)

Opens a dialog which allows the user to specify what types of labels to apply to either atoms or bonds.

ViewerMouseClick

void ViewerMouseClick(unsigned int state, unsigned int action)

This function specifies the desired action that should occur when a mouse click event is generated with the associated state. The state parameter specifies which mouse buttons were clicked as well as whether any modifier keys were depressed at the same time. State parameters can be added together to specify complicated states. Valid state parameters are:

  • MouseState_None
  • MouseState_Left
  • MouseState_Middle
  • MouseState_Right
  • MouseState_Shift
  • MouseState_Control
  • MouseState_Alt

Action parameters are distinct and cannot be added together like state parameters. Valid action parameters are:

  • MouseClick_None

  • MouseClick_Menu - creates a context specific popup menu

  • MouseClick_Select - selects the object that was clicked on and clears the

    previous selection

  • MouseClick_SelectAdd - selects the object that was clicked on, but does not

    clear the previous selection

  • MouseClick_SelectGrow - extends the selection of the object that was

    clicked on: atom -> residue -> chain -> mol and clears the previous selection

  • MouseClick_SelectAddGrow - extends the selection of the object that was

    clicked on: atom -> residue -> chain -> mol and clears the previous selection

  • MouseClick_SelectToggle - toggles the selection of the object that was

    clicked on

  • MouseClick_Label - displays a context specific label corresponding to the

    object that was clicked on

ViewerMouseDoubleClick

void ViewerMouseDoubleClick(unsigned int state, unsigned int action)

This function specifies the desired action that should occur when a mouse double-click event is generated with the associated state. The state parameter specifies which mouse buttons were clicked as well as whether any modifier keys were depressed at the same time. State parameters can be added together to specify complicated states. Valid state parameters are:

  • MouseState_None
  • MouseState_Left
  • MouseState_Middle
  • MouseState_Right
  • MouseState_Shift
  • MouseState_Control
  • MouseState_Alt

Action parameters are distinct and cannot be added together like state parameters. Valid action parameters are:

  • MouseClick_None

  • MouseClick_Menu - creates a context specific popup menu

  • MouseClick_Select - selects the object that was clicked on and clears the

    previous selection

  • MouseClick_SelectAdd - selects the object that was clicked on, but does not

    clear the previous selection

  • MouseClick_SelectGrow - extends the selection of the object that was

    clicked on: atom -> residue -> chain -> mol and clears the previous selection

  • MouseClick_SelectAddGrow - extends the selection of the object that was

    clicked on: atom -> residue -> chain -> mol and clears the previous selection

  • MouseClick_SelectToggle - toggles the selection of the object that was

    clicked on

  • MouseClick_Label - displays a context specific label corresponding to the

    object that was clicked on

ViewerMouseFunctionGet

unsigned int ViewerMouseFunctionGet()

Returns the current function of the mouse when used in the 3D display. For more details on the different types of functions, please see the documentation for ViewerMouseFunctionSet.

ViewerMouseFunctionNameGet

std::string ViewerMouseFunctionNameGet(unsigned int)

Returns the name of the specified mouse function.

ViewerMouseFunctionSet

void ViewerMouseFunctionSet(unsigned int action)
void ViewerMouseFunctionSet(const std::string &)

Sets the current function of the mouse when used in the 3D display. Valid functions are:

  • MouseClick_None - this tells the mouse to act according to behaviors specified by the current mouse map (this is the default behavior)
  • MouseClick_Label - this mode causes a detailed information label to appear on the screen regarding whatever is currently under the cursor
  • MouseClick_MeasureAngle - this puts the mouse into angle measurement mode
  • MouseClick_MeasureDistance - this puts the mouse into distance measurement mode
  • MouseClick_MeasureTorsion - this puts the mouse into torsion measurement mode

ViewerMouseMap

void ViewerMouseMap(const std::string &map)

This function sets the current mouse mapping. Valid parameters include:

  • vida
  • afitt
  • coot
  • insight
  • moe
  • o
  • quanta
  • rasmol
  • sybyl
  • maestro

ViewerMouseMove

void ViewerMouseMove(unsigned int state, unsigned int action,
                     unsigned int loc=OEGUI::MouseLocation::Both,
                     unsigned int dir=OEGUI::MouseDirection::Both)

This function specifies the desired action that should occur when a mouse movement event is generated with the associated state, in the specified location, and in the specified direction. The state parameter specifies which mouse buttons were clicked as well as whether any modifier keys were depressed at the same time. State parameters can be added together to specify complicated states. Valid state parameters are:

  • MouseState_None
  • MouseState_Left
  • MouseState_Middle
  • MouseState_Right
  • MouseState_Shift
  • MouseState_Control
  • MouseState_Alt

The location parameter specifies whether the mouse was inside or outside a central circular region in the 3D display. The bounds of this region can be displayed using the ViewerShowTrackballGuideSet scripting command. Valid location parameters are:

  • MouseLocation_None
  • MouseLocation_Inside
  • MouseLocation_Outside
  • MouseLocation_Both

The direction parameter specifies which direction of mouse motion should control the action. Valid direction parameters are:

  • MouseDirection_None
  • MouseDirection_X
  • MouseDirection_Y
  • MouseDirection_Both

Action parameters are distinct and cannot be added together like state parameters. Valid action parameters are:

  • MouseMotion_None

  • MouseMotion_RotateX - rotates the display along the X axis

  • MouseMotion_RotateY - rotates the display along the Y axis

  • MouseMotion_RotateZ - rotates the display along the Z axis

  • MouseMotion_Trackball - rotates the display using a trackball motion

  • MouseMotion_TranslateXY - translates the display along the X and Y axes

  • MouseMotion_TranslateX - translates the display along the X axis

  • MouseMotion_TranslateY - translates the display along the Y axis

  • MouseMotion_TranslateZ - translates the display along the Z axis

  • MouseMotion_Zoom - zooms the display

  • MouseMotion_Clip - controls the position of the far and near clipping

    planes in a mirrored fashion

  • MouseMotion_ClipFar - controls the position of the far clipping plane

  • MouseMotion_ClipNear - controls the position of the near clipping plane

  • MouseMotion_DepthcueBegin - controls the position of the start of the

    depthcueing calculation

  • MouseMotion_DepthcueEnd - controls the position of the end of the

    depthcueing calculation

  • MouseMotion_SelectRect - draws a rectangle on the screen and will select

    the entire contents of that rectangle when the mouse button is released while clearing the previous selection

  • MouseMotion_SelectRectAdd - draws a rectangle on the screen and will select

    the entire contents of that rectangle when the mouse button is released while keeping the previous selection

  • MouseMotion_Label - displays a context specific label containing

    information about whatever object is currently beneath the mouse

  • MouseMotion_Contour - adjusts the contour level of the grid contours in the

    current scope

  • MouseMotion_TextScale - adjusts the size of the text displayed in the 3D

    display

ViewerMouseOutsideAwareGet

bool ViewerMouseOutsideAwareGet()

Returns whether or not the display window recognizes mouse motion along the outside edge of the window as a potentially different action from mouse motion in the interior of the window. Ordinarily, this function should not need to be called by the user.

ViewerMouseOutsideAwareSet

bool ViewerMouseOutsideAwareSet(bool aware)

Sets whether or not the display window recognizes mouse motion along the outside edge of the window as a potentially different action from mouse motion in the interior of the window. Ordinarily, this function should not need to be called by the user.

ViewerMouseReset

void ViewerMouseReset()

Clears the current mouse mapping. Ordinarily, this function should not need to be called by the user. Furthermore, calling this function without rebuilding the mouse map will disable all interaction with the 3D window.

ViewerMouseSensitivityGet

float ViewerMouseSensitivityGet()

Returns the sensitivity of mouse event detection in the 3D window.

ViewerMouseSensitivitySet

float ViewerMouseSensitivitySet(float s)

Sets the sensitivity of mouse event detection in the 3D window.

ViewerMouseWheel

void ViewerMouseWheel(unsigned int state, unsigned int action)

This function specifies the desired action that should occur when a mouse wheel event is generated with the associated state. The state parameter specifies whether any modifier keys were depressed at the same time. State parameters can be added together to specify complicated states. Valid state parameters are:

  • MouseState_None
  • MouseState_Shift
  • MouseState_Control
  • MouseState_Alt

Action parameters are distinct and cannot be added together like state parameters. Valid action parameters are:

  • MouseMotion_None

  • MouseMotion_RotateX - rotates the display along the X axis

  • MouseMotion_RotateY - rotates the display along the Y axis

  • MouseMotion_RotateZ - rotates the display along the Z axis

  • MouseMotion_TranslateX - translates the display along the X axis

  • MouseMotion_TranslateY - translates the display along the Y axis

  • MouseMotion_TranslateZ - translates the display along the Z axis

  • MouseMotion_Zoom - zooms the display

  • MouseMotion_Clip - controls the position of the far and near clipping

    planes in a mirrored fashion

  • MouseMotion_ClipFar - controls the position of the far clipping plane

  • MouseMotion_ClipNear - controls the position of the near clipping plane

  • MouseMotion_DepthcueBegin - controls the position of the start of the

    depthcueing calculation

  • MouseMotion_DepthcueEnd - controls the position of the end of the

    depthcueing calculation

  • MouseMotion_Contour - adjusts the contour level of the grid contours in the

    current scope

  • MouseMotion_TextScale - adjusts the size of the text displayed in the 3D

    display

ViewerMove

void ViewerMove(int fxnX, int fxnY, int x, int y, int oldx, int oldy, int w, int h,
                bool first)

This function performs an action in the display window corresponding to a mouse move event in the 3D display window. Ordinarily, this function should not need to be called by the user.

ViewerPickSurfaceTrianglesGet

bool ViewerPickSurfaceTrianglesGet()

Returns whether or not picking on a surface picks individual triangles as opposed to picking the entire surface. Ordinarily, this function should not need to be called by the user.

ViewerPickSurfaceTrianglesSet

bool ViewerPickSurfaceTrianglesSet(bool enable)

Sets whether or not picking on a surface picks individual triangles as opposed to picking the entire surface. Ordinarily, this function should not need to be called by the user.

ViewerProgress

OEGLProgress *ViewerProgress(const std::string &message)

Creates and returns a progress bar display shown in the 3D window. The message parameter specifies the text associated with the progress bar.

ViewerRemoveWidget

void ViewerRemoveWidget(OEGLWidget *widget, bool update)

This function removes the specified widget from the 3D display. The update parameter specifies whether or not all the other widgets in the 3D display need to be updated as a result of this change.

ViewerTextBox

OEGLTextBox *ViewerTextBox(const OEPropDB::OEKey &key, int x=-1, int y=-1,
                           int w=-1, int h=-1)
OEGLTextBox *ViewerTextBox(const std::string &message, int x=-1, int y=-1,
                           int w=-1, int h=-1)

Creates and returns a text display widget to be shown in the 3D display. The parameter message specifies the current text. The position and dimensions of the widget are specified by the parameters x, y, w, and h.

ViewerUseInertiaGet

bool ViewerUseInertiaGet()

Returns whether or not the 3D display window tracks the inertia of mouse movements and uses that to keep the scene spinning after the mouse button is released.

ViewerUseInertiaSet

bool ViewerUseInertiaSet(bool state)

Sets whether or not the 3D display window tracks the inertia of mouse movements and uses that to keep the scene spinning after the mouse button is released.

ViewerUseKeyMapGet

bool ViewerUseKeyMapGet()

Returns whether or not the viewer is using its own internal key bindings. Ordinarily, this function does not need to be called by the user.

ViewerUseKeyMapSet

bool ViewerUseKeyMapSet(bool state)

Sets whether or not the viewer is using its own internal key bindings. Ordinarily, this function does not need to be called by the user.

ViewerWheel

void ViewerWheel(int fxn, int x, int y, int delta)

This function performs an action in the display window corresponding to a mouse wheel event in the 3D display window. Ordinarily, this function should not need to be called by the user.

ViewerWidgetUpdate

void ViewerWidgetUpdate()

Forces an update of all the display widgets in the 3D display.

WaitBegin

void WaitBegin()

This function sets the application in a waiting state. It is used for long operations. Ordinarily this function should not need to be called by the user.

WaitEnd

void WaitEnd()

This function stops the application in a waiting state. It is used for long operations. Ordinarily this function should not need to be called by the user.

WindowEnabledGet

bool WindowEnabledGet(const std::string &windowName)

Returns whether or not the specified window is enabled for use within VIDA.

WindowEnabledSet

void WindowEnabledSet(const std::string &windowName, bool enabled)

Sets whether or not the specified window is enabled for use within VIDA.

WindowMenuUpdate

void WindowMenuUpdate()

Updates the contents of the main Window menu.

WindowRegisterHotkey

void WindowRegisterHotkey(const std::string &windowName,
                          const std::string &keystroke,
                          const std::string &pyCommand)

Registers the specified keystroke with the associated Python command in the specified window. If this keystroke is detected when the specified window has the application focus, the associated command will be run.

WindowVisibleGet

bool WindowVisibleGet(const std::string &windowName)

Returns whether or not the specified window is currently visible.

WindowVisibleSet

bool WindowVisibleSet(const std::string &windowName, bool visible,
                      const std::string &pos="")

Sets whether or not the specified window is currently visible.

Table Of Contents

Previous topic

Scope Functions

Next topic

Display Functions