Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
GuiApp Class Reference

Defines graphical user interface application. More...

Inheritance diagram for GuiApp:
AppObject OfApp AppBase EventObject CoreCustomData CoreBaseObject CoreBaseType ClarisseApp

Public Types

enum  ImageHistoryMode {
  IMAGE_HISTORY_MODE_AUTOMATIC = 0,
  IMAGE_HISTORY_MODE_MANUAL
}
 
typedef void(* GuiAppCallback )(void *)
 
typedef void(* GuiAppMouseListenerCallback )(GuiWidget &receiver, const CoreString &evt, void *data)
 
- Public Types inherited from AppObject
enum  { MAX_WAIT_TIME = (unsigned int) -1 }
 
typedef CoreString(* LogCallback )(const AppObject &, void *)
 
- Public Types inherited from OfApp
enum  ReferenceLoadingMode {
  REFERENCE_LOADING_MODE_AUTOMATIC,
  REFERENCE_LOADING_MODE_MANUAL
}
 
enum  SceneMode {
  MODE_DEFAULT = 0,
  MODE_PROJECT = 1,
  MODE_BUILD
}
 
typedef bool(* DirectiveCallback )(const ParserEntry &entry, OfItemHandle item)
 Callback to handle directive.
 
typedef void(* ProgressUpdateCallback )(void *data, const CoreString &object_name, const float &progress)
 Function called when the progress value of any process has changed.
 
- Public Types inherited from AppBase
enum  Type {
  TYPE_PROCESS,
  TYPE_INTERACTIVE,
  TYPE_GUI,
  TYPE_COUNT
}
 
enum  Flavor {
  FLAVOR_IFX,
  FLAVOR_BUILDER
}
 
enum  EvaluatorAddMode {
  EVALUATOR_ADD_MODE_HEAD,
  EVALUATOR_ADD_MODE_TAIL,
  EVALUATOR_ADD_MODE_COUNT
}
 
enum  AccelerationMode {
  ACCELERATION_MODE_FULL_INTERACTIVITY,
  ACCELERATION_MODE_FAVOR_INTERACTIVITY_OVER_SPEED,
  ACCELERATION_MODE_FAVOR_SPEED_OVER_INTERACTIVITY,
  ACCELERATION_MODE_FULL_SPEED,
  ACCELERATION_MODE_COUNT
}
 
enum  DisplacementStorageMode {
  DISPLACEMENT_STORAGE_MODE_FAVOR_MEMORY,
  DISPLACEMENT_STORAGE_MODE_FAVOR_SPEED,
  DISPLACEMENT_STORAGE_MODE_COUNT
}
 
enum  EvalFps {
  EVAL_FPS_LAYOUT_VIEW,
  EVAL_FPS_RENDERING,
  EVAL_FPS_SHADING,
  EVAL_FPS_COMPOSITING,
  EVAL_FPS_DEFAULT,
  EVAL_FPS_COUNT
}
 
enum  CurveSizeMode {
  CURVE_SIZE_MODE_SMALL,
  CURVE_SIZE_MODE_MEDIUM,
  CURVE_SIZE_MODE_LARGE,
  CURVE_SIZE_MODE_COUNT
}
 
enum  FileBrowserMode {
  FILE_BROWSER_MODE_NATIVE,
  FILE_BROWSER_MODE_CLARISSE,
  FILE_BROWSER_MODE_COUNT
}
 
enum  ObjectUicolorMode {
  OBJECT_UICOLOR_MODE_TAG,
  OBJECT_UICOLOR_MODE_CLASS,
  OBJECT_UICOLOR_MODE_COUNT
}
 
enum  InputDeviceMode {
  INPUT_DEVICE_MODE_AUTODETECT,
  INPUT_DEVICE_MODE_FORCE_MOUSE,
  INPUT_DEVICE_MODE_FORCE_TABLET,
  INPUT_DEVICE_MODE_COUNT
}
 
enum  MotionBlurDirectionMode {
  MOTION_BLUR_DIRECTION_MODE_BACKWARD,
  MOTION_BLUR_DIRECTION_MODE_CENTERED,
  MOTION_BLUR_DIRECTION_MODE_FORWARD,
  MOTION_BLUR_DIRECTION_MODE_COUNT
}
 
enum  IxPythonVersion
 
enum  VerifiableState {
  ALEMBIC_CACHE_COHERENCY = 0,
  VERIFIABLE_STATE_COUNT
}
 
typedef void(* DirectiveCallback )(ParserEntry *, OfItem *)
 
typedef bool(* VerifyStateCallback )(bool)
 
- Public Types inherited from EventObject
typedef void(* EventInfoFunction )(EventObject &, const EventInfo &, void *)
 event callback signature for free functions / static methods.
 
typedef void(EventObject::* EventInfoMethod )(EventObject &, const EventInfo &, void *)
 event callback signature for methods.
 
typedef void(* EventFunction )(EventObject &, const CoreString &, void *)
 
typedef void(EventObject::* EventMethod )(EventObject &, const CoreString &, void *)
 

Public Member Functions

 GuiApp (int argc, char **argv)
 
GuiColorSchemeget_color_scheme ()
 
GuiWindowcreate_window (const int &x, const int &y, const int &w, const int &h, const CoreString &title="")
 
GuiWindowget_top_window () const
 Return the top most window.
 
virtual void maximize_view (GuiViewport *view)
 
virtual void restore_view ()
 
void add_mouse_listener (GuiAppMouseListenerCallback cbk, void *data=0)
 Add a global mouse listener callback. Each timer a mouse event is spawned the specified callback is called with the proper event type and widget that will receive the event. You need to remove manually the callback using remove_mouse_listener. This method is thread safe.
 
void remove_mouse_listener (GuiAppMouseListenerCallback cbk, void *data=0)
 Remove the first global mouse listener callback that matches the specified callback and data. . This method is thread safe.
 
virtual AppDialog message_box (const CoreString &message, const CoreString &title="Information", const AppDialog &default_value=AppDialog::ok(), const int &style=AppDialog::STYLE_OK, int *geometry=0, const CoreVector< CoreString > &list=CoreVector< CoreString >()) const override
 Popup the application message box.
 
virtual CoreString open_file (const CoreString &directory, const CoreString &title, const CoreString &filter) override
 Open a file browser and returns the path of the file choosed by the user.
 
