OfSceneAssemblyContextEngine Class Reference

Base class for engine of scene assembly context. A scene assembly context is either a read context or an operator context. A read context allows to load a scene and creates its content on demand (see: OfSceneAssemblyReadContextEngine). An operator context takes as input one or multiples contexts and is able to add/remove/override any items coming from the input. More...

Inheritance diagram for OfSceneAssemblyContextEngine:

Classes
struct	VariationTables

Public Member Functions
	OfSceneAssemblyContextEngine (OfContext &ctx)
	constructor
virtual	~OfSceneAssemblyContextEngine ()
	destructor
void	init (ParserGroup *settings) override
	init the engine
OfObjectHandle	get_object_handle (OfObject *object, OfClass *missing_class=0) const override
	Returns a handle for the given object in the context.
const CoreString &	get_item_full_name (const OfItem &item) override
	Returns the full name of a given item in the context.
void	get_item_references (OfSceneDescription::ItemId item_id, CoreVector< OfSceneDescription::ItemId > &references) const override
	returns the IDs of items referenced by an item
bool	is_content_dirty () const override
	returns true if the content has to be updated
bool	is_content_valid () const override
	returns true if the content has been correctly generated
void	update_context () override
	Update the content of the context if needed. This is called each time we need to access to the content of a context.
void	get_items_to_serialize (CoreArray< OfObject * > &objects, CoreArray< OfContext * > &contexts) const override
int	on_item_event (const EventObject::EventInfo &event, OfItem *item) override
	called when an event occurs on an object located in the context engine
bool	is_traversal () const override
OfItemHandle	get_traversal_item () const override
OfAttrHandle	get_traversal_attr (bool when_traversal_only=true) const override
OfAttr *	get_pass_through () const override
OfItem *	get_traversal_candidate () const override
bool	has_cam_feature () const override
bool	is_shadowable (const OfItem &item) override
virtual void	set_content_dirty ()
	clear the content of the context and flag it as dirty so it is updated the next time we have to know its content
virtual void	make_real (const CoreBasicArray< OfItemHandle > &items)
	create a real OF item for all the given items
bool	is_scene_description_dirty () const
CoreString	get_item_local_path (OfConstItemHandle item) const
	get the object path relatively to the context engine
virtual void	on_object_removed (OfObject *removed_object)
	called when any object is removed
virtual void	on_context_renamed (OfContext *renamed_context)
	called when any context is renamed
virtual void	on_object_renamed (OfObject *renamed_object, const CoreString &old_name)
	called when any object is renamed
void	remove_full_name (OfObject *object)
OfProxyId	get_proxy_id (OfItemHandle item) const
	Get the ID of the given item in this scene assembly context.
OfProxyId	get_proxy_id (OfPlugHandle plug) const
	Get the ID of the given plug in this scene assembly context.
OfItemHandle	get_item_handle (OfProxyId id) const
	Get a valid item handle for the given ID.
OfPlugHandle	get_plug_handle (OfProxyId id) const
	Get a valid plug handle for the given ID.
bool	has_generate (const OfItem &item) const
	Return true if this scene assembly context has generard the given item.
Public Member Functions inherited from OfContextEngine
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
OfContext &	get_context () const
virtual const GuiIcon *	get_icon () const
const CoreString &	get_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 ParserGroup *	get_settings () const
virtual CoreString	get_pdir (void) const
virtual void	get_scene (OfSceneDescription &scene) const
	generate a scene description of the engine context
OfItem *	get_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
OfBuildPackageContextEngine *	get_build_package ()
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 CoreString	get_cam_identifier () 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.
OfAttr *	add_attribute (const OfItem::AttrCreationParams &params)
OfAttr *	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")
void	remove_all_attributes ()
void	remove_attribute (const CoreString &name)
void	remove_attribute (OfAttr &attr)
OfAttr *	add_custom_attribute (const OfItem::AttrCreationParams &params)
OfAttr *	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")
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 CoreClassInfo &	get_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 bool	is_generated_in_sa_context (const OfObject &object)
	Specify if a given object has been generated in a scene assembly context.
static bool	is_generated_in_sa_context (const OfContext &context)
	Specify if a given context has been generated in a scene assembly context.
static void	gather_referenced_contexts (const OfObject &object, CoreSet< OfContext * > &contexts, const CoreSet< OfObject * > &stop_on_objects={})
	gather all contexts recursively referenced by the object
