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 Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OfApp Class Referenceabstract
Inheritance diagram for OfApp:
AppBase EventObject CoreCustomData CoreBaseObject CoreBaseType AppObject GuiApp ClarisseApp

Public Types

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

virtual const OfObjectFactoryget_factory () const =0
 
virtual OfObjectFactoryget_factory ()=0
 
const OfConfigget_config () const
 
OfConfigget_config ()
 
virtual bool populate_prefs ()
 
void register_directive (const CoreString &name, DirectiveCallback callback)
 
virtual void init_directives ()
 
void add_directive (ParserEntry *entry, const OfItemHandle &item) override
 
virtual bool run_single_script (const CoreString &script, CoreString &result)=0
 
virtual bool run_single_script (const CoreString &script)=0
 
virtual bool run_single_script (const SysFile &file, CoreString &result)=0
 
virtual bool run_single_script (const SysFile &file)=0
 
virtual OfClassget_language_from_extension (const CoreString &extension)=0
 
virtual OfClassget_scripting_engine_from_extension (const CoreString &extension)=0
 
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)
 
virtual const
OfImportOptions::VariableMode & 
get_import_variables_mode () const
 
virtual void quit ()=0
 
virtual const CoreStringget_current_project_filename () const
 
virtual void clear_context_overrides (OfContext &context)=0
 
virtual void cleanup_context_overrides (OfContext &context)=0
 
virtual void create_override_set (OfContext &context)=0
 
virtual double get_current_project_version () const =0
 
virtual double get_current_object_framework_version () const =0
 
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)
 
virtual bool check_filter_matches (const CoreString &prefix, const CoreString &str_value, const CoreString &filter)=0
 Returns true if the incoming object name matches a text filter.
 
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)
 
virtual bool check_filter_matches (const OfContext &base_context, OfConstItemHandle object, const CoreString &filter)=0
 Returns if an object matches given name. (whether to use its hierarchical or kinematic full name depends on filter).
 
virtual bool check_filter_matches (const OfContext &base_context, const CoreString &item_name, const CoreString &filter)=0
 Returns if a name filter matches given object name.
 
virtual 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)=0
 Retrieve all objects whose full names match a text filter.
 
virtual void get_matching_objects (CoreVector< OfObjectHandle > &result, const CoreString &rule, 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)=0
 Retrieve all objects whose full names match a text filter.
 
virtual void get_matching_objects (CoreVector< OfObjectHandle > &result, const CoreString &rule, const CoreString &filter_class="SceneItem", const CoreBitFieldHelper &flags=OfItem::empty_flags_mask, const bool embedded_objects=false)=0
 Retrieve all objects whose full names match a text filter.
 
virtual bool get_matching_contexts (CoreSet< OfContext * > &result, const CoreString &rule, const OfContext &base_context)=0
 Get contexts that match a text filter.
 
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)
 
virtual bool retrieve_context (const CoreString &top_context, CoreString &retrieved_context, const CoreString &picker_title="")
 
virtual bool retrieve_object (const CoreString &top_context, const CoreString &class_name, CoreString &retrieved_object, const CoreString &picker_title="")
 
virtual CoreString get_scripting_command (const CoreString &command_id, const CoreBasicArray< OfCommandArgument > &arguments)
 
virtual void remove_items_from_selection (const CoreBasicArray< OfContext * > &contexts, const CoreBasicArray< OfObjectHandle > &objects)
 
const OfContextget_vizroot () const
 
OfContextget_vizroot ()
 
virtual void set_vizroot (OfContext *new_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
 
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.
 
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)
 
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)
 
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
 
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.
 
virtual CoreString open_file (const CoreString &directory, const CoreString &title, const CoreString &filter)
 
void register_directive (const CoreString &name, DirectiveCallback callback)
 
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)
 
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 Member Functions

static void process_expressions (void)
 
static OfCommandget_batch_command (void *data, const CoreArray< OfCommandArgument > &args)
 
- Static Public Member Functions inherited from AppBase
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.
 
static void connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
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.
 
static void raise_event (EventObject &sender, const EventInfo &event_info)
 Sends an event.
 
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.
 