virtual void check_for_events () override
 Calls an iteration of the main loop by calling registered callbacks and launching pending evaluations.
 
void check_for_events (const bool &process_callbacks)
 Refresh the display and iterate on the main loop. Call this if you want to keep the event flowing to widgets during big calculation or if you simulate a modal window.
 
bool is_drawing () const
 
void force_redraw ()
 
void enable () override
 Enables application and its sub-widgets.
 
void disable () override
 Disables application and its sub-widgets.
 
bool is_enabled () const override
 
GuiColorDialogget_color_dialog ()
 Returns static color dialog.
 
void reset_color_dialog ()
 This is used by the color dialog itself to make sure we won't try accessing it if it is being deleted.
 
GuiBrowserPickerget_browser_picker ()
 Returns static browser picker.
 
GuiFileBrowserget_file_browser ()
 Returns static file browser.
 
GuiFloatingWindowopen_default_widget (OfItemHandle selected_item, bool open_new_window=false, bool update_selection=true, void *viewport_custom_data=0)
 
GuiFloatingWindowopen_default_widget (OfItemHandle selected_item, CoreVector< OfItemHandle > selected_items, bool open_new_window=false, bool update_selection=true, void *viewport_custom_data=0)
 
GuiFloatingWindowopen_items_in_widget (const CoreString &widget_class_name, const CoreVector< OfItemHandle > &selected_items, bool open_new_window=false, bool update_selection=true, void *viewport_custom_data=nullptr)
 
virtual GuiFloatingWindowopen_new_floating_widget_window (GuiWindow &window, const CoreString &class_name, const CoreString &title, const int &x, const int &y, const int &width, const int &height, const bool &use_viewport=true, void *viewport_custom_data=0)
 
virtual GuiWindowget_event_window () const
 
void set_preferences () override
 
bool populate_prefs () override
 
const GMathVec3d & get_foreground_color () const
 
void set_foreground_color (const GMathVec3d &color)
 
const GMathVec3d & get_background_color () const
 
void set_background_color (const GMathVec3d &color)
 
void set_color_scheme (const GuiColorScheme &scheme)
 
void update_color_scheme (const GuiColorScheme &scheme)
 
void new_workspace (SceneMode scene_mode=MODE_DEFAULT) override
 Create a new project and kill any evaluation.
 
void lock_draw ()
 Lock the draw call of all widgets. You shouldn't need to use this method. Most of the events that are synchronious. However in some case such as when connected to the Resource Manager events are sent asynchroniously.
 
void unlock_draw ()
 Unlock the draw call of all widgets. See lock_draw() for more infos.
 
const CoreStringget_clipboard () const
 
virtual void set_clipboard (const CoreString &clipboard)
 
void quit () override
 
bool get_image_view_bilinear_filtering () const
 
void set_image_view_bilinear_filtering (const bool &filter)
 
void set_image_view_overscan_opacity (const float &value)
 
const float & get_image_view_overscan_opacity () const
 
void set_auto_eval_changed (const bool normal_mode, const bool state)
 
const unsigned int & get_max_log_widget_lines_number () const
 
void set_max_log_widget_lines_number (const unsigned int &count)
 
const CoreStringget_default_view_transform () const override
 
void set_default_view_transform (CoreBasicString view_transform) override
 
const CoreStringget_color_picker_color_space_name (const bool real_value=false) const override
 
void set_color_picker_color_space (const CoreString &name) override
 
bool convert_linear_to_default (GMathVec4f &color)
 
const ColorIOConverterget_linear_to_default_converter () const
 
const bool get_always_compute_full_quality () const
 
void set_always_compute_full_quality (const bool &enable)
 
bool is_progress_update () const
 
ImageHistoryMode get_image_history_mode () const
 
void set_image_history_mode (ImageHistoryMode mode)
 
unsigned int get_image_history_size () const
 
void set_image_history_size (const unsigned int &size)
 
bool get_clear_history_on_new_project () const
 
void set_clear_history_on_new_project (const bool &value)
 
const bool is_image_history_autosave () const
 
void set_image_history_autosave (const bool &enable)
 
const CoreStringget_image_history_cache_path () const
 
void set_image_history_cache_path (const CoreString &value)
 
unsigned int get_image_history_cache_max_count () const
 
void set_image_history_cache_max_count (const unsigned int &value)
 
unsigned int get_image_history_cache_max_size () const
 
void set_image_history_cache_max_size (const unsigned int &value)
 
void set_snapshot_mode (const unsigned int &mode)
 
bool get_clear_history_cache_on_exit () const
 
void set_clear_history_cache_on_exit (const bool &value)
 
bool get_clear_history_cache_on_new_project () const
 
void set_clear_history_cache_on_new_project (const bool &value)
 
Gui::DeviceId get_input_device_type ()
 Get current device type, based on current active device and on the Preference "Input Device Mode".
 
Gui::WindowsTabletApi get_windows_tablet_api () const
 
void set_windows_tablet_api (Gui::WindowsTabletApi api)
 
void clear_recent_script_files ()
 
void add_recent_script_file (const CoreString &file)
 
CoreArray< CoreStringget_recent_script_files () const
 
CoreString get_associations_file_path () const
 
AppOpenWithAssociations & get_associations ()
 
GuiImageHistoryget_image_history ()
 
void get_statistics (SysStatistic &stats) const override
 gather application-wide statistic data (memory usage, objects count...)
 
size_t get_memory_size () const override
 
const GuiIconget_placeholder_icon (const CoreString &placeholder_label)
 
CoreSet< CoreString > & get_placeholder_labels ()
 
virtual const CoreStringget_clipboard_serialization_header ()
 
bool retrieve_context (const CoreString &top_context, CoreString &retrieved_context, const CoreString &picker_title="") override
 
bool retrieve_object (const CoreString &top_context, const CoreString &class_name, CoreString &retrieved_object, const CoreString &picker_title="") override
 
void set_vizroot (OfContext *vizroot) override
 
OfObjectHandle get_object_in_vizroot (OfObjectHandle object) const
 
virtual void set_status_bar_message (const CoreString &msg)
 
bool is_saving_crash_file () const override
 
void disable_all_viewports_auto_evaluation (void)
 This will disable the auto evaluation on all viewports registered to this application.
 