static void	update_referenced_contexts (const OfObject &object)
	update all the contexts referenced by the object
Static Public Member Functions inherited from OfContextEngine
static const Descriptor &	get_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 CoreClassInfo &	class_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 CoreClassInfo &	class_info ()
	Get the type descriptor of this instance.

Protected Types
enum	PrivateState {   STATE_CONTENT_DIRTY = NEXT_PRIVATE_FLAG,   STATE_FORCE_READ_ONLY = NEXT_PRIVATE_FLAG << 1 }
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
OfContextEngine::Result	do_deserialize_objects (ParseSerialData *serial_data, const OfSerialOptions &options, AppProgressBar *progress_bar) override
ParserEntry *	serialize (ParserEntry *entry, const OfSerialOptions &options, AppProgressBar *progress_bar) const override
void	populate_options () override
void	on_options_changed (OfObject &options) override
void	get_status_bar (ComponentInterfaceNodeStatus &status) const override
	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
void	clear ()
	clear all items that were created in the engine context
virtual void	refresh_content ()
	refresh the content of the scene assembly context
void	send_event_content_dirty () const
	send an event to notify that the content of the scene assembly context is dirty
virtual void	make_virtual (const CoreBasicArray< OfItemHandle > &items)
	inverse operation of make_real()
void	add_input_context (OfContext *context)
	add an input context to the scene assembly context
void	remove_input_context (OfContext *context)
	remove an input context from the scene assembly context
void	set_input_items (const CoreBasicArray< OfItem * > &items)
	set the input items of the scene assembly context
OfItemHandle	mirror_item (OfSceneDescription::Item &item_desc, const OfSceneDescription &scene, const VariationTables *tables=0, CoreSet< OfItemHandle > *items_to_move=0)
	Mirror an item from a description in the scene assembly context.
OfContext *	create_context_from_path (const CoreString &context_path) const
	create a context inside the engine context given its local path inside this context
void	add_item_to_scene (OfItem &item, OfSceneDescription &scene, OfSceneDescription::ItemId parent_id=OfSceneDescription::get_null_id()) const
	add an OF item already created into the scene description the engine context
void	override_resources (OfObject *object)
	apply the overrides on the resources that were done in this context
void	clear_resource_override (const CoreString &object_path) const
void	clear_resource_overrides () const
virtual void	override_attributes (OfObject *object, OfSceneDescription::ItemId item_id=OfSceneDescription::get_null_id())
	modify the values of all the attributes of an object overridden in the scene assembly
Protected Member Functions inherited from OfContextEngine
	OfContextEngine (OfContext &ctx)
virtual bool	populate_settings (ParserGroup &group, OfContext *context) const
void	register_component_implementation ()
void	_populate_options ()
OfAttr *	add_option_attribute (const OfItem::AttrCreationParams &params)
OfAttr *	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")
void	remove_all_option_attributes ()
void	_on_options_changed (OfObject &options)
virtual void	on_context_event (const CoreString &event)
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 ParserEntry *	serialize_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 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 OfClass *	get_project_item_class () const

Protected Attributes
CoreHashTable< OfItem *, OfItemHandle >	m_items_mirrors
CoreHashTable< OfObject *, OfObject * >	m_substitute_objects
	objects that have been changed by another because of a conflict name
bool	m_updating_content
bool	m_clearing_content
bool	m_is_scene_description_dirty
	specify if the scene description has never be computed while the node is dirty
CoreHashTable< CoreString, CoreVector< ParserEntry * > >	m_object_resources
	List of resource keys generated by the application per object.
Protected Attributes inherited from OfContextEngine
OfContext &	m_ctx
	The OfContext hosting the engine.
const OfClass *	m_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	OfSceneDescription
class	OfSceneAssemblyTests

Additional Inherited Members
Public Types inherited from OfContextEngine
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.
Static Protected Member Functions inherited from OfContextEngine
static OfContextEngine *	create_engine (OfContext &ctx)
static ParseSerialData *	parse_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 ParserEntry *	serialize_options (const OfContext &context, const OfSerialOptions &serial_options)
static void	deserialize_options (OfContext &context, const ParserEntry *serial, const OfSerialOptions &serial_options)

Detailed Description

