Clarisse 5.0 SP10 SDK 5.0.5.10.0
Loading...
Searching...
No Matches
AppBase Class Referenceabstract

Application base class, defines low levels behaviors and settings. More...

#include <app_base.h>

Inherits EventObject.

Inherited by OfApp.

Public Types

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 class  IxPythonVersion {
  Invalid = 0 ,
  V2 = 2 ,
  V3 = 3 ,
  Default = V3
}
 
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

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. More...
 
CoreVector< CoreStringget_import_project_extension_name () const
 Get the allowed file extensions for importing project files. More...
 
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) More...
 
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
 
virtual void add_evaluator (AppEvaluator &evaluator, const EvaluatorAddMode &mode=EVALUATOR_ADD_MODE_TAIL, const EvalFps &fps=EVAL_FPS_RENDERING)
 
virtual void add_evaluator (AppEvaluator &evaluator, const double &priority, const EvalFps &fps=EVAL_FPS_RENDERING)
 
virtual void remove_evaluator (AppEvaluator &evaluator)
 
virtual bool must_stop_evaluation () const
 
virtual bool is_evaluation_interrupted () const
 
virtual bool is_evaluating () const
 
virtual double get_evaluation_frame () const =0
 
virtual double get_evaluation_time () const =0
 
virtual double get_evaluation_quality () const =0
 
unsigned long get_runtime () const
 Get elapsed time since application started.
 
virtual void stop_evaluation (const bool &blocking=false)
 
virtual void clear_evaluation ()
 
virtual void awake (AppCallback callback, void *data)
 
virtual CoreString get_temp_folder () const
 
virtual bool request_temp_sub_folder (const CoreString &requested_name, CoreString &usable_path)=0
 
virtual const CoreVector< CoreString > & get_search_paths () const =0
 
virtual void set_search_paths (const CoreVector< CoreString > &paths)=0
 
CoreString resolve_path (const CoreString &file_path) const
 
CoreVector< CoreStringresolve_paths (const CoreBasicArray< CoreString > &file_paths, bool verbose=false) const
 
virtual void save_config ()
 
virtual const LicenseInfo & get_license () const
 Return the application license. More...
 
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. More...
 
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)
 
virtual void set_texture_cache (const double &size)
 
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 void add_to_event_loop (AppCallback cbk, void *data=0)
 
virtual void remove_from_event_loop (AppCallback cbk, void *data=0)
 
virtual void add_timer (const unsigned int &time_ms, AppCallback cbk, void *data=0, const bool &update=true)
 
virtual void repeat_timer (const unsigned int &time_ms, AppCallback cbk, void *data=0)
 
virtual void remove_timer (AppCallback cbk, void *data=0)
 
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)
 
virtual void set_default_view_transform (CoreBasicString view_transform)
 
virtual const CoreStringget_default_view_transform () const
 
virtual void set_color_picker_color_space (const CoreString &name)
 
virtual const CoreStringget_color_picker_color_space_name (const bool real_value=false) const
 
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)
 
virtual bool get_use_in_place_parenting () const =0
 
virtual void set_use_in_place_parenting (const bool &enable)=0
 
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)
 
const double & get_openexr_compression_error () const
 
void set_openexr_compression_error (const double &compression_error)
 
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
 
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
 Displays a message box. More...
 
virtual CoreString open_file (const CoreString &directory, const CoreString &title, const CoreString &filter)
 
void register_directive (const CoreString &name, DirectiveCallback callback)
 
virtual void add_directive (ParserEntry *entry, const OfItemHandle &item)
 
virtual void execute_directives ()=0
 
void log_error (const CoreString &message)
 
void log_info (const CoreString &message)
 
void log_warning (const CoreString &message)
 
virtual void check_for_events ()
 
virtual void wait_for_events ()
 
virtual void enable ()
 
virtual void disable ()
 
virtual bool is_enabled () const
 
bool is_disabled () const
 
void * get_app_base_impl () const
 
SysWatchget_application_idle_watch ()
 
unsigned long get_application_idle_time ()
 
virtual bool is_experimental_features_enabled () const
 
virtual bool is_beta_features_enabled () const
 
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)
 
virtual size_t get_memory_size () const override
 
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. More...
 
void connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events. More...
 
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. More...
 
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 More...
 
void raise_event (const EventInfo &event_info) const
 sends an event More...
 
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
 
virtual size_t get_memory_size () const override
 
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. More...
 
