Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
OfFileReferenceContextEngine Class Reference
Inheritance diagram for OfFileReferenceContextEngine:
OfOverridesContextEngine OfContextEngine CoreBaseObject CoreBaseType

Classes

struct  CmdFilenameUndoData
 
struct  FileLoaderCallbacks
 
struct  FileRefParseSerialData
 
struct  ObjectSerial
 

Public Types

enum  LoadingState {
  STATE_UNLOADED,
  STATE_LOADING,
  STATE_LOADED,
  STATE_UNLOADING
}
 Exposes the loading states of the referenced context. More...
 
typedef void(* LoadObjectsCallback )(const CoreBasicArray< CoreString > &, OfContext &, CoreVector< OfObject * > &, AppProgressBar *)
 
typedef void(* GetHierarchyCallback )(const CoreString &, const OfContextEngine &, OfSceneDescription &)
 
typedef void(* LoadSpecificCallback )(const CoreString &, OfContext *, const CoreVector< CoreString > &, CoreVector< OfObject * > &)
 

Public Member Functions

CoreString get_pdir (void) const override
 
void set_filename (const CoreString &filename)
 
CoreString get_filename () const
 
bool can_reference_file () const override
 
void set_filenames (const CoreBasicArray< CoreString > &filename)
 
CoreVector< CoreStringget_filenames () const
 
CoreVector< CoreStringget_expressions () const
 
bool supports_file_list () const
 
bool supports_localize () const override
 
void load (const bool &load_sub_references)
 
void unload ()
 UnLoads the content of this Reference context.
 
void reload ()
 
LoadingState get_loading_state () const
 
bool is_loaded () const
 Returns true if the content of the context is loaded.
 
bool is_loading () const
 Returns true if the context is loading its content for the first time.
 
bool is_reloading () const
 Returns true if the context is updating its content by reloading the reference.
 
CmdFilenameUndoDatado_set_filename (const CoreString &filename, CmdFilenameUndoData *undo_data)
 
CmdFilenameUndoDatado_set_filenames (const CoreBasicArray< unsigned int > &indices, const CoreBasicArray< CoreString > &filenames, CmdFilenameUndoData *undo_data)
 
CmdFilenameUndoDatado_remove_filename (const CoreBasicArray< unsigned int > &indices, CmdFilenameUndoData *undo_data)
 
CmdFilenameUndoDatado_add_filename (const CoreBasicArray< CoreString > &filenames, CmdFilenameUndoData *undo_data)
 
CmdFilenameUndoDatado_permute_reference_filename (const CoreBasicArray< unsigned int > &permutations, CmdFilenameUndoData *undo_data)
 
bool undo_cmd_filename (CmdFilenameUndoData *undo_data)
 
virtual void init (const CoreString &filename)
 
int get_override_kind (const OfObject &object, const CoreString &attr_name) const override
 
const
OfImportOptions::VariableMode & 
get_import_variable_mode () const
 
void set_import_variable_mode (const OfImportOptions::VariableMode &variable_mode)
 
const OfImportOptions::AovMode & get_import_aov_mode () const
 
void set_import_aov_mode (const OfImportOptions::AovMode &aov_mode)
 
- Public Member Functions inherited from OfOverridesContextEngine
void clear_overrides ()
 
void clear_items_overrides (const CoreBasicArray< CoreString > &items_paths)
 
void clear_sub_items_overrides (const CoreBasicArray< CoreString > &path_filters)
 
void clear_attributes_overrides (const CoreBasicArray< CoreString > &attr_paths)
 
void cleanup_overrides ()
 
void cleanup_overrides (const CoreString &attr_path)
 
void cleanup_overrides (const CoreBasicArray< CoreString > &attr_paths)
 
OfObjectcreate_override_set ()
 
const unsigned int get_override_set_count () const
 
OfReferenceOverrideSetget_override_set (const unsigned int &index) const
 
CoreString get_overrides_as_text () const
 Get all context overrides as text.
 
void set_overrides_from_text (const CoreString &text)
 
OfOverridesget_overrides () const
 
