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 | Protected Attributes | Friends | List of all members
OfContextEngine Class Reference
Inheritance diagram for OfContextEngine:
CoreBaseObject CoreBaseType OfBuildPackageContextEngine OfOverridesContextEngine OfProjectContextEngine OfSceneAssemblyContextEngine OfUnknownContextEngine OfFileReferenceContextEngine OfSceneAssemblyReadContextEngine

Classes

struct  CAMInfo
 
struct  Descriptor
 
struct  ObjectSerial
 
struct  ParseSerialData
 

Public Types

typedef OfContextEngine *(* CreateEngineCallback )(OfContext &context)
 
typedef ParseSerialData *(* ParseSerialCallback )(CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)
 
typedef const Descriptor &(* GetDescriptorCallback )()
 Typedef for the callback to get the engine's Descriptor.
 

Public Member Functions

virtual void set_content_dirty (const bool &dirty_sub_contexts=false)
 
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
 
virtual bool can_reference_file () const
 
virtual bool supports_localize () 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 ParserGroupget_settings () const
 
virtual void init (ParserGroup *settings=nullptr)
 
virtual CoreString get_pdir (void) 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 bool is_shadowable (const OfItem &item)
 
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_dirty () const
 
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 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  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

 OfContextEngine (OfContext &ctx)
 
virtual bool populate_settings (ParserGroup &group, OfContext *context) const
 
void register_component_implementation ()
 
void _populate_options ()
 
virtual 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)
 
virtual void on_options_changed (OfObject &options)
 
virtual void on_context_event (const CoreString &event)
 
virtual int on_item_event (const EventObject::EventInfo &event, OfItem *item)
 
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 (ParserEntry *entry, const OfSerialOptions &options, AppProgressBar *progress_bar) const
 
virtual ParserEntryserialize_export (ParserEntry *entry, const OfSerialOptions &options, AppProgressBar *progress_bar) const
 
virtual Result deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
virtual void deserialize_attrs (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
virtual Result do_deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
virtual void do_deserialize_attrs (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar)
 
virtual void suspend_objects (const CoreVector< OfItem * > &items)
 
void suspend_all_objects ()
 
void clean_all_suspended_objects (bool only_new=false)
 
const OfClassget_project_item_class () const
 

Static Protected Member Functions

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)
 

Protected Attributes

OfContextm_ctx
 The OfContext hosting the engine.
 
const OfClassm_project_item_class
 For optimization.
 
char m_flag_deserializing
 Context's deserializing state. See DeserializingState.
 
unsigned int m_private_flags
 See PrivateFlag.
 
CoreVector< OfAttr * > m_option_attrs
 Keeps track of attributes used as options, for special serialization.
 
CoreVector< OfAttr * > m_custom_attrs
 Keeps track of custom attributes, for special serialization.
 
bool m_is_serializing
 

Friends

class OfContext
 
class OfOverrides
 
class OfFileReferenceContextEngine
 

Detailed Description

Base context engine class.


Class Documentation

struct OfContextEngine::Descriptor

Structure describing a context engine. Each derived context engine should define its own descriptor.

Class Members
CoreHashTable< CoreString,
CoreString >
attr_docs
const CoreClassInfo * class_info Engine's CoreClassInfo.
CreateEngineCallback create_engine Callback to create an instance of the engine.
CoreHashTable< int, const
GuiIcon * >
custom_icons
const GuiIcon * icon Optional icon for the context. Can be null.
CoreString identifier_name
ParseSerialCallback parse_serial Callback to parse serialized data specific to the engine.
CoreString serial_name Serialization name.
struct OfContextEngine::ObjectSerial
Class Members
CoreString copy_from
const ParserEntry * entry
CoreString fullname
CoreString name
OfObject * object
bool override
ObjectSerial * parent
CoreString source

Member Typedef Documentation

typedef OfContextEngine*(* OfContextEngine::CreateEngineCallback)(OfContext &context)

Typedef for the callback that creates the engine instance.