void restore_all_viewports_auto_evaluation (void)
 
- Public Member Functions inherited from AppObject
 AppObject (int argc, char **argv)
 
const AppConfigget_config () const
 
AppConfigget_config ()
 
virtual void populate_project_prefs ()
 
const OfObjectFactoryget_factory () const override
 
OfObjectFactoryget_factory () override
 
const AppResourceManager & get_resources () const
 
AppResourceManager & get_resources ()
 
void scan_modules ()
 
void scan_modules (const CoreVector< CoreString > &folder_paths)
 
virtual CoreString get_application_header () const
 
CoreString get_window_header () const
 
AppSelectionget_selection ()
 
const AppSelectionget_selection () const
 
void unload_resources (const AppSelection &selection)
 
void unload_resources (const CoreVector< OfItemHandle > &selection)
 
void remove_items_from_selection (const CoreBasicArray< OfContext * > &contexts, const CoreBasicArray< OfObjectHandle > &objects) override
 
double get_current_frame () const
 
double get_current_time () const
 
double get_evaluation_frame () const override
 
double get_evaluation_time () const override
 
double get_evaluation_quality () const override
 
AppBuiltinCommandsget_builtin_commands ()
 
virtual void clear_project ()
 
virtual bool load_startup_scene ()
 
virtual bool load (const CoreString &filename, SceneMode scene_mode=MODE_DEFAULT)
 Load a scene from a file supported by Clarisse.
 
virtual bool save (const CoreString &filename, bool autosave=false, SceneMode scene_mode=MODE_DEFAULT)
 Save the current project or build to the specified file on disk, depending of the current running license or the current scene mode if specified. If iFX, it saves a project file, otherwise a build file.
 
virtual bool export_context_as_project (const CoreString &filename, const OfContext &context, bool include_dependencies=false)
 
virtual bool export_context_as_build (const CoreString &filename, const OfContext &context, bool include_dependencies=false)
 
virtual void preload_project_preferences (const ParserGroup &preferences)
 
virtual void load_project_preferences (const ParserGroup &preferences)
 
virtual void save_project_preferences (ParserGroup &preferences)
 
void new_project ()
 Clear the current project and create a new empty one.
 
void new_build ()
 Clear the current build and create a new empty one.
 
bool load_project (const CoreString &filename)
 Load a scene from a project file (.project)
 
bool load_build (const CoreString &filename)
 Load a scene from a build file (.build)
 
bool save_project (const CoreString &filename, bool autosave=false)
 Save the current project to the specified file on disk.
 
bool save_build (const CoreString &filename, bool autosave=false)
 Save the current build to the specified file on disk.
 
AppObjectClassPreferenceget_class_preference (const CoreString &name) const
 Returns the project preference object previously set for a given OfClass name, 0 if not found.
 
void set_class_preference (const CoreString &name, AppObjectClassPreference *pref)
 Assigns a project preference object (aka 'pref') to a given OfClass name. Takes ownership of the pref. These prefs are serialized in the preferences/classes section of the project file.
 
CoreString get_startup_scene_filename ()
 
AppPreferencesget_prefs (AppPreferences::Mode mode=AppPreferences::MODE_PROJECT)
 
const AppPreferencesget_prefs (AppPreferences::Mode mode=AppPreferences::MODE_PROJECT) const
 
bool get_use_in_place_parenting () const override
 
void set_use_in_place_parenting (const bool &enable) override
 
CoreString get_python_api_path () const
 
OfClassget_language_from_extension (const CoreString &extension) override
 
OfClassget_scripting_engine_from_extension (const CoreString &extension) override
 
void register_scripting_engine (const OfObject &engine_obj)
 
OfObjectget_scripting_engine_object (const CoreString &engine_class_name)
 
CoreString get_default_scripting_engine_class_name () const
 
OfObjectget_default_scripting_engine_object ()
 
ModuleScriptingget_default_scripting_engine_module ()
 
void show_python_configuration_error ()
 
bool run_single_script (const CoreString &script, CoreString &result) override
 
bool run_single_script (const CoreString &script) override
 
bool run_single_script (const SysFile &file, CoreString &result) override
 
bool run_single_script (const SysFile &file) override
 
bool request_temp_sub_folder (const CoreString &requested_name, CoreString &usable_path) override
 
CoreString get_temp_folder () const override
 
bool set_temp_folder (const CoreString &temp_folder)
 
const bool & is_managing_temp_folders () const
 
void set_managing_temp_folders (const bool &is_managing)
 
const CoreVector< CoreString > & get_search_paths () const override
 
void set_search_paths (const CoreVector< CoreString > &paths) override
 
virtual OfContextget_working_context () const
 
virtual void on_selection_change (const CoreString &group, const CoreString &slot)
 
virtual void on_working_context_change (const CoreString &slot, const OfContext *context)
 
void get_log_history (CoreVector< AppLogMessage > &log_msg) const
 
void set_enable_file_logging (const bool &enable)
 
void set_log_file_path (const CoreString &file_path)
 
void set_specified_log_file (const CoreString &file_path)
 
void set_log_file_policy (const unsigned int &policy)
 
void set_enable_verbose_log_file (const bool &enable)
 
virtual void set_previz_light_group (ModuleGroup *group)
 
const bool & get_enable_file_logging () const
 
const CoreStringget_log_file_path () const
 
const CoreStringget_specified_log_file () const
 
int get_log_file_policy () const
 
virtual const CoreBasicArray
< ModuleLight * > & 
get_previz_lights () const
 
virtual ModuleGroupget_previz_light_group () const
 
const unsigned int & get_selection_history_size () const
 
void set_selection_history_size (const unsigned int &size)
 
void set_current_frame_range (const double &range_min, const double &range_max)
 
void set_current_frame_range_min (const double &range_min)
 
void set_current_frame_range_max (const double &range_max)
 
const GMathVec2d & get_current_frame_range () const
 
void add_evaluator (AppEvaluator &evaluator, const AppBase::EvaluatorAddMode &mode, const AppBase::EvalFps &fps) override
 
void add_evaluator (AppEvaluator &evaluator, const double &priority, const AppBase::EvalFps &fps) override
 
void remove_evaluator (AppEvaluator &evaluator) override
 
void stop_evaluation (const bool &blocking=false) override
 
bool is_evaluating () const override
 
bool must_stop_evaluation () const override
 