ClearOverridesUndoDatado_create_override_set (ClearOverridesUndoData *undo_data, CoreString &override_set_name)
 
ClearOverridesUndoDatado_clear_overrides (ClearOverridesUndoData *undo_data)
 
ClearOverridesUndoDatado_cleanup_overrides (ClearOverridesUndoData *undo_data)
 
bool undo_clear_overrides (ClearOverridesUndoData *undo_data)
 
ClearOverridesUndoDatado_clear_items_overrides (const CoreBasicArray< CoreString > &item_paths)
 
ClearOverridesUndoDatado_clear_sub_items_overrides (const CoreBasicArray< CoreString > &path_filters)
 
ClearOverridesUndoDatado_clear_attribute_overrides (const CoreBasicArray< CoreString > &attr_paths)
 
const bool is_top_level_reference () const
 
void set_content_dirty (const bool &dirty_sub_contexts=false) override
 
void reset_content_dirty ()
 
bool is_content_dirty () const override
 
virtual void update_content (const OfSerialOptions &overrides_options=OfSerialOptions::get_default())
 Performs the update content process if possible (according to can_update_content) and manages reapplying overrides.
 
void update_content_and_clean (const OfSerialOptions &overrides_options=OfSerialOptions::get_default(), bool bnew=false)
 
void get_overridden_objects (CoreVector< OfObject * > &objects) const
 Returns overridden objects.
 
int get_overridden_object_count () const
 Returns the number of overridden objects.
 
void get_overridden_attributes (const OfObject *object, CoreVector< OfAttr * > &attrs) const
 Returns overridden attributes for a given overridden object.
 
bool is_shadowable (const OfItem &item) override
 
void change_override_root_path (const CoreString &old_path, const OfContext &new_root_ctx)
 
- Public Member Functions inherited from OfContextEngine
bool is_unknown_engine () const
 
bool is_project_engine () const
 
bool is_override_engine () const
 
bool is_file_reference_engine () const
 
bool is_usd_reference_engine () const
 
bool is_scene_assembly_engine () const
 
bool is_scene_assembly_read_engine () const
 
bool is_build_package_engine () const
 
OfContextget_context () const
 
virtual const GuiIconget_icon () const
 
const CoreStringget_attr_doc (const CoreString &attr) const
 
CoreString get_serial_name () const
 
void pre_serialize (const OfSerialOptions &options)
 
void post_serialize ()
 
bool is_serializing () const
 
bool is_deserializing () const
 
virtual void get_scene (OfSceneDescription &scene) const
 generate a scene description of the engine context
 
OfItemget_item (OfSceneDescription::ItemId item_id) const
 create the OF item given the ID of the item in the engine
 
virtual void get_items (const CoreBasicArray< OfSceneDescription::ItemId > &item_ids, CoreArray< OfItem * > &items) const
 create the OF items given the IDs of the items in the engine
 
virtual void get_item_references (OfSceneDescription::ItemId item_id, CoreVector< OfSceneDescription::ItemId > &references) const
 returns the IDs of items referenced by an item
 
virtual OfObjectHandle get_object_handle (OfObject *object, OfClass *missing_class=0) const
 Returns a handle for the given object in the context.
 
virtual const CoreStringget_item_full_name (const OfItem &item)
 Returns the full name of a given item in the context.
 
OfBuildPackageContextEngineget_build_package ()
 
virtual void get_status_bar (ComponentInterfaceNodeStatus &status) const
 customize the status bar of the context in the build view for example, it is possible to display a warning bar if something is going wrong
 
virtual void update_context ()
 Update the content of the context if needed. This is called each time we need to access to the content of a context.
 
virtual bool is_content_valid () const
 
virtual void on_add_cam (const CAMInfo &cam_info)
 React to the addition of a new cam, by gathering related attributes and applying the cam t them.
 
virtual bool is_traversal () const
 
virtual OfItemHandle get_traversal_item () const
 
virtual OfAttrget_pass_through () const
 
virtual OfAttrHandle get_traversal_attr (bool when_traversal_only=true) const
 
virtual OfItemget_traversal_candidate () const
 
virtual CoreString get_cam_identifier () const
 