Parameters
contextThe OfContext hosting the engine and the objects created by the engine.
typedef ParseSerialData*(* OfContextEngine::ParseSerialCallback)(CoreVector< ParserEntry * > &sub_ctx_entries, const CoreBasicArray< ParserEntry * > &serial_entries)

Typedef for the callback that parses the serialization data.

Parameters
sub_ctx_entriesOutput list of parsed sub-contexts entries.
serial_entriesInput list of serialized entries to parse.

Member Enumeration Documentation

Context's deserialization state.

Enumerator:
NOT_DESERIALIZING 

Not currently under deserialization.

DESERIALIZING_OBJECT 

Object deserialization has started.

DESERIALIZING_ATTR 

Attribute deserialization has started.

Enumerator:
FLAG_POPULATING_OPTIONS 

Conditional state on population options.

FLAG_RECREATING_ENGINE 

Conditional state on recreating context engine.

Member Function Documentation

void OfContextEngine::_on_options_changed ( OfObject options)
protected

Main entry point used by the engine's context to notify that the options object has changed. Calls on_options_changed, except when options are being created by populate_options.

Parameters
optionsThe options OfObject.
OfAttr * OfContextEngine::add_attribute ( const OfItem::AttrCreationParams params)

Add an attribute. If an attribute with the given name already exists, returns that one instead. If called during populate_options, the attribute will be an option attribute, otherwise it will be created as a custom attribute.

Parameters
paramsAttribute creation parameters.
Returns
The created or existing attribute on success, nullptr on failure.
OfAttr * OfContextEngine::add_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" 
)

Add an attribute. If an attribute with the given name already exists, returns that one instead. If called during populate_options, the attribute will be an option attribute, otherwise it will be created as a custom attribute.

Parameters
nameAttribute name.
typeAttribute type.
containerAttribute container type.
visual_hintAttribute visual hint.
group_nameAttribute group name.
Returns
The created or existing attribute on success, nullptr on failure.
OfAttr * OfContextEngine::add_custom_attribute ( const OfItem::AttrCreationParams params)

Add a custom attribute. If an attribute with the given name already exists, returns that one instead.

Parameters
paramsAttribute creation parameters.
Returns
The created or existing attribute on success, nullptr on failure.
OfAttr * OfContextEngine::add_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" 
)

Add a custom attribute. If an attribute with the given name already exists, returns that one instead.

Parameters
nameAttribute name.
typeAttribute type.
containerAttribute container type.
visual_hintAttribute visual hint.
group_nameAttribute group name.
Returns
The created or existing attribute on success, nullptr on failure.
OfAttr * OfContextEngine::add_option_attribute ( const OfItem::AttrCreationParams params)
protected

Add an option attribute. If an attribute with the given name already exists, returns that one instead.

Parameters
paramsAttribute creation parameters.
Returns
The created or existing attribute on success, nullptr on failure.
OfAttr * OfContextEngine::add_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" 
)
protected

Add an option attribute. If an attribute with the given name already exists, returns that one instead.

Parameters
nameAttribute name.
typeAttribute type.
containerAttribute container type.
visual_hintAttribute visual hint.
group_nameAttribute group name.
Returns
The created or existing attribute on success, nullptr on failure.
bool OfContextEngine::can_reference_file ( ) const
virtual

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 in OfBuildPackageContextEngine, OfFileReferenceContextEngine, and OfSceneAssemblyReadContextEngine.

void OfContextEngine::clean_all_suspended_objects ( bool  only_new = false)
protected

Remove all objects that are still in suspended (deprecated) stated.

Parameters
only_newIf true, only suspended items that are new (OfItem:STATE_NEW) are removed. If false, all suspended items are removed.
void OfContextEngine::deserialize_options ( OfContext context,
const ParserEntry serial,
const OfSerialOptions serial_options 
)
staticprotected

Deserialize the context's options object.

Parameters
contextThe context.
serialThe serialized options.
serial_optionsSerialization options.
OfBuildPackageContextEngine * OfContextEngine::get_build_package ( )

Get the first build package containing this engine context. Return null if there is no build package parent.