static void connect (EventObject &sender, EventFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
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.
 
- 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

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.
 
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
 

Protected Attributes

OfConfigm_config
 
CoreHashTable< CoreString,
ParserEntry * > 
m_project_resources
 key/serialization for all resources generated in the application
 
bool m_is_auto_saving
 True if the application in in auto-save process.
 
OfContextm_vizroot
 
OfObjectm_mutable_vizroot
 

Friends

struct OfSerialOptions
 

Member Typedef Documentation

OfApp::DirectiveCallback

Callback to handle directive.

Parameters
[in]entryParserEntry to retreive directive arguments.
[in]itemDirective call context. This can be a OfContext or an OfObject.
Returns
true if succeed, false otherwise.

Member Enumeration Documentation

Used by some import and export methods to tell if the scene must be loaded from or saved as a project or a build file

Enumerator:
MODE_PROJECT 

No scene mode is specified.

MODE_BUILD 

The scene must be loaded from or saved as a project file.

The scene must be loaded from or saved as a build file

Member Function Documentation

bool OfApp::add_progress_update_callback ( void *  data,
ProgressUpdateCallback  on_progress_update 
)

This function registers a new progress update item.

Parameters
dataPointer used to identify the callback. The pointer is passed to the callback as first paramater. We usually use the pointer to the requester. The same pointer need to be given to use the remove the callback function.
See Also
remove_progress_update_callback.
Parameters
on_progress_updatefunction callback that will be called.
void OfApp::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.

For OF internal use: ensure a unique EVT_ID_OF_DESERIALIZE_BEGIN is sent before reading a project file (read, load, reference, import...) before any OfItem is created.

Parameters
ctxthe context that will own the file content. It can be retrieved in custom data of the EventInfo.
senderdebug string
See Also
end_of_deserialize
virtual bool OfApp::check_filter_matches ( const CoreString prefix,
const CoreString str_value,
const CoreString filter 
)
pure virtual

Returns true if the incoming object name matches a text filter.

Parameters
[in]prefixstring prefix to start looking from, if filter is relative (starts with ./ )
[in]str_valuestring to apply filter on
[in]filterstring filter which can contains wildcards '*'. Can start with './' to be relative to prefix
Returns
true if str_value matches the filter, false otherwise

Implemented in AppObject.

virtual bool OfApp::check_filter_matches ( const OfContext base_context,
OfConstItemHandle  object,
const CoreString filter 
)
pure virtual

Returns if an object matches given name. (whether to use its hierarchical or kinematic full name depends on filter).

Parameters
[in]base_contextcontext to start looking from, if filter is relative (starts with ./ )
[in]objectobject to apply filter on.
[in]filtertext filter used to determine which objects to retrieve. Same behavior as Shading Layer rules filters. Use * as wildcar. Start with ./ for a filter starting from 'base_context'.
Returns
true if object matches the filter, false otherwise

Implemented in AppObject.

virtual bool OfApp::check_filter_matches ( const OfContext base_context,
const CoreString item_name,
const CoreString filter 
)
pure virtual

Returns if a name filter matches given object name.

Parameters
[in]base_contextcontext to start looking from, if filter is relative (starts with ./ )
[in]item_nameitem name to apply filter on.
[in]filtertext filter used to determine which objects to retrieve. Same behavior as Shading Layer rules filters. Use * as wildcar. Start with ./ for a filter starting from 'base_context'.
Returns
true if object matches the filter, false otherwise

Implemented in AppObject.

void OfApp::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.

For OF internal use: ensure a unique EVT_ID_OF_DESERIALIZE_END is sent after reading a project file (read, load, reference, import...) after all OfItems are created and their attributes are set (including overrides).

Parameters
ctxthe context that will own the file content. It can be retrieved in custom data of the EventInfo.
senderdebug string
See Also
begin_of_deserialize
virtual bool OfApp::get_matching_contexts ( CoreSet< OfContext * > &  result,
const CoreString rule,
const OfContext base_context 
)
pure virtual

Get contexts that match a text filter.

Parameters
[in]rulestring filter which can contains wildcards '*'.
[in]base_contextbase context, used only if the filter is relative.
Returns
true if the filter is valid, false otherwise

Implemented in AppObject.

virtual void OfApp::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 
)
pure virtual

Retrieve all objects whose full names match a text filter.

Parameters
[out]matching_objectsfound objects
[in]ruletext filter used to determine which objects to retrieve. Same behavior as Shading Layer rules filters. Use * as wildcar. Use 'world://' to perform a kinematic hierarchy search.
[in]base_contextcontext to start looking from, if filter is relative (starts with './')
[in]filter_classclass filter to restrict which objects to look for.
[in]embedded_objectsspecifies to consider or not embedded objects
[in]search_rootspecifies the context to retrict research to. No objects outside this context will be considered.

Implemented in AppObject.

virtual void OfApp::get_matching_objects ( CoreVector< OfObjectHandle > &  result,
const CoreString rule,
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 
)
pure virtual

Retrieve all objects whose full names match a text filter.

Parameters
[out]matching_objectsfound objects
[in]ruletext filter used to determine which objects to retrieve. Same behavior as Shading Layer rules filters. Use * as wildcar. Use 'world://' to perform a kinematic hierarchy search.
[in]base_contextcontext to start looking from, if filter is relative (starts with './')
[in]filter_classclass filters to restrict which objects to look for.
[in]embedded_objectsspecifies to consider or not embedded objects

Implemented in AppObject.

virtual void OfApp::get_matching_objects ( CoreVector< OfObjectHandle > &  result,
const CoreString rule,
const CoreString filter_class = "SceneItem",
const CoreBitFieldHelper flags = OfItem::empty_flags_mask,
const bool  embedded_objects = false 
)
pure virtual

Retrieve all objects whose full names match a text filter.

Parameters
[out]matching_objectsfound objects
[in]ruletext filter used to determine which objects to retrieve. Same behavior as Shading Layer rules filters. Use * as wildcar. Use 'world://' to perform a kinematic hierarchy search.
[in]filter_classclass filters to restrict which objects to look for.
[in]embedded_objectsspecifies to consider or not embedded objects

Implemented in AppObject.

bool OfApp::is_child_of_vizroot ( OfConstItemHandle  item,
CoreSet< OfContext * > *  valid_ctx_cache = 0 
)
virtual

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.

Note
Can be overridden by any application that does not care about vizroot (AppTest for example).