virtual bool has_cam_feature () const
 
virtual void * predelete_items (const CoreSet< OfContext * > &contexts, const CoreSet< OfObjectHandle > &objects, const CoreVector< OfObjectHandle > &embedded, OfEndProtectionCallback &cleanup)
 
virtual void undelete_items (void *blind_data)
 
virtual void get_overrides (ParserGroup &overrides) const
 Returns a serialization group containing all the overrides applied on items in the context.
 
virtual void set_overrides (const ParserGroup &overrides, bool append_overrides=false)
 Apply overrides on items in the context given a serialization group containing all the overrides.
 
virtual bool merge_overrides (CoreBasicArray< OfContextEngine * > contexts)
 Merge overrides of the given contexts into the current one.
 
OfAttradd_attribute (const OfItem::AttrCreationParams &params)
 
OfAttradd_attribute (const CoreString &name, const OfAttr::Type &type, const OfAttr::Container &container=OfAttr::CONTAINER_SINGLE, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT, const CoreString &group_name="general")
 
void remove_all_attributes ()
 
void remove_attribute (const CoreString &name)
 
void remove_attribute (OfAttr &attr)
 
OfAttradd_custom_attribute (const OfItem::AttrCreationParams &params)
 
OfAttradd_custom_attribute (const CoreString &name, const OfAttr::Type &type, const OfAttr::Container &container=OfAttr::CONTAINER_SINGLE, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT, const CoreString &group_name="general")
 
void remove_all_custom_attributes ()
 
- 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 void add_file_format (const CoreClassInfo &engine, const CoreString &extension, LoadObjectsCallback cb, bool supports_file_list=false, bool supports_localize=true)
 
static void add_file_format (const CoreClassInfo &engine, FileLoaderCallbacks &cbs, bool supports_file_list=false, bool supports_localize=true)
 
static void get_file_format_extensions (CoreArray< CoreString > &extensions)
 
static void get_file_format_extensions (const CoreClassInfo &engine, CoreArray< CoreString > &extensions)
 
static bool can_manage_file_format (const CoreClassInfo &engine, const CoreString &extension)
 
static bool file_format_supports_file_list (const CoreClassInfo &engine, const CoreString &extension)
 
static bool file_format_supports_localize (const CoreClassInfo &engine, const CoreString &extension)
 
static void load_all (OfApp &application)
 Loads the content of all Reference contexts in the current project.
 
static const Descriptorget_descriptor ()
 
- Static Public Member Functions inherited from OfOverridesContextEngine
static const
OfContextEngine::Descriptor
get_descriptor ()
 
- Static Public Member Functions inherited from OfContextEngine
static const Descriptorget_descriptor ()
 
static void set_icon (const CoreClassInfo &engine_class_info, const GuiIcon *icon)
 
static void set_icon (const CoreString &engine_serial_name, const GuiIcon *icon)
 
static void set_custom_icon (const CoreClassInfo &engine_class_info, int key, const GuiIcon *icon)
 
static void set_attr_doc (const CoreClassInfo &engine_class_info, const CoreString &attr_name, const CoreString &doc)
 
- 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 Types

enum  CmdFilenameMode {
  CMD_FILENAME_MODE_ADD,
  CMD_FILENAME_MODE_REMOVE,
  CMD_FILENAME_MODE_SET,
  CMD_FILENAME_MODE_PERMUTE
}
 
enum  FileDeserializingState { DESERIALIZING_FILE = OVERRIDES_NEXT_DESERIALIZING_VALUE }
 
- Protected Types inherited from OfOverridesContextEngine
enum  DeserializingState {
  UPDATE_WHILE_DESERIALIZING_OBJECT = NEXT_DESERIALIZING_VALUE,
  UPDATE_WHILE_DESERIALIZING_ATTR = NEXT_DESERIALIZING_VALUE<<1,
  OVERRIDES_NEXT_DESERIALIZING_VALUE = NEXT_DESERIALIZING_VALUE<<2
}
 