bool is_evaluation_interrupted () const override
 
void clear_evaluation () override
 
unsigned int get_minimum_eval_time () const
 
void set_minimum_eval_time (const unsigned int &time_ms, const AppBase::EvalFps &fps)
 
bool is_minimum_time_elapsed () const
 
void add_to_event_loop (AppCallback cbk, void *data=0) override
 Add a callback that will be called at each iteration of the main loop. The data passed as argument is passed as argument of the callback. This method is thread safe.
 
void remove_from_event_loop (AppCallback cbk, void *data=0) override
 Remove the specified callback associated with the specified data. The callback will be removed only if the data matches the one given to the AppObject::add_to_event_loop() function. This method is thread safe.
 
void add_timer (const unsigned int &time_ms, AppCallback cbk, void *data=0, const bool &update=true) override
 Add a timer callback that will be called approximatively in the specified time. The data passed as argument is passed as argument of the callback. If you want to repeat the timer callback please use AppObject::repeat_timer(). This method is thread safe.
 
void repeat_timer (const unsigned int &time_ms, AppCallback cbk, void *data=0) override
 Call this method if you wish to repeat a previously added timer This method is thread safe.
 
void remove_timer (AppCallback cbk, void *data=0) override
 Remove the specified callback associated with the specified data. The callback will be removed only if the data matches the one given to the AppObject::add_timer() function. This method is thread safe.
 
virtual void run ()
 
void run_thread (SysThread &thread)
 Run a SysThread and manage its deletion.
 
const bool & is_started () const
 
const bool & is_running () const
 
const bool & is_quitting () const
 
void wait_for_events () override
 Wait for the first event in the main loop and do an iteration by calling registered callbacks and launching pending evaluations.
 
CoreString get_project_statistics_as_string () const
 return a human readable string of the application-wide statistics
 
CoreString get_OIIO_statistics_as_string (int log_level) const
 return a human readable string of the application-wide statistics
 
CoreString get_all_statistics_as_string () const
 return a human readable string of the all application-wide statistics
 
bool add_statistic_logger (const CoreString &name, const LogCallback &log_callback, void *log_data)
 
void remove_statistic_logger (const CoreString &name)
 
CoreString get_statistics_log (const CoreString &name) const
 
int get_OIIO_statistics_log_level () const
 
void set_OIIO_statistics_log_level (int value)
 
void clear_texture_cache ()
 clears OpenImageIO cache
 
const OfContextget_current_context () const
 
void ls (const CoreString &path="") const
 
void cd (const CoreString &context_path="")
 
void init_directives () override
 
void add_directive (ParserEntry *entry, const OfItemHandle &item) override
 
void execute_directives () override
 
void set_texture_cache (const double &size) override
 
void update_texture_cache_usage_pref ()
 Update the read-only preference "stream_texture_cache_usage".
 
AppDialog inspect (OfObjectHandle object, const AppDialog &default_value=AppDialog::ok(), const int &style=AppDialog::STYLE_OK, const CoreString &title="") const
 Displays the specified object contextually.
 
virtual AppDialog inspect (const CoreArray< OfObjectHandle > &objects, const AppDialog &default_value=AppDialog::ok(), const int &style=AppDialog::STYLE_OK, const CoreString &title="") const
 Displays the specified objects contextually.
 
int get_argc () const
 Return the number of argument passed to the application.
 
char ** get_argv () const
 Return the command line argument sent to the application.
 
void set_current_project_filename (const CoreString &filename)
 
const CoreStringget_current_project_filename () const override
 
double get_current_project_version () const final
 
double get_current_object_framework_version () const final
 
const CoreArray< CoreString > & get_current_project_dependencies () const
 
CoreString import_project (const CoreString &filename, void *requester=0)
 
CoreArray< CoreStringimport_project (const CoreVector< CoreString > &filenames, void *requester=0)
 
void set_import_variables_mode (const OfImportOptions::VariableMode &mode)
 
const
OfImportOptions::VariableMode & 
get_import_variables_mode () const override
 
void set_import_aov_mode (const OfImportOptions::AovMode &mode)
 
const OfImportOptions::AovMode & get_import_aov_mode () const
 
void enable_command_port (const bool &active=true)
 Enable or disable the command port.
 
bool is_command_port_active () const
 Return if the command port is active.
 
unsigned int get_command_port () const
 Return command port number.
 
void set_command_port (const unsigned int &port)
 Set the command port number. Changing value disconnects connected clients.
 
AppShelfget_shelf ()
 
bool reset_default_shelf (const bool &remove_all=true, const bool &use_env_config=true)
 
void clear_context_overrides (OfContext &context) override
 
void cleanup_context_overrides (OfContext &context) override
 
void create_override_set (OfContext &context) override
 
virtual void set_wait_mode (const bool &mode)
 
AppCopyBufferget_copy_buffer ()
 
bool check_filter_matches (const OfContext &base_context, OfConstItemHandle object, const CoreString &filter) override
 Returns true if the incoming object name matches a text filter.
 
bool check_filter_matches (const OfContext &base_context, const CoreString &item_name, const CoreString &filter) override
 Returns true if the incoming object name matches a text filter.
 
bool check_filter_matches (const CoreString &prefix, const CoreString &str_value, const CoreString &filter) override
 Returns true if the incoming object name matches a text filter.
 
void get_matching_objects (CoreVector< OfObjectHandle > &result, const CoreString &rule, const OfContext &base_context, const CoreBasicArray< CoreString > &filter_classes, const CoreBitFieldHelper &flags=OfItem::empty_flags_mask, const bool embedded_objects=false, const OfContext *search_root=0) override
 Get objects that match a text filter.
 
void get_matching_objects (CoreVector< OfObjectHandle > &result, const CoreString &filter, const OfContext &base_context, const CoreString &filter_class="ProjectItem", const CoreBitFieldHelper &flags=OfItem::empty_flags_mask, const bool embedded_objects=false, const OfContext *search_root=0) override
 Get objects that match a text filter.
 
void get_matching_objects (CoreVector< OfObjectHandle > &result, const CoreString &filter, const CoreString &filter_class="ProjectItem", const CoreBitFieldHelper &flags=OfItem::empty_flags_mask, const bool embedded_objects=false) override
 Get objects that match a text filter.
 