const OfContextEngine::Descriptor & OfContextEngine::get_descriptor ( )
static
OfItem * OfContextEngine::get_item ( OfSceneDescription::ItemId  item_id) const

create the OF item given the ID of the item in the engine

Parameters
item_idID of the item in the engine
Returns
the OF item
const CoreString & OfContextEngine::get_item_full_name ( const OfItem item)
virtual

Returns the full name of a given item in the context.

Parameters
itemthe item
Returns
the project path of the item in the engine context

Reimplemented in OfSceneAssemblyContextEngine.

void OfContextEngine::get_item_references ( OfSceneDescription::ItemId  item_id,
CoreVector< OfSceneDescription::ItemId > &  references 
) const
virtual

returns the IDs of items referenced by an item

Parameters
item_idthe ID of the item in the engine
referencesthe IDs of the first level references of the item
Note
This method must be overridden in all scene assembly read context engines. It must also be overridden in a scene assembly context engine only if the node allows to modify references. In this special case, the method must only return the IDs of the new references and not all the references of the item.
Warning
It must return the references of the embedded objects under item_id as well, so if for example item_id is a sphere with one material and one embedded displacement deformer referencing a texture, ::get_item_references() must return the item IDs of the material and the texture

Reimplemented in OfSceneAssemblyContextEngine.

void OfContextEngine::get_items ( const CoreBasicArray< OfSceneDescription::ItemId > &  item_ids,
CoreArray< OfItem * > &  items 
) const
virtual

create the OF items given the IDs of the items in the engine

Parameters
item_idsIDs of the items in the engine
Returns
items the OF items
OfObjectHandle OfContextEngine::get_object_handle ( OfObject object,
OfClass missing_class = 0 
) const
virtual

Returns a handle for the given object in the context.

Parameters
objectthe object
missing_classthe empty class to consider if the object is missing in the context
See Also
OfObjectHandle

Reimplemented in OfSceneAssemblyContextEngine.

virtual void OfContextEngine::get_overrides ( ParserGroup overrides) const
inlinevirtual

Returns a serialization group containing all the overrides applied on items in the context.

Parameters
overridesthe output serialization group
CoreString OfContextEngine::get_pdir ( void  ) const
virtual

Override this to provide a custom PDIR var for this context. Default implementation returns the empty string. The returned string should be a resolved one (e.g. it must NOT contain any custom variables such as $PDIR, etc.)

Also, you need to activate the OfItem::FLAG_OVERRIDE_PDIR flag in the associated context. If you do not, get_pdir will not be used.

See Also
OfContext::get_var_value and OfContext::set_flags

Reimplemented in OfFileReferenceContextEngine.

void OfContextEngine::get_scene ( OfSceneDescription scene) const
virtual

generate a scene description of the engine context

Parameters
scenethe resulting scene description
Note
the method must be overridden in order to apply modifications to the scene, for example, you can remove, add, or override any items in the scene according to the setting of your own scene assembly node
virtual void OfContextEngine::get_status_bar ( ComponentInterfaceNodeStatus status) const
inlinevirtual

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

Parameters
statusthe status to modify

Reimplemented in OfBuildPackageContextEngine, OfSceneAssemblyContextEngine, and OfSceneAssemblyReadContextEngine.

bool OfContextEngine::is_file_reference_engine ( ) const

Returns true if this engine's class is OfFileReferenceContextEngine or a derived class.

bool OfContextEngine::is_override_engine ( ) const

Returns true if this engine's class is OfOverridesContextEngine or a derived class.

bool OfContextEngine::is_project_engine ( ) const

Returns true if this engine's class is OfProjectContextEngine or a derived class.

bool OfContextEngine::is_shadowable ( const OfItem item)
virtual

Returns true if the item must be shadowed instead of removed when calling the command DeleteItems this allows to not remove all the resources of the item, and to re-add it very quickly if the delete is undo

Reimplemented in OfOverridesContextEngine, and OfSceneAssemblyContextEngine.

bool OfContextEngine::is_unknown_engine ( ) const