enum  PrivateState {
  STATE_DEFAULT = NEXT_PRIVATE_FLAG,
  STATE_CREATING_OVERRIDE = NEXT_PRIVATE_FLAG<<1,
  STATE_UPDATING_CONTENT = NEXT_PRIVATE_FLAG<<2,
  CONTENT_DIRTY = NEXT_PRIVATE_FLAG<<3
}
 
- Protected Types inherited from OfContextEngine
enum  Result {
  RESULT_DESERIALIZE_NONE,
  RESULT_DESERIALIZE_SOME,
  RESULT_DESERIALIZE_ALL
}
 
enum  DeserializingState {
  NOT_DESERIALIZING = 0,
  DESERIALIZING_OBJECT = 1 << 0,
  DESERIALIZING_ATTR = 1 << 1,
  NEXT_DESERIALIZING_VALUE = 1 << 2
}
 Context's deserialization state. More...
 
enum  PrivateFlags {
  NO_FLAGS = 0,
  FLAG_POPULATING_OPTIONS = 1,
  FLAG_RECREATING_ENGINE = 1 << 1,
  NEXT_PRIVATE_FLAG = 1 << 2
}
 

Protected Member Functions

 OfFileReferenceContextEngine (OfContext &ctx)
 
CmdFilenameUndoDatado_cmd_filenames (const CmdFilenameMode &cmd_mode, const CoreBasicArray< unsigned int > &indices, const CoreBasicArray< CoreString > &filenames, CmdFilenameUndoData *undo_data)
 
void update_filter_and_container ()
 
OfReferenceFileFormatLoader * get_loader (const CoreBasicArray< CoreString > &filenames)
 
CmdFilenameUndoDatacreate_undo_data (CmdFilenameUndoData *undo_data, OfAttr *filename_attr)
 
void init (ParserGroup *settings) override
 
ParserGroupget_settings () const override
 
bool populate_settings (ParserGroup &group, OfContext *context) const override
 
void populate_options () override
 
void refresh_attributes () override
 
void set_data (const CoreString &filename, const CoreString &expression, bool activated_expr, unsigned int index, bool value_disabled)
 
void clear_data ()
 
void remove_data (const unsigned int &index)
 
void set_data_count (const unsigned int &count)
 
void on_options_changed (OfObject &options) override
 
bool can_update_content () const override
 Returns true if the update process can be done right now.
 
void on_update_content (const OfSerialOptions &overrides_options) override
 Override this method to specify your custom content.
 
virtual bool has_content_to_update () override
 