Base class for engine of scene assembly context. A scene assembly context is either a read context or an operator context. A read context allows to load a scene and creates its content on demand (see: OfSceneAssemblyReadContextEngine). An operator context takes as input one or multiples contexts and is able to add/remove/override any items coming from the input.

Member Enumeration Documentation

enum OfSceneAssemblyContextEngine::PrivateState

protected

Enumerator:

STATE_FORCE_READ_ONLY

Specify that the content must be updated.

Member Function Documentation

void OfSceneAssemblyContextEngine::add_item_to_scene ( OfItem &  item, OfSceneDescription &  scene, OfSceneDescription::ItemId  parent_id = OfSceneDescription::get_null_id()  ) const

protected

add an OF item already created into the scene description the engine context

Parameters

item	the OF itemto add
scene	the scene description the engine context
parent_id	optional ID of the kinematic parent of the item in the scene

OfContext * OfSceneAssemblyContextEngine::create_context_from_path ( const CoreString &  context_path ) const

protected

create a context inside the engine context given its local path inside this context

Parameters

context_path

the path of the context to create local to the root

Returns

the created context

void OfSceneAssemblyContextEngine::gather_referenced_contexts ( const OfObject &  object, CoreSet< OfContext * > &  contexts, const CoreSet< OfObject * > &  stop_on_objects = {}  )

static

gather all contexts recursively referenced by the object

Parameters

object	the object
contexts	the contexts referenced by the object stop_on_objects all references that are in this list must not put its references branch into the result

const CoreString & OfSceneAssemblyContextEngine::get_item_full_name ( const OfItem &  item )

overridevirtual

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

Parameters

item

the item

Returns

the project path of the item in the engine context

Reimplemented from OfContextEngine.

OfItemHandle OfSceneAssemblyContextEngine::get_item_handle

(

OfProxyId

id

)

const

Get a valid item handle for the given ID.

Note

After a scene assembly context is updated because of a modification of the scene, a handle of an item inside this context may then be invalid. This method can be used at anytime to retrieve another valid handle of the item after any scene modification

See Also

get_proxy_id(OfItemHandle item)

OfItemProxy

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

inlineoverridevirtual

returns the IDs of items referenced by an item

Parameters

item_id	the ID of the item in the engine
references	the 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 from OfContextEngine.

OfObjectHandle OfSceneAssemblyContextEngine::get_object_handle ( OfObject *  object, OfClass *  missing_class = 0  ) const

overridevirtual

Returns a handle for the given object in the context.

Parameters

object	the object
missing_class	the empty class to consider if the object is missing in the context

Note

if the given object does not exist in the scene, it returns an empty handle, otherwise it returns a handle containing the OfObject pointer and the parent context of this object in the scene. The OfObject pointer corresponds either to the pointer of the given object if the object has no variation, otherwise it corresponds to the pointer of the new object that has been created to generate this new variation (i.e object has attribute changes)

Reimplemented from OfContextEngine.

OfPlugHandle OfSceneAssemblyContextEngine::get_plug_handle

(

OfProxyId

id

)

const

Get a valid plug handle for the given ID.

Note

After a scene assembly context is updated because of a modification of the scene, a handle of a plug inside this context may then be invalid. This method can be used at anytime to retrieve another valid handle of the plug after any scene modification

See Also

get_proxy_id(OfPlugHandle plug)

OfPlugProxy

OfProxyId OfSceneAssemblyContextEngine::get_proxy_id

(

OfItemHandle

item

)

const

Get the ID of the given item in this scene assembly context.

Note

After a scene assembly context is updated because of a modification of the scene, a handle of an item inside this context may then be invalid. The ID returned by this method can be used at anytime to retrieve another valid handle of the item after any scene modification

See Also

get_item_handle(OfProxyId id)

OfItemProxy

OfProxyId OfSceneAssemblyContextEngine::get_proxy_id

(

OfPlugHandle

plug

)

const

Get the ID of the given plug in this scene assembly context.

Note

After a scene assembly context is updated because of a modification of the scene, a handle of a plug inside this context may then be invalid. The ID returned by this method can be used at anytime to retrieve another valid handle of the plug after any scene modification

See Also

get_plug_handle(OfProxyId id)

OfPlugProxy

void OfSceneAssemblyContextEngine::get_status_bar ( ComponentInterfaceNodeStatus &  status ) const

overrideprotectedvirtual

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

status

the status to modify

Reimplemented from OfContextEngine.