bool get_matching_contexts (CoreSet< OfContext * > &result, const CoreString &filter, const OfContext &base_context) override
 Get contexts that match a text filter.
 
bool is_experimental_features_enabled () const override
 
bool is_beta_features_enabled () const override
 
void init_config (const bool &check_migration_config_file, const bool &force_migration=false)
 
void save_config () override
 
AppUnitsget_units (const AppUnits::Mode mode=AppUnits::MODE_PROJECT) const
 
virtual AppMainMenuget_main_menu ()
 
void check_migration_config_file (const bool &forced_import)
 
virtual void initialize_builtin_commands ()
 Provides a way to register builtin commands out of the constructor, then it is possible to use virtual method on this.
 
const bool & project_has_directives () const
 
virtual void copy (bool include_dependencies=false)
 
virtual void copy (const CoreVector< CoreString > &items_names, bool include_dependencies=false)
 
virtual void cut (const CoreVector< CoreString > &items_names, void *requester=0)
 
virtual void paste ()
 
virtual void paste (const bool &select, const CoreString &context_path, const CoreString &slot, void *requester=0)
 
CoreString get_scripting_command (const CoreString &command_id, const CoreBasicArray< OfCommandArgument > &arguments) override
 
CoreString get_default_integration_model () const
 
bool set_mutable_vizroot (OfObject *mutable_node, bool update_vizroot)
 Tune application to use a traversal object (NodalItemDot, SceneAssemblySwitch) as current vizroot.
 
OfObjectget_mutable_vizroot () const
 
void on_remove_vizroot (OfObjectFactory &factory, const EventInfo &evt, void *data)
 
void on_vizroot_set_dirty (OfObjectFactory &factory, const EventInfo &evt, void *data)
 
- Public Member Functions inherited from OfApp
const OfConfigget_config () const
 
OfConfigget_config ()
 
void register_directive (const CoreString &name, DirectiveCallback callback)
 
void add_directive (ParserEntry *entry, const OfItemHandle &item) override
 
const OfChannelManagerget_channel_manager () const
 
OfChannelManagerget_channel_manager ()
 
bool add_custom_variable (const CoreString &name, const CoreVariant &value, const OfAttr::Type type=OfAttr::TYPE_STRING, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT)
 
bool append_custom_variable (const CoreString &name, const CoreString &value, const bool &replace_existing)
 
bool remove_custom_variable (const CoreString &name)
 
void clear_custom_variables ()
 
bool load_custom_variables (const CoreString &filename)
 
bool save_custom_variables (const CoreString &filename)
 
CoreString get_project_header ()
 return current project header This should be used if you want to serialize a Clarisse project.
 
const OfCommandManagerget_command_manager () const
 
OfCommandManagerget_command_manager ()
 
void echo_command (bool value)
 
OfBatchCommandcreate_batch_command ()
 
void exec_batch_command (OfBatchCommand &cmd)
 
const unsigned int & get_history_size () const
 
void set_history_size (const unsigned int &size)
 
bool get_attr_auto_localize () const
 
void set_attr_auto_localize (const bool &value)
 
void set_reference_loading_mode (long mode)
 
ReferenceLoadingMode get_reference_loading_mode () const
 
void begin_of_deserialize (const OfContext &ctx, const CoreString &sender=CoreString::get_null_string())
 For OF internal use: ensure a unique event is sent when loading recursively.
 
void end_of_deserialize (const OfContext &ctx, const CoreString &sender=CoreString::get_null_string())
 For OF internal use: ensure a unique event is sent when loading recursively.
 
const int & get_alembic_log_level () const
 
void set_alembic_log_level (const int &level)
 
const int & get_alembic_instance_detection () const
 
void set_alembic_instance_detection (const int &detection)
 
bool is_visible_object (const OfObject *obj) const
 Return true if the specified item should be displayed.
 
bool is_visible_item (const OfItem *obj) const
 
OfAttrValueManagerget_attr_value_manager () const
 
const OfNodalPositionManagerget_nodal_position_manager () const
 
OfNodalPositionManagerget_nodal_position_manager ()
 
bool add_progress_update_callback (void *data, ProgressUpdateCallback on_progress_update)
 This function registers a new progress update item.
 
void remove_progress_update_callback (void *data)
 Removes a progress update receiver.
 
void update_progress_receivers (const CoreString &object_name, const float &value)
 Notify all progress receivers that a progress value has changed.
 
size_t get_memory_size () const override
 
void declare_of_commands ()
 
void add_cam_attribute (const CoreVector< CoreString > &context_paths, const OfItem::AttrCreationParams &creation_params, const CoreString &cam_rule, const CoreString &cam_exclusion_rule, void *requester=0)
 
void edit_cam_attribute (const CoreVector< CoreString > &context_paths, const OfItem::AttrCreationParams &creation_params, const CoreString &cam_rule, const CoreString &cam_exclusion_rule, void *requester=0)
 
void add_cam_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &context_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_visual_hint, const CoreString &group_name, const CoreString &cam_rule, void *requester=0)
 
void add_cam_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &context_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_visual_hint, const CoreString &group_name, const CoreString &cam_rule, const CoreString &cam_exclusion_rule, void *requester=0)
 
void edit_cam_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &attr_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_vh, const CoreString &group_name, const CoreString &cam_rule, void *requester=0)
 
void edit_cam_attribute (CoreVector< CoreString > &created_attrs, const CoreVector< CoreString > &attr_paths, const CoreString &attr_name, const int &attr_type, const int &attr_container, const int &attr_vh, const CoreString &group_name, const CoreString &cam_rule, const CoreString &cam_exclusion_rule, void *requester=0)
 
void remove_cam_attribute (const CoreBasicArray< CoreString > &attr_paths, void *requester=0)
 
void remove_all_cam_attributes (const CoreBasicArray< CoreString > &context_paths, void *requester=0)
 
void edit_cam_rule (const CoreBasicArray< CoreString > &attr_paths, const CoreString &cam_rule, void *requester=0)
 
void edit_cam_rule (const CoreBasicArray< CoreString > &attr_paths, const CoreString &cam_rule, const CoreString &cam_exclusion_rule, void *requester=0)
 
void disable_cam (const CoreBasicArray< CoreString > &attr_paths, const bool &disabled, void *requester=0)
 
void save_cam_set (const CoreString &context_path, void *requester=0)
 