Result deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
void deserialize_attrs (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
- Protected Member Functions inherited from OfOverridesContextEngine
virtual void _update_content (const bool &apply_overrides, const OfSerialOptions &overrides_options)
 
 OfOverridesContextEngine (OfContext &ctx)
 
void init (ParserGroup *settings=0) override
 
bool populate_settings (ParserGroup &group, OfContext *context) const override
 
void populate_options () override
 
void load_overrides (ParserGroup *settings)
 
void apply_overrides ()
 
void force_apply_overrides (CoreBasicArray< OfObject * > objects)
 Force (re)apply existing overrides on the specified objects.
 
void on_options_changed (OfObject &options) override
 
void on_context_event (const CoreString &event) override
 
int on_item_event (const EventObject::EventInfo &event, OfItem *item) override
 
ParserEntryserialize (ParserEntry *entry, const OfSerialOptions &options, AppProgressBar *progress_bar) const override
 
Result deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
void deserialize_attrs (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
Result do_deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
void do_deserialize_attrs (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
 
virtual void on_deserialize_filter_out_overrides (CoreVector< CoreString > &filtered_overrides_paths)
 
bool is_parent_updating_content () const
 
OfOverridesContextEngineget_top_override_engine () const
 
bool is_listening_events () const
 Return the listening state which specifies if we will create new overrides when object attributes change.
 
bool set_listening_events (bool state)
 
bool is_update_content_allowed () const
 
bool set_allowed_update_content (bool state)
 
void suspend_objects (const CoreVector< OfItem * > &items) override
 
- Protected Member Functions inherited from OfContextEngine
 OfContextEngine (OfContext &ctx)
 
void register_component_implementation ()
 
void _populate_options ()
 
OfAttradd_option_attribute (const OfItem::AttrCreationParams &params)
 
OfAttradd_option_attribute (const CoreString &name, const OfAttr::Type &type, const OfAttr::Container &container=OfAttr::CONTAINER_SINGLE, const OfAttr::VisualHint &visual_hint=OfAttr::VISUAL_HINT_DEFAULT, const CoreString &group_name="general")
 
void remove_all_option_attributes ()
 
void _on_options_changed (OfObject &options)
 
void add_state_deserializing (const int state)
 
void remove_state_deserializing (const int state)
 
bool is_state_deserializing (const int state) const
 
void add_private_flag (const int flag)
 
void remove_private_flag (const int flag)
 
bool is_private_flag (const int flag) const
 
virtual void get_items_to_serialize (CoreArray< OfObject * > &objects, CoreArray< OfContext * > &contexts) const
 
virtual ParserEntryserialize_export (ParserEntry *entry, const OfSerialOptions &options, AppProgressBar *progress_bar) const
 
void suspend_all_objects ()
 
void clean_all_suspended_objects (bool only_new=false)
 
const OfClassget_project_item_class () const
 

Static Protected Member Functions

static
OfFileReferenceContextEngine::LoadObjectsCallback 
find_loader (const CoreString &filename)
 
static int reload_cb (const OfAction &action, OfObject &object, void *data)
 
static int load_current_cb (const OfAction &action, OfObject &object, void *data)
 
static int load_recursively_cb (const OfAction &action, OfObject &object, void *data)
 
static int unload_cb (const OfAction &action, OfObject &object, void *data)
 
static LoadObjectsCallback get_file_format_loader (const CoreClassInfo &engine, const CoreString &extension)
 
static GetHierarchyCallback get_file_format_hierarchy (const CoreClassInfo &engine, const CoreString &extension)
 
static void load_project_objects (const CoreBasicArray< CoreString > &filenames, OfContext &context, CoreVector< OfObject * > &loaded_objects, AppProgressBar *progress_bar)
 
static void prepare_serial_data (FileRefParseSerialData &serial_data, CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
static ParseSerialDataparse_serial (CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
static OfContextEnginecreate_engine (OfContext &ctx)
 
- Static Protected Member Functions inherited from OfOverridesContextEngine
static void prepare_serial_data (OverrideParseSerialData &serial_data, CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
static Result deserialize_data_objects (OverrideParseSerialData &serial_data, OfOverridesContextEngine &target_context, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
static int clear_overrides_cb (const OfAction &action, OfObject &object, void *data)
 
static int cleanup_overrides_cb (const OfAction &action, OfObject &object, void *data)
 
static int extract_override_set_cb (const OfAction &action, OfObject &object, void *data)
 
static int prints_override_cb (const OfAction &action, OfObject &object, void *data)
 
- Static Protected Member Functions inherited from OfContextEngine
static OfContextEnginecreate_engine (OfContext &ctx)
 
static ParseSerialDataparse_serial (CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
static void prepare_serial_data (ParseSerialData &serial_data, CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
static Result deserialize_data_objects (ParseSerialData &serial_data, OfContextEngine &target_context, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
static void deserialize_data_attrs (ParseSerialData &serial_data, OfContextEngine &target_context, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
static void deserialize_data_options (ParseSerialData &serial_data, OfContextEngine &target_context, const OfSerialOptions &options)
 
static ParserEntryserialize_options (const OfContext &context, const OfSerialOptions &serial_options)
 
static void deserialize_options (OfContext &context, const ParserEntry *serial, const OfSerialOptions &serial_options)
 

Friends

class IOHelpers
 

Additional Inherited Members

- Protected Attributes inherited from OfOverridesContextEngine
OfOverridesm_overrides
 
OfReferenceOverrideSetm_override_set
 
int m_context_flags
 
bool m_initialized
 

Detailed Description

Context engine for referencing files and their content.


Class Documentation

struct OfFileReferenceContextEngine::ObjectSerial
Class Members
CoreString copy_from
const ParserEntry * entry
CoreString fullname
CoreString name
OfObject * object
bool override
ObjectSerial * parent
CoreString source

Member Enumeration Documentation

Exposes the loading states of the referenced context.

Enumerator:
STATE_UNLOADED 

The context is explicitly to be kept unloaded.

STATE_LOADING 

The context is expected to be automatically loaded.

STATE_LOADED 

The context has been loaded.

STATE_UNLOADING 

The context is currently unloading.

Member Function Documentation

void OfFileReferenceContextEngine::add_file_format ( const CoreClassInfo engine,
FileLoaderCallbacks cbs,
bool  supports_file_list = false,
bool  supports_localize = true 
)
static

Add a file format loader to the OfFileReferenceContextEngine.

Parameters
engineThe context engine that will manage the file format.
extensionThe file format extension.
loaderThe loader callback.
supports_file_listtrue if the file format supports a file list as input (e.g. Alembic layer files).
supports_localizetrue if the file format supports localizing the context and its objects.
bool OfFileReferenceContextEngine::can_reference_file ( ) const
inlineoverridevirtual

Returns true if the context engine is able to reference a file For example, reference file engine, scene assembly read engine and build package in remote mode must return true

Reimplemented from OfContextEngine.

bool OfFileReferenceContextEngine::file_format_supports_file_list ( const CoreClassInfo engine,
const CoreString extension 
)
static

Returns true if the context engine supports the file format and if the file format supports file list.

Parameters
engineThe context engine class info.
extensionThe file format extension to be tested.
Returns
true if the extension is supported by the engine and if it supports file list, false otherwise.
bool OfFileReferenceContextEngine::file_format_supports_localize ( const CoreClassInfo engine,
const CoreString extension 
)
static

Returns true if the context engine supports the file format and if the file format supports localizing.

Parameters
engineThe context engine class info.
extensionThe file format extension to be tested.
Returns
true if the extension is supported by the engine and if it supports localizing, false otherwise.
OfFileReferenceContextEngine::LoadObjectsCallback OfFileReferenceContextEngine::find_loader ( const CoreString filename)
staticprotected

Returns the first loader that was registered through OfFileReferenceContextEngine::add_file_format that can load the given filename

OfReferenceFileFormatLoader * OfFileReferenceContextEngine::get_loader ( const CoreBasicArray< CoreString > &  filenames)
protected

Get the loader associated to a list of filenames based on the filename extensions.

Parameters
filenamesList of filenames to load.
Returns
The associated loader if found. nullptr if at least one file format is unsupported, or if the list contains mixed formats that are incompatible (e.g. .project + .abc).
int OfFileReferenceContextEngine::get_override_kind ( const OfObject object,
const CoreString attr_name 
) const
overridevirtual

Query the kind of the context override according to the specified attribute.

Parameters
objectThe object being overridden.
attr_nameThe name of the attribute overridden in the object.
Returns
An OR-combination of OfOverrides::OverrideKinds values that describe the kind of override and update that will be done on the context contents. E.g. overriding the "filename" of an OfFileReferenceContextEngine will result in a OfOverrides::CONTENT_OVERRIDE.

Reimplemented from OfOverridesContextEngine.

CoreString OfFileReferenceContextEngine::get_pdir ( void  ) const
overridevirtual

Return the resolved PDIR for this file reference.

Reimplemented from OfContextEngine.

void OfFileReferenceContextEngine::load ( const bool &  load_sub_references)

Loads the content of this Reference context.

Parameters
[in]load_sub_referencesSpecify whether sub-reference contexts are loaded or not.
void OfFileReferenceContextEngine::on_options_changed ( OfObject options)
overrideprotectedvirtual

Called when the options object of this engine's context has changed. Deriving engines need to override this method to handle changes on their options.

Parameters
optionsThe options OfObject.

Reimplemented from OfContextEngine.

bool OfFileReferenceContextEngine::supports_file_list ( ) const

Returns true if this context supports file lists, depending on its current files' extensions.

bool OfFileReferenceContextEngine::supports_localize ( ) const
overridevirtual

Returns true if this context can be localized, depending on its current files' extensions.

Reimplemented from OfContextEngine.