Clarisse 5.0 SP8 SDK
5.0.5.8.0
|
Classes | |
struct | AttributeOverrideInfos |
struct | AttributeOverrides |
struct | BaseOverrideInfos |
struct | ObjectOverrideInfos |
struct | ObjectOverrides |
struct | OverrideSetInfos |
struct | OverrideSource |
Public Types | |
enum | SourceFilter { FILTER_NONE = 0, FILTER_CONTEXT = 1<<0, FILTER_SUB_CONTEXT = 1<<1, FILTER_SET = 1<<2 } |
enum | OverrideState { STATE_UNKNOWN = 0, STATE_APPLIED, STATE_STORED } |
enum | OverrideKinds { UNKNOWN_OVERRIDE = 0, CONTENT_OVERRIDE = 1 << 0, ITEM_OVERRIDE = 1 << 1, ALL_KIND_OVERRIDE = 3 } |
![]() | |
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 | |
OfOverrides (OfOverridesContextEngine &engine) | |
void | print_serial (const CoreString header="") const |
void | print (const CoreString header="", bool verbose=false) const |
void | do_print (const OverrideState &state, bool verbose=false) const |
void | do_print_attributes (const OfContext *top_context, const ObjectOverrides &obj_overrides, const OverrideState &state, const OfObject *overridden_obj, bool verbose=false) const |
ParserEntry * | get_settings (OfContext *context) const |
void | init (const ParserEntry *serial) |
void | load_from_settings (const ParserEntry *serial) |
ParserEntry * | serialize (const OfSerialOptions &options) const |
ParserEntry * | serialize (const OfSerialOptions &options, const CoreBasicArray< CoreString > &paths, const bool &sub_overrides) const |
void | deserialize (const ParserEntry &serial, const OfSerialOptions &options) |
void | clear_paste_item_mapping () |
void | add_paste_item_mapping (const CoreString &key, const CoreString &mapped_name, const bool &object) |
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 new_state) |
bool | is_update_content_allowed () const |
bool | set_allowed_update_content (bool new_state) |
CoreSharedPointer < OverrideSetInfos > | get_override_tree () const |
const bool | is_top_level_reference () const |
void | set_top_level_reference (const bool &top_reference) |
void | get_overriden_objects (CoreVector< OfObject * > &objects, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) |
void | get_overriden_attributes (CoreVector< OfAttr * > &attrs, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) |
void | get_overriden_attributes (OfConstObjectHandle object, CoreVector< OfAttr * > &attrs, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) |
bool | is_overridden_object (OfConstObjectHandle object, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) |
bool | is_overridden_attribute (OfConstAttrHandle attr, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) |
unsigned int | get_override_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT, const OverrideState &state_filter=STATE_UNKNOWN) const |
unsigned int | get_overriden_object_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT, const OverrideState &state_filter=STATE_UNKNOWN) const |
unsigned int | get_overriden_attribute_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT, const OverrideState &state_filter=STATE_UNKNOWN) const |
unsigned int | get_applied_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_applied_object_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_applied_attribute_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_stored_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_stored_object_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_stored_attribute_count (const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_object_override_reason (const CoreString &object_path, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_attribute_override_reason (const CoreString &object_path, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
bool | is_object_override_reason (const unsigned int &reason, const CoreString &object_path, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
bool | is_attribute_override_reason (const unsigned int &reason, const CoreString &object_path, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_object_override_reason_from_key (const CoreString &object_key, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
unsigned int | get_attribute_override_reason_from_key (const CoreString &object_key, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
bool | is_object_override_reason_from_key (const unsigned int &reason, const CoreString &object_key, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
bool | is_attribute_override_reason_from_key (const unsigned int &reason, const CoreString &object_key, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &source_filter=FILTER_CONTEXT) const |
bool | has_attr_creation_override (const CoreString &object_path, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &set_index=-1, const unsigned int &source_filter=FILTER_CONTEXT, const bool &destroyed=false) const |
bool | has_cam_creation_override (const CoreString &object_path, const CoreString &attr_name, const CoreString &source_context=CoreString::get_null_string(), const unsigned int &set_index=-1, const unsigned int &source_filter=FILTER_CONTEXT, const bool &destroyed=false) const |
void | on_object_event (const EventObject::EventInfo &event, const OfObject &object) |
Called if OfOverrides is listening. Will deal with incoming event and then will register override accordingly. | |
void | add_attribute_override (const CoreString &object_key, const CoreString &attr_name, AttributeOverrideInfos &override, OfAttr *attr=0) |
void | remove_overrides (const unsigned int &override_kind, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | remove_overrides (const unsigned int &override_kind, const CoreBasicArray< CoreString > &object_paths, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter, const bool &sub_overrides) |
void | remove_overrides (const unsigned int &override_kind, const CoreString &object_path, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter, const bool &sub_overrides) |
void | remove_attribute_overrides (const unsigned int &override_kind, const CoreString &object_path, const CoreBasicArray< CoreString > &attr_names, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | remove_attribute_overrides (const unsigned int &override_kind, const CoreString &object_path, const CoreString &attr_name, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | remove_attribute_overrides (const unsigned int &override_kind, const CoreBasicArray< CoreString > &attr_paths, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | revert_overrides (const unsigned int &override_kind, const bool &also_override_set) |
void | revert_overrides (const CoreBasicArray< CoreString > &object_paths, const unsigned int &override_kind, const bool &also_override_set, const bool &sub_overrides) |
void | revert_attributes_overrides (const CoreBasicArray< CoreString > &attribute_paths, const unsigned int &override_kind, const bool &also_override_set) |
void | revert_attribute_creation_overrides (const CoreString &object_path, const CoreString &attr_name, const bool &also_override_set) |
void | revert_cam_creation_overrides (const CoreString &object_path, const CoreString &attr_name, const bool &also_override_set) |
void | clear () |
void | clear_and_apply (const ParserEntry *to_deserialize_overrides, const OfSerialOptions &deserialize_options) |
void | store_overrides () |
void | set_override_sets (const CoreBasicArray< CoreString > &texts) |
void | extract_set (OfObject &override_set) |
void | make_local () |
void | clear_top_context_cache () |
void | change_override_root_path (const CoreString &original_path, const OfContext &new_root_ctx) |
![]() | |
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 |
virtual size_t | get_memory_size () const override |
void | connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0) |
Connects this to an object to listen to a specific event. | |
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. | |
![]() | |
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 |
![]() | |
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 CoreClassInfo & | get_class_info () const |
template<class T > | |
T * | cast () |
template<class T > | |
const T * | cast () const |
![]() | |
bool | is_kindof (const CoreClassInfo &cinfo) const |
Protected Member Functions | |
void | on_reference_attribute_event (OfObject &object, const EventObject::EventInfo &event_info, void *data) |
void | on_pending_promoted (OfObjectFactory &factory, const EventInfo &evt, void *data) |
void | on_provider_path_change (OfObjectFactory &factory, const EventInfo &evt, void *data) |
void | connect_attribute_override_to_all_referenced_object (OfAttr *attr, AttributeOverrides *attribute_overrides) |
void | register_referenced_object (OfObject *object, AttributeOverrides *attribute_overrides) |
void | reset_top_override_engine () |
OfOverridesContextEngine * | get_top_override_engine () const |
OfContext * | get_top_override_context () const |
OfOverridesContextEngine * | get_parent_override_engine () const |
OfContext * | get_parent_override_context () const |
unsigned int | _get_overriden_object_count (const OfContext *top_context, const OverrideSource &source, const unsigned int &source_filter, const OverrideState &state_filter) const |
unsigned int | _get_overriden_attribute_count (const OfContext *top_context, const OverrideSource &source, const unsigned int &source_filter, const OverrideState &state_filter) const |
void | _serialize_override (const ObjectOverrides &object_overrides, const CoreString &object_path, ParserGroup *override_group, const OfSerialOptions &options) const |
void | _deserialize (const unsigned int &override_set_index, const ParserEntry &serial, const OfSerialOptions &options) |
void | _deserialize_attribute (OfAttr *attr, ParserEntry *entry, const unsigned int &override_reason, OfSerialOptions &local_options) const |
unsigned int | _extract_attribute_override_reason (const ParserEntry *entry) const |
CoreSharedPointer < ObjectOverrides > | _create_object_overrides (const CoreString object_path, const unsigned int &override_set_index) |
ObjectOverrideInfos & | _create_object_override_infos (ObjectOverrides &object_overrides, ObjectOverrideInfos &override) |
ObjectOverrideInfos & | _add_object_override (CoreSharedPointer< ObjectOverrides > &object_overrides, const CoreString &object_path, ObjectOverrideInfos &override, OfObject *object) |
void | _detach_overrides (const CoreBasicArray< CoreString > &object_paths) |
AttributeOverrideInfos & | _create_attribute_override_infos (CoreSharedPointer< ObjectOverrides > &object_overrides, const CoreString &object_key, const CoreString attr_name, AttributeOverrideInfos &override, AttributeOverrides *&attr_overrides, OfAttr *attr) |
AttributeOverrideInfos & | _add_attribute_override (CoreSharedPointer< ObjectOverrides > &object_overrides, const CoreString &object_key, const CoreString &attr_name, AttributeOverrideInfos &override, OfAttr *attr) |
void | _remove_overrides (const OfContext *top_context, const unsigned int &override_kind, const CoreBasicArray< CoreString > &object_keys, const bool &consider_all, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter, const bool &sub_overrides) |
void | _remove_attribute_overrides (const OfContext *top_context, const unsigned int &override_kind, const CoreString &object_key, const CoreBasicArray< CoreString > &attr_names, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | _remove_attribute_overrides (const OfContext *top_context, const unsigned int &override_kind, const CoreString &object_key, const CoreString &attr_name, const CoreString &source_context, const unsigned int &source_filter, const OverrideState &state_filter) |
void | _listen_attribute (const OfAttr *attr, const CoreString &object_path, const OfContext *top_context, const OfObject &object) |
void | _apply_overrides (const OfSerialOptions &options, const unsigned int &override_kind) |
void | _force_apply_overrides (CoreBasicArray< OfObject * > objects) |
Force (re)apply existing overrides on the specified objects. | |
void | _prepare_options (const OfSerialOptions &incoming_options, OfSerialOptions &overrides_options) const |
void | _prepare_options_per_context (const OfContext &context, OfSerialOptions &overrides_options) const |
void | _prepare_options_for_attributes (const OfContext &context, OfSerialOptions &overrides_options) const |
void | _prepare_options_for_object (OfSerialOptions &overrides_options) const |
void | _apply_project_overrides (OfSerialOptions &overrides_options) |
void | _apply_object_overrides (OfSerialOptions &overrides_options) |
bool | _apply_overrides_on_object (OfObject *object, const bool &is_context_options, ObjectOverrides &overrides, OfSerialOptions &overrides_options) |
bool | _apply_overrides_on_attributes (OfObject *object, ObjectOverrides &overrides, const CoreString &obj_path, const unsigned int &override_kind, const OverrideSource &source, const unsigned int &source_filter, OfSerialOptions &attribute_options, const bool &object_already_aslept) |
void | _add_override_set (const CoreString &text) |
void | _make_local_override_sets (CoreString &made_local_path) |
void | _recurse_set_override_tree () |
bool | _has_attr_creation_override (const OfContext *top_context, const CoreString &object_key, const CoreString &attr_name, const CoreString &source_context, const unsigned int &set_index, const unsigned int &source_filter, const bool &destroyed) const |
bool | _has_cam_creation_override (const OfContext *top_context, const CoreString &object_key, const CoreString &attr_name, const CoreString &source_context, const unsigned int &set_index, const unsigned int &source_filter, const bool &destroyed) const |
void | _revert_attribute_creation_overrides (const CoreString &object_key, const CoreString &attr_name, const bool &also_override_set) |
void | _remove_attribute_creation_overrides (const CoreString &object_key, const CoreString &attr_name, const bool &also_override_set) |
void | _revert_cam_creation_overrides (const CoreString &object_key, const CoreString &attr_name, const bool &also_override_set) |
void | _remove_cam_creation_overrides (const CoreString &object_key, const CoreString &attr_name, const bool &also_override_set) |
Static Protected Member Functions | |
static void | set_overriden_flag (OfObject *object, const bool &flag) |
static void | set_overriden_flag (const CoreBasicArray< OfObject * > &objects, const bool &flag) |
static void | set_overriden_flag (OfAttr *attr, const bool &flag, const bool &align_object_flag) |
static void | set_overriden_flag (const CoreBasicArray< OfAttr * > &attrs, const bool &flag, const bool &align_object_flag) |
static OfOverridesContextEngine * | get_top_override_engine (const OfContext &context) |
static OfContext * | get_top_override_context (const OfContext &context) |
static OfOverridesContextEngine * | get_parent_override_engine (const OfContext &context) |
static OfContext * | get_parent_override_context (const OfContext &context) |
static void | get_sub_override_contexts (const OfContext &context, CoreVector< OfContext * > &sub_contexts) |
static void | get_all_sub_override_contexts (const OfContext &context, CoreVector< OfContext * > &sub_contexts) |
static void | get_context_path (const OfContext &top_context, const OfContext &context, CoreString &context_path) |
static void | sort_paths (const CoreBasicArray< CoreString > &paths, CoreVector< unsigned int > &sorted_indices) |
static bool | get_overridden_object (const OfContext &top_context, const CoreString &obj_key, OfObject *&overridden_obj) |
static bool | get_overridden_object (const OfContext &top_context, const CoreString &obj_key, OfContext *&overridden_ctx, OfObject *&overridden_obj, bool &is_context_options) |
static ParserEntry * | _serialize_lock_override (const bool &locked) |
static ParserEntry * | _serialize_disable_override (const bool &disabled) |
static ParserEntry * | _serialize_comment_override (const CoreString &comment) |
static ParserEntry * | _serialize_colortag_override (const CoreString &colortag) |
static ParserEntry * | _serialize_attribute (const OfAttr *attr, const unsigned int &override_reason, const OfSerialOptions &local_options) |
static bool | _from_path_to_keys (const OfContext &top_context, const CoreBasicArray< CoreString > &paths, CoreVector< CoreString > &keys) |
static bool | _from_path_to_key (const OfContext &top_context, const CoreString &path, CoreString &key) |
static bool | _is_override_to_consider (const CoreString &object_key, const CoreBasicArray< CoreString > &filter_keys, const bool &sub_override) |
static CoreString | make_relative_path (const CoreString &item_full_name, const OfContext &serial_root) |
Protected Attributes | |
CoreSharedPointer < OverrideSetInfos > | m_overrides_tree |
CoreVector< OverrideSetInfos * > | m_override_sets |
CoreHashTable< CoreString, CoreString > | m_paste_item_mapping_objects |
CoreHashTable< CoreString, CoreString > | m_paste_item_mapping_contexts |
bool | m_listening |
bool | m_allow_update_content |
OfOverridesContextEngine & | m_engine |
bool | m_is_top_level_reference |
bool | m_applying_overrides |
CoreHashTable< OfObject *, CoreVector < AttributeOverrides * > > | m_ref_object_to_attribute_override |
OfOverridesContextEngine * | m_top_override_engine |
Friends | |
class | OfFileReferenceContextEngine |
class | OfOverridesContextEngine |
struct | ApplyOverridesProcess |
struct | RemoveOverridesProcess |
struct | RevertOverridesProcess |
class | OfContextTests |
Additional Inherited Members | |
![]() | |
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. | |
struct OfOverrides::OverrideSetInfos |
Class Members | ||
---|---|---|
CoreHashTable< CoreString, CoreSharedPointer < ObjectOverrides > > |
m_objects |
|
protected |
Force (re)apply existing overrides on the specified objects.
All kinds of override are re-applied (CONTENT_OVERRIDE and ITEM_OVERRIDE).
Useful in cases of partial reload when you need to force apply already existing overrides on the specified objects.
objects | List of objects for which overrides will be re-applied. Objects that don't match, or don't have overrides, are not modified by this method. |
void OfOverrides::change_override_root_path | ( | const CoreString & | original_path, |
const OfContext & | new_root_ctx | ||
) |
Change all the root paths of all the reference attributes.