void save_cam_set (const CoreBasicArray< CoreString > &context_paths, const CoreString &target_context_path, void *requester=0)
 
void load_cam_set (const CoreBasicArray< CoreString > &context_paths, const CoreString &cam_set, void *requester=0)
 
const OfContextget_vizroot () const
 
OfContextget_vizroot ()
 
virtual bool is_child_of_vizroot (OfConstItemHandle item, CoreSet< OfContext * > *valid_ctx_cache=0)
 check if the context of object is contained in the application vizroot Mainly intended for widgets to decide wheter item is visible or not. Also used by OfItem::is_editable (through OfItem::is_build_visible) to make sure that nobody can modify items outside vizroot.
 
bool is_auto_saving () const
 
- Public Member Functions inherited from AppBase
Flavor get_flavor () const
 
const char * get_file_extension () const
 
const char * get_ple_file_extension () const
 
bool is_file_extension_supported (const CoreString &filename) const
 
CoreVector< CoreStringget_project_extension_name () const
 Get the allowed file extensions for the current running license.
 
CoreVector< CoreStringget_import_project_extension_name () const
 Get the allowed file extensions for importing project files.
 
const Type & get_type () const
 
const SysThreadId * get_thread_id () const
 
bool is_app_thread () const
 Return true if our execution context is the same as app thread (main loop)
 
SysThreadManagerget_thread_manager () const
 
const unsigned int & get_max_thread_count () const
 gets maximum current machine threads
 
const unsigned int & get_thread_count () const
 gets maximum application threads
 
virtual void set_thread_count (const unsigned int &thread_count)
 sets application thread count
 
void run_thread_task (SysThreadTask &task, const bool &auto_delete=true, const bool &is_preemptible=false)
 adds a task to task manager
 
unsigned long get_runtime () const
 Get elapsed time since application started.
 
virtual void awake (AppCallback callback, void *data)
 
CoreString resolve_path (const CoreString &file_path) const
 
CoreVector< CoreStringresolve_paths (const CoreBasicArray< CoreString > &file_paths, bool verbose=false) const
 
virtual const LicenseInfo & get_license () const
 Return the application license.
 
virtual CoreString get_name () const
 Return the application name from the license.
 
virtual CoreString get_vendor () const
 
AppProgressBarcreate_progress_bar (const CoreString &text, const bool &keep_in_history=true, const bool &is_abortable=false)
 Create a new progress bar and returns it.
 
void flush_progress_bars ()
 Removes all progress bars.
 
void clear_progress_bars_history ()
 Clears progress bars history.
 
const unsigned int & get_progress_bars_count () const
 Returns the number of progress bars.
 
const float & get_progress_bar_value (const unsigned int &id) const
 Returns value of progress bar by id.
 
const CoreStringget_progress_bar_text (const unsigned int &id) const
 Returns progress bar text by id.
 
bool is_progress_bar_abortable (const unsigned int &id) const
 
bool is_progress_bar_aborted (const unsigned int &id) const
 
bool abort_progress_bar (const unsigned int &id)
 Tells the progress bar to abort the monitored process.
 
const float & get_progress_bars_average () const
 Returns the average value of all progress bars.
 
const unsigned int & get_old_progress_bars_count () const
 Returns the amount of progress bars in history.
 
const CoreStringget_old_progress_bar_text (const unsigned int &id) const
 Returns text of progress bar in history by id.
 
const unsigned long & get_old_progress_bar_duration (const unsigned int &id) const
 Returns how long lasted history progress bar by id.
 
const AccelerationMode & get_acceleration_mode () const
 
void set_acceleration_mode (const AccelerationMode &mode)
 
const DisplacementStorageMode & get_displacement_storage_mode () const
 
void set_displacement_storage_mode (const DisplacementStorageMode &mode)
 
const int & get_default_virtual_key_interpolation_type () const
 
const int & get_default_key_interpolation_type () const
 
void set_default_virtual_key_interpolation_type (const int &type)
 
void set_default_key_interpolation_type (const int &type)
 
const bool & get_timeline_keyframes_display () const
 
void set_timeline_keyframes_display (const bool &mode)
 
const unsigned int & get_motion_blur_sample_count () const
 
const int & get_motion_blur_direction () const
 
const double & get_motion_blur_length () const
 
const bool & get_openVDB_delayed_load () const
 
const bool & get_openVDB_use_file_size_max () const
 
const unsigned int & get_openVDB_file_max_size () const
 
const unsigned int & get_application_geometry_subdivision_mode () const
 
const unsigned int & get_project_geometry_subdivision_mode () const
 
const double & get_texture_cache () const
 
const unsigned int & get_application_projection_master_eye ()
 
const unsigned int & get_project_projection_master_eye ()
 
void set_motion_blur_sample_count (const unsigned int &sample_count)
 
void set_motion_blur_direction (const int &direction)
 
void set_motion_blur_length (const double &length)
 
void set_openVDB_delayed_load (const bool &openVDB_delayed_load)
 
void set_openVDB_file_max_size (const unsigned int &file_max_size)
 
void set_openVDB_use_file_max_size (const unsigned int &use_file_max_size)
 
void set_application_geometry_subdivision_mode (const unsigned int &subdivision_mode)
 
void set_project_geometry_subdivision_mode (const unsigned int &subdivision_mode)
 
const unsigned int & get_application_geometry_visibility_mode () const
 
const unsigned int & get_project_geometry_visibility_mode () const
 
void set_application_geometry_visibility_mode (const unsigned int &visibility_mode)
 
void set_project_geometry_visibility_mode (const unsigned int &visibility_mode)
 
void set_application_projection_master_eye (const unsigned int &projection_master_eye)
 
void set_project_projection_master_eye (const unsigned int &projection_master_eye)
 
void set_OIIO_statistics_log_level (int value)
 
int get_OIIO_statistics_log_level () const
 
const int & get_curve_size_mode () const
 
void set_curve_size_mode (const int &mode)
 
const int & get_file_browser_mode () const
 
void set_file_browser_mode (const int &mode)
 
const int & get_objects_uicolor_mode () const
 
void set_objects_uicolor_mode (const int &mode)
 
const InputDeviceMode & get_input_device_mode ()
 
void set_input_device_mode (const InputDeviceMode &mode)
 