void connect (EventObject &sender, EventMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events. More...
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Disconnects this from an object for a specific event. More...
 
- 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
 
virtual size_t get_memory_size () const override
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
virtual size_t get_memory_size () 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 Member Functions

static const char * get_type_name (const Type &type)
 
static const char * get_evaluator_add_mode (EvaluatorAddMode &mode)
 
static const char * get_acceleration_mode (const AccelerationMode &mode)
 
static const char * get_acceleration_mode_human (const AccelerationMode &mode)
 
static const char * get_displacement_storage_mode (const DisplacementStorageMode &mode)
 
static const char * get_displacement_storage_mode_human (const DisplacementStorageMode &mode)
 
static const char * get_eval_fps (const EvalFps &fps)
 
static const char * get_curve_size_mode_name (const CurveSizeMode &mode)
 
static const char * get_file_browser_mode_name (const FileBrowserMode &mode)
 
static const char * get_object_uicolor_mode_name (const ObjectUicolorMode &mode)
 
static const char * get_input_device_mode_name (const InputDeviceMode &mode)
 
static const char * get_motion_blur_direction_mode_name (const MotionBlurDirectionMode &mode)
 
static int get_motion_blur_direction_mode_value (const MotionBlurDirectionMode &mode)
 
static MotionBlurDirectionMode get_motion_blur_direction_mode_from_value (const int &motion_blur_value)
 
static MotionBlurDirectionMode get_motion_blur_direction_mode_by_name (const CoreString &_mode)
 
static bool is_valid_ix_python_version (IxPythonVersion version)
 
static bool exists ()
 return true if an application exists. If true, this means an application has already been created.
 
- Static Public Member Functions inherited from EventObject
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event. More...
 
static void connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen any of its events. More...
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 
static void raise_event (EventObject &sender, const CoreString &event_id)
 Sends an event. More...
 
static void raise_event (EventObject &sender, const EventInfo &event_info)
 Sends an event. More...
 
static void connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event. More...
 
static void connect (EventObject &sender, EventFunction event_cb, void *data=0)
 Connects to an object to listen any of its events. More...
 
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Disconnects this from an object for a specific event. More...
 
- Static Public Member Functions inherited from CoreCustomData
static void * get_custom_data_key (const CoreString &key)
 
- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Protected Member Functions

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. More...
 
virtual void progress_update ()
 
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
 

Friends

class AppProgressBar
 

Detailed Description

Application base class, defines low levels behaviors and settings.

Examples
app_progress_bar_example.cc.

Member Enumeration Documentation

◆ Flavor

Application flavor. Depends on the currently used license.

Enumerator
FLAVOR_IFX 

iFX

FLAVOR_BUILDER 

BUiLDER.

◆ IxPythonVersion

enum class AppBase::IxPythonVersion
strong

Python version values. The valid enum values can be used as values for the command line argument -python_version.

Warning
Python 2.7.x is deprecated and its support will be removed in future Clarisse versions.
Enumerator
Invalid 

Invalid version.

V2 

Python 2.7.x.

V3 

Python 3.7.x.

Default 

Default Python version.

Member Function Documentation

◆ add_timer()

virtual void AppBase::add_timer ( const unsigned int &  time_ms,
AppCallback  cbk,
void *  data = 0,
const bool &  update = true 
)
inlinevirtual

Reimplemented in AppObject.

◆ add_to_event_loop()

virtual void AppBase::add_to_event_loop ( AppCallback  cbk,
void *  data = 0 
)
inlinevirtual

Reimplemented in AppObject.

◆ can_export()

bool AppBase::can_export ( ) const

Query if the application can export data.

◆ check_for_events()

virtual void AppBase::check_for_events ( )
inlinevirtual

Reimplemented in AppObject, and GuiApp.

◆ create_progress_bar()

AppProgressBar * AppBase::create_progress_bar ( const CoreString text,
const bool &  keep_in_history = true,
const bool &  is_abortable = false 
)

Create a new progress bar and returns it.

Parameters
[in]texttest to be displayed in progress bar
[in]keep_in_historydisplays progress bar in history or not
[in]is_abortablespecifies if the process that is monitored by the progress bar can be aborted
Examples
app_progress_bar_example.cc.

◆ disable()

virtual void AppBase::disable ( )
inlinevirtual

Reimplemented in GuiApp.

◆ enable()

virtual void AppBase::enable ( )
inlinevirtual

Reimplemented in GuiApp.

◆ get_current_scripting_python_class_name()

CoreString AppBase::get_current_scripting_python_class_name ( ) const
protected

Get the OfClass name of the Scripting class for the active Python version.

Returns
Python Scripting engine OfClass name.

◆ get_current_scripting_python_module_relative_path()

CoreString AppBase::get_current_scripting_python_module_relative_path ( ) const
protected

Get the file path of the Scripting module for the active Python version, relative to the built-in global variable $IX_PYTHON_API_PATH (OfVars).

Returns
The module file path, relative to $IX_PYTHON_API_PATH.
See also
AppObject::get_python_api_path.

◆ get_file_extension()

const char * AppBase::get_file_extension ( ) const

Get the default project file extension depending on the flavor of the current running license.

Returns
File extension string, or nullptr if flavor is invalid.

◆ get_flavor()

AppBase::Flavor AppBase::get_flavor ( ) const

Get the application's current flavor, which depends on the current license in use.

◆ get_import_project_extension_name()

CoreVector< CoreString > AppBase::get_import_project_extension_name ( ) const

Get the allowed file extensions for importing project files.

You can only import project files (.project), regardless of the current application flavor (iFX or BUiLDER), i.e. Build files can't be imported when in BUiLDER flavor. When in PLE, you can also import PLE project files (.ple).

Returns
Vector of allowed file extensions for importing project files.

◆ get_ix_python_version()

AppBase::IxPythonVersion AppBase::get_ix_python_version ( ) const

Get the active Python version used by the application.

◆ get_license()

const LicenseInfo & AppBase::get_license ( ) const
virtual

Return the application license.

Note
By default the application returns a dummy license

◆ get_memory_size()

size_t AppBase::get_memory_size ( ) const
overridevirtual

Reimplemented from EventObject.

◆ get_ple_file_extension()

const char * AppBase::get_ple_file_extension ( ) const

Get the default project PLE file extension depending on the flavor of the current running license.

Returns
PLE file extension string, or nullptr if flavor is invalid.

◆ get_project_extension_name()

CoreVector< CoreString > AppBase::get_project_extension_name ( ) const

Get the allowed file extensions for the current running license.

Returns
Vector of allowed file extensions.

◆ get_temp_folder()

CoreString AppBase::get_temp_folder ( ) const
virtual

Reimplemented in AppObject.

◆ is_app_thread()

bool AppBase::is_app_thread ( ) const

Return true if our execution context is the same as app thread (main loop)

Note
Depending on the platform, this call can be costly.

◆ is_file_extension_supported()

bool AppBase::is_file_extension_supported ( const CoreString filename) const

Query if the specified filename's extension is supported by the flavor of the current running license. If the file is supported,the application can potentially load it.

Returns
true if supported, false otherwise.

◆ is_valid_ix_python_version()

bool AppBase::is_valid_ix_python_version ( AppBase::IxPythonVersion  version)
static

Query if the specified AppBase::IxPythonVersion is valid.

◆ message_box() [1/2]

AppDialog AppBase::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
virtual

Displays a message box.

Parameters
[in]messageto display in message box
[in]titlewindow title
[in]default_valuedefault checked button
[in]stylewindow style
[in]geometryunused
[in]listunused
Returns
AppDialog which can be asked for user choice value.

Reimplemented in GuiApp.

◆ message_box() [2/2]

AppDialog AppBase::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
protected

Displays a message box.

Parameters
[in]messageto display in message box
[in]titlewindow title
[in]default_valuedefault checked button
[in]stylewindow style
[in]geometryunused
[in]listunused
Returns
AppDialog containing user choice value.

◆ open_file()

virtual CoreString AppBase::open_file ( const CoreString directory,
const CoreString title,
const CoreString filter 
)
inlinevirtual

Reimplemented in GuiApp.

◆ register_verification_callback_for_state()

void AppBase::register_verification_callback_for_state ( VerifiableState  state,
VerifyStateCallback  callback 
)

Registers callbacks for verifying the state of systems specified in the VerifiableState enum

Parameters
[in]stateto be verified as safe or unsafe
[in]callbackfor state verification logic

◆ remove_from_event_loop()

virtual void AppBase::remove_from_event_loop ( AppCallback  cbk,
void *  data = 0 
)
inlinevirtual

Reimplemented in AppObject.

◆ remove_timer()

virtual void AppBase::remove_timer ( AppCallback  cbk,
void *  data = 0 
)
inlinevirtual

Reimplemented in AppObject.

◆ repeat_timer()

virtual void AppBase::repeat_timer ( const unsigned int &  time_ms,
AppCallback  cbk,
void *  data = 0 
)
inlinevirtual

Reimplemented in AppObject.

◆ request_temp_sub_folder()

virtual bool AppBase::request_temp_sub_folder ( const CoreString requested_name,
CoreString usable_path 
)
pure virtual

Implemented in AppObject.

◆ resolve_path()

CoreString AppBase::resolve_path ( const CoreString file_path) const

Resolves a file path path using the application search paths.

Parameters
file_pathfile path to be resolved
Returns
resolved file path if found, empty string otherwise

◆ resolve_paths()

CoreVector< CoreString > AppBase::resolve_paths ( const CoreBasicArray< CoreString > &  file_paths,
bool  verbose = false 
) const

Resolves a list of file paths using the application search paths.

Parameters
file_pathslist of file paths to be resolved
verboseset to true to log the files that failed to be resolved; false to disable resolve logs
Returns
list of resolved file paths (files that failed to be resolved are removed), therefore the result can be empty

◆ set_ix_python_version_from_args()

void AppBase::set_ix_python_version_from_args ( int  argc,
char *  argv[] 
)
protected

Sets the Python version by reading the command line argument "-python_version".

If the argument is not specified, the Python version remains unchanged from its initial default value. If the argument value is invalid, the default version is used.

Warning
For internal usage only, used by AppObject which is where have access to argc and argv.

◆ verify_state()

bool AppBase::verify_state ( VerifiableState  state,
bool  resolve_if_unsafe 
)

Verifies state of systems specified in the VerifiableState enum

Parameters
[in]stateto be verified as safe or unsafe
[in]resolve_if_unsafespecifies whether we want this state to be rendered safe if initially unsafe
Returns
true if the state was safe or rendered safe, false otherwise

◆ wait_for_events()

virtual void AppBase::wait_for_events ( )
inlinevirtual

Reimplemented in AppObject.