Returns true if this engine's class is OfUnknownContextEngine.

bool OfContextEngine::is_usd_reference_engine ( ) const

Returns true if this engine's class is UsdReferenceContextEngine or a derived class.

Warning
This API is subject to change or removal, as Of shouldn't be aware of engines implemented in modules. This method is added for convenience and backward compatibility.
bool OfContextEngine::merge_overrides ( CoreBasicArray< OfContextEngine * >  contexts)
virtual

Merge overrides of the given contexts into the current one.

Parameters
contextsthe list of context engines from which we merge the overrides
Returns
true if the contexts overrides have been correctly merge in the current context
void OfContextEngine::on_context_event ( const CoreString event)
protectedvirtual

Called when the engine's context sends an event.

Parameters
eventThe event ID.

Reimplemented in OfOverridesContextEngine.

int OfContextEngine::on_item_event ( const EventObject::EventInfo event,
OfItem item 
)
protectedvirtual

Called when an item of the engine's context sends an event.

Parameters
eventThe EventInfo.
itemThe OfItem that sent an event.
Returns
0 if the event is not consumed, meaning the event will be propagated up in the context hierarchy. Different than 0 if the event is consumed, meaning it won't be propagated.

Reimplemented in OfOverridesContextEngine, and OfSceneAssemblyContextEngine.

void OfContextEngine::on_options_changed ( OfObject options)
protectedvirtual

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 in OfFileReferenceContextEngine, OfOverridesContextEngine, OfSceneAssemblyContextEngine, and OfSceneAssemblyReadContextEngine.

void OfContextEngine::post_serialize ( )

Called after OfContext::serialize() when the root file is saved, or before clearing this context

void OfContextEngine::pre_serialize ( const OfSerialOptions options)

Called before OfContext::serialize() when the root file is saved, or before clearing this context

void OfContextEngine::remove_all_attributes ( )

Remove all option and custom attributes.

void OfContextEngine::remove_all_custom_attributes ( )

Remove all custom attributes. Option attributes are kept.

void OfContextEngine::remove_all_option_attributes ( )
protected

Remove all option attributes. Custom attributes are kept.

Warning
Use with care. Options should be removed only when the context mutates its engine, for example when localizing a reference context, which replaces the OfFileReferenceContextEngine by an OfProjectContextEngine.
void OfContextEngine::remove_attribute ( const CoreString name)

Remove the attribute specified by the name.

Parameters
nameName of the attribute to remove.
void OfContextEngine::remove_attribute ( OfAttr attr)

Remove the specified attribute.

Parameters
attrAttribute to remove.
ParserEntry * OfContextEngine::serialize_options ( const OfContext context,
const OfSerialOptions serial_options 
)
staticprotected

Serialize the context's options object.

Parameters
contextThe context.
serial_optionsSerialization options.
Returns
The serialized options as a ParserEntry.
virtual void OfContextEngine::set_overrides ( const ParserGroup overrides,
bool  append_overrides = false 
)
inlinevirtual

Apply overrides on items in the context given a serialization group containing all the overrides.

Parameters
theinput serialization group
append_overridesif false, it remove all the current overrides of the context and apply the new overrides, otherwise, it appends the new overrides to the existing ones
virtual bool OfContextEngine::supports_localize ( ) const
inlinevirtual

Returns true if this engine supports localizing the context and its contents ("Make Local"). Sub-classes can override this method to allow localizing it.

Reimplemented in OfFileReferenceContextEngine.

void OfContextEngine::suspend_all_objects ( )
protected

Suspend all items from this engine's context. The items will be considered as deprecated and potentially deleted in a further process if they are still that state.

See Also
OfOverridesContextEngine::suspend_items
void OfContextEngine::suspend_objects ( const CoreVector< OfItem * > &  items)
protectedvirtual

Suspend the specified items: they will be considered as deprecated and potentially deleted in a further process if they are still in that state.

Parameters
itemsList of items to suspend, they must belong this engine's context.

Reimplemented in OfOverridesContextEngine.