const double & get_gizmo_size () const
 
void set_gizmo_size (const double &size)
 
virtual CoreArray< CoreStringget_favorites_folders () const
 
virtual bool add_favorites_folders (const CoreString &path)
 
virtual bool remove_favorites_folders (const CoreString &path)
 
virtual bool remove_favorites_folders (const unsigned int &index)
 
virtual bool rename_favorites_folders (const CoreString &old_path, const CoreString &new_path)
 
virtual bool rename_favorites_folders (const unsigned int &index, const CoreString &new_path)
 
const bool & get_use_ocio_config_file () const
 
const CoreStringget_ocio_config_file () const
 
const CoreStringget_cdl_library_file () const
 
const CoreStringget_color_space_mapping_config_file () const
 
const bool & get_auto_detect_color_space () const
 
const CoreStringget_scene_color_space_name () const
 
void set_use_ocio_config_file (const bool &enable)
 
void set_ocio_config_file (const CoreString &path)
 
void set_cdl_library_file (const CoreString &path)
 
void set_color_space_mapping_config_file (const CoreString &path)
 
void set_auto_detect_color_space (const bool &enable)
 
void set_scene_color_space (const CoreString &name)
 
bool get_use_color_space_mapping_on_save () const
 
void set_use_color_space_mapping_on_save (const bool &enable)
 
const bool & get_use_aov_config_file () const
 
const CoreStringget_aov_config_file () const
 
void set_use_aov_config_file (const bool &enable)
 
void set_aov_config_file (const CoreString &path)
 
const bool & get_use_resolution_preset_config_file () const
 
const CoreStringget_resolution_preset_config_file () const
 
void set_use_resolution_preset_config_file (const bool &enable)
 
void set_resolution_preset_config_file (const CoreString &path)
 
const int & get_combine_pivot_location () const
 
void set_combine_pivot_location (const int &mode)
 
const bool & enable_output_file_buffering () const
 
void set_enable_output_file_buffering (const bool &enable)
 
const int & get_image_output_file_type () const
 
void set_image_output_file_type (const int &output_file_type)
 
const int & get_openexr_compression_method () const
 
void set_openexr_compression_method (const int &compression_method)
 
void set_openexr_compression_error (const double &compression_error)
 
const double & get_openexr_compression_error () const
 
const int & get_deep_output_channels () const
 
const bool & get_deep_output_raw_samples () const
 
const int & get_deep_output_file_type () const
 
const int & get_deep_output_data_precision () const
 
const int & get_deep_output_max_sample_count () const
 
void set_deep_output_channels (const int &channels)
 
void set_deep_output_raw_samples (const bool &raw_samples)
 
void set_deep_output_file_type (const int &deep_output_file_type)
 
void set_deep_output_data_precision (const int &deep_output_data_precision)
 
void set_deep_output_max_sample_count (const int &deep_output_max_sample_count)
 
const bool & output_aovs_in_all_format () const
 
void set_output_aovs_in_all_format (const bool &output_aovs)
 
const bool & split_aovs_in_separate_files () const
 
void set_split_aovs_in_separate_files (const bool &split_aovs)
 
const bool & disable_rgba_in_output () const
 
void set_disable_rgba_in_output (const bool &disable_rgba)
 
IxPythonVersion get_ix_python_version () const
 
ComponentFactoryget_component_factory ()
 
SysThreadTaskManagerget_task_manager () const
 
void register_directive (const CoreString &name, DirectiveCallback callback)
 
void log_error (const CoreString &message)
 
void log_info (const CoreString &message)
 
void log_warning (const CoreString &message)
 
bool is_disabled () const
 
void * get_app_base_impl () const
 
SysWatchget_application_idle_watch ()
 
unsigned long get_application_idle_time ()
 
CoreString get_version () const
 
CoreString get_version_name () const
 
unsigned int get_version_number () const
 
CoreString get_launching_directory () const
 
bool verify_state (VerifiableState state, bool resolve_if_unsafe)
 
void register_verification_callback_for_state (VerifiableState state, VerifyStateCallback callback)
 
bool can_export () const
 
- Public Member Functions inherited from EventObject
 EventObject ()
 Constructor.
 
 EventObject (const EventObject &src)
 Copy Constructor.
 
virtual ~EventObject () override
 Destructor.
 
void connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 
bool disconnect_all (EventObject &sender)
 Disconnects from all objects sender was listening on.
 
void disconnect_all ()
 Disconnects from all objects we were listening on.
 
void remove_all_connection ()
 Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.
 
void raise_event (const CoreString &event_id) const
 sends an event
 
void raise_event (const EventInfo &event_info) const
 sends an event
 
bool is_connected (EventObject &sender, const CoreString &event_id, void *data)
 
void set_mute (const bool &mute)
 Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.
 
bool is_mute () const
 Returns if object is muted.
 
CoreArray< EventObject * > get_senders () const
 
unsigned int get_sender_count () const
 
unsigned int get_receiver_count () const
 
void connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Disconnects this from an object for a specific event.
 
- Public Member Functions inherited from CoreCustomData
 CoreCustomData (const CoreCustomData &src)
 
void add_custom_data (void *key, const bool &data)
 
void add_custom_data (void *key, const int &data)
 
void add_custom_data (void *key, const unsigned int &data)
 
void add_custom_data (void *key, const char *data)
 
void add_custom_data (void *key, const CoreString &data)
 
void add_custom_data (void *key, const double &data)
 
void add_custom_data (void *key, void *data)
 
void remove_custom_data (void *key)
 
void remove_all_custom_data ()
 
void set_custom_data (void *key, const bool &data)
 
void set_custom_data (void *key, const int &data)
 
void set_custom_data (void *key, const unsigned int &data)
 
void set_custom_data (void *key, const double &data)
 
void set_custom_data (void *key, const char *data)
 
void set_custom_data (void *key, const CoreString &data)
 
void set_custom_data (void *key, void *data)
 
void get_custom_data (void *key, bool &data) const
 
void get_custom_data (void *key, int &data) const
 
void get_custom_data (void *key, unsigned int &data) const
 
void get_custom_data (void *key, double &data) const
 
void get_custom_data (void *key, CoreString &data) const
 
void get_custom_data (void *key, void *&data) const
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Static Public Attributes

static const CoreString s_has_custom_data_in_associate_window = "custom_data_in_associate_window"
 