Reimplemented in OfSceneAssemblyReadContextEngine.

bool OfSceneAssemblyContextEngine::has_generate

(

const OfItem &

item

)

const

Return true if this scene assembly context has generard the given item.

See Also

Added items in Scene Assembly Edit node

bool OfSceneAssemblyContextEngine::is_generated_in_sa_context ( const OfObject &  object )

static

Specify if a given object has been generated in a scene assembly context.

See Also

Added items in Scene Assembly Edit node

bool OfSceneAssemblyContextEngine::is_generated_in_sa_context ( const OfContext &  context )

static

Specify if a given context has been generated in a scene assembly context.

See Also

Added items in Scene Assembly Edit node

bool OfSceneAssemblyContextEngine::is_shadowable ( const OfItem &  item )

inlineoverridevirtual

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

void OfSceneAssemblyContextEngine::make_real ( const CoreBasicArray< OfItemHandle > &  items )

virtual

create a real OF item for all the given items

Parameters

items

the list of items that is supposed to contains only virtual items

Note

this method is called for example when a user right-click -> edit on an object in an Edit node. The object was virtual, so we have to create a real object in order to override its attributes.

void OfSceneAssemblyContextEngine::make_virtual ( const CoreBasicArray< OfItemHandle > &  items )

protectedvirtual

inverse operation of make_real()

See Also

make_real()

OfItemHandle OfSceneAssemblyContextEngine::mirror_item ( OfSceneDescription::Item &  item_desc, const OfSceneDescription &  scene, const VariationTables *  tables = 0, CoreSet< OfItemHandle > *  items_to_move = 0  )

protected

Mirror an item from a description in the scene assembly context.

Parameters

item_desc	description of the source item to mirror
scene	description of the whole scene assembly context
tables	varitation tables used to mirror the correct variation of the object instead of the object if any
items_to_move	already inserted items which are going to be moved in their parent contexts

Note

All the ancestors of the current item are also created if it is not done yet.

As the scene assembly mechanism generates override objects in advance, it is possible to have objects (and their ancestors) that are already inserted. So when we're trying to insert an item that is already created, we do not create it another time but we take care of moving it at the end of the context so its index is updated according to its index in the scene descriptor. This allows to have a consistent order which is not dependent of the wrong order of creation imposed by the scene assembly.

void OfSceneAssemblyContextEngine::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

options

The options OfObject.

Reimplemented from OfContextEngine.

Reimplemented in OfSceneAssemblyReadContextEngine.

virtual void OfSceneAssemblyContextEngine::override_attributes ( OfObject *  object, OfSceneDescription::ItemId  item_id = OfSceneDescription::get_null_id()  )

inlineprotectedvirtual

modify the values of all the attributes of an object overridden in the scene assembly

Parameters

object	the object overridden in the scene assembly
item_id	the ID of the object in the scene description, may be used when the node store a cache of the scene description

Note

this method must be overridden by all engines generating overrides in the scene assembly

void OfSceneAssemblyContextEngine::override_resources ( OfObject *  object )

protected

apply the overrides on the resources that were done in this context

Parameters

object

the object on which to apply the overrides

void OfSceneAssemblyContextEngine::refresh_content ( )

protectedvirtual

refresh the content of the scene assembly context

Note

this is the entry point where the scene description of the context is computed and then the of items that are needed for the scene are created in the context

Reimplemented in OfSceneAssemblyReadContextEngine.

void OfSceneAssemblyContextEngine::send_event_content_dirty ( ) const

protected

send an event to notify that the content of the scene assembly context is dirty

Note

it is mainly used to update SA contexts having as input the current context, or group referencing the current context

void OfSceneAssemblyContextEngine::update_referenced_contexts ( const OfObject &  object )

static

update all the contexts referenced by the object

Parameters

object

the object

Member Data Documentation

bool OfSceneAssemblyContextEngine::m_clearing_content

protected

true if the engine is clearing its content

See Also

clear()

CoreHashTable<OfItem *, OfItemHandle> OfSceneAssemblyContextEngine::m_items_mirrors

protected

enable to retrieve the corresponding item handle for a given real item

Warning

overridden objects that are referenced by objects in the context but which are not mirrored in this context are also stored in this table

bool OfSceneAssemblyContextEngine::m_updating_content

protected

true if the engine is updating its content

See Also

update_context()