Protected Member Functions

void on_start () override
 
void on_wait (unsigned int time_ms) override
 
void on_quit () override
 
virtual void on_paste (GuiWidget &pasted_widget, const CoreString &clipboard)
 
void progress_update () override
 
void _set_clipboard (const CoreString &clipboard)
 
bool load_colortag_config_file (const CoreString &filename)
 
virtual size_t get_widgets_memory_size () const
 
- Protected Member Functions inherited from AppObject
void run_start ()
 
void run_loop (const bool &blocking)
 
virtual void run_end ()
 
void cleanup_temp_folders ()
 
virtual void on_init_start_object_factory ()
 
virtual void on_add_new_module (const OfClass &module)
 
virtual void on_init_end_object_factory ()
 
void track_resources ()
 
bool is_ple_project () const
 
void set_is_ple_project (bool is_ple)
 
void launch_pending_evaluations ()
 
void create_defaults_objects (OfObject &prefs)
 
virtual bool start_command_port ()
 
CoreString import_project (const CoreString &filenames, bool import_as_root_project, void *requester=0)
 
CoreArray< CoreStringimport_project (const CoreVector< CoreString > &filenames, bool import_as_root_project, void *requester=0)
 
CoreString add_working_directory_to_path (const CoreString &p)
 
void on_mutable_vizroot_changed (OfObject &object, const EventInfo &event, void *data)
 
- Protected Member Functions inherited from OfApp
DirectiveCallback get_directive_callback (const CoreString &name) const
 
- Protected Member Functions inherited from AppBase
AppDialog message_box (const Type &type, const CoreString &message, const CoreString &title, const AppDialog &default_value, const int &style, int *geometry, const CoreVector< CoreString > &list) const
 Displays a message box.
 
void set_type (const Type &type)
 
DirectiveCallback get_directive_callback (const CoreString &name) const
 
void set_ix_python_version_from_args (int argc, char *argv[])
 
CoreString get_current_scripting_python_class_name () const
 
CoreString get_current_scripting_python_module_relative_path () const
 

Static Protected Member Functions

static CoreString get_default_colortag_config_file_path ()
 
static CoreString get_default_brush_preset_file_path ()
 
- Static Protected Member Functions inherited from AppObject
static void update_vizroot_content (void *data)
 

Protected Attributes

CoreMostRecentSortedSet
< CoreString
m_recent_script_files
 
bool m_is_saving_crash_file
 

Friends

class GuiAppPendingCallbackHandler
 
class GuiFloatingWindow
 
class GuiRouter
 
class GuiViewport
 
class GuiWidget
 
class GuiWindow
 
class GuiWindowRouter
 

Additional Inherited Members

- Static Public Member Functions inherited from AppObject
static CoreString get_legacy_config_file_for_migration (const CoreString &filename, bool create_folder)
 
static void initialize_previz_physical_lights (OfObject *previz_light_set)
 

Detailed Description

Defines graphical user interface application.

Gui level of application, defining UI related behavior and contents.

Member Function Documentation

void GuiApp::add_mouse_listener ( GuiAppMouseListenerCallback  cbk,
void *  data = 0 
)

Add a global mouse listener callback. Each timer a mouse event is spawned the specified callback is called with the proper event type and widget that will receive the event. You need to remove manually the callback using remove_mouse_listener. This method is thread safe.

Parameters
cbkCallback to be called
datablind data passed as argument of the specifed callback
void GuiApp::check_for_events ( const bool &  process_callbacks)

Refresh the display and iterate on the main loop. Call this if you want to keep the event flowing to widgets during big calculation or if you simulate a modal window.

Parameters
process_callbacksif false, only a ui redraw is done. if true the ui is redrawn and the callbacks (timers...) are processed too.
Gui::DeviceId GuiApp::get_input_device_type ( )

Get current device type, based on current active device and on the Preference "Input Device Mode".

Prefer using this method over Gui::get_device_type, which returns the raw device type.

Returns
If "Input Device Mode" is "Force Mouse", always returns Gui::DEVICE_MOUSE.
If "Input Device Mode" is "Force Tablet" and current device is Gui::DEVICE_MOUSE, always returns Gui::DEVICE_STYLUS.
Otherwise returns the real actual device type. See Gui::get_device_type.
void GuiApp::get_statistics ( SysStatistic stats) const
overridevirtual

gather application-wide statistic data (memory usage, objects count...)

  • stats the gathered statistic data

Reimplemented from AppObject.

GuiWindow * GuiApp::get_top_window ( ) const

Return the top most window.

Returns
NULL if no windows where found
AppDialog GuiApp::message_box ( const CoreString message,
const CoreString title = "Information",
const AppDialog default_value = AppDialog::ok(),
const int &  style = AppDialog::STYLE_OK,
int *  geometry = 0,
const CoreVector< CoreString > &  list = CoreVector<CoreString>() 
) const
overridevirtual

Popup the application message box.

Parameters
messagemessage to be displayed
titletitle of the message box
default_valuedefault message box value (see AppDialog::Value)
styledefault style of the message box (see AppDialog::Style)
geometryoptionally points to xywh (int[4]) to specify widget position & size
listoptional array to be displayed as a scrollable list
Returns
the value of the button that was pressed (see AppDialog::Value)

Reimplemented from AppBase.

CoreString GuiApp::open_file ( const CoreString directory,
const CoreString title,
const CoreString filter 
)
overridevirtual

Open a file browser and returns the path of the file choosed by the user.

Parameters
directoryThe directory from which to search the file
titleThe title of the window of the file browser
filterthe file extension filter

Reimplemented from AppBase.

void GuiApp::remove_mouse_listener ( GuiAppMouseListenerCallback  cbk,
void *  data = 0 
)

Remove the first global mouse listener callback that matches the specified callback and data. . This method is thread safe.

Parameters
cbkCallback that was registered with an add_mouse_listener
datablind data that was passed as argument
void GuiApp::restore_all_viewports_auto_evaluation ( void  )

This will restore the auto evaluation on all viewports registered to this application, as they were prior to the last call to disable_all_viewports_auto_evaluation.

void GuiApp::set_windows_tablet_api ( Gui::WindowsTabletApi  api)

Set the current Windows Tablet API. This method is called when the preference is updated. It does not update the preference value.