ISceneLayersManager Class Reference

Allows to control scene overlays.
More...

#include <layers_manager_interface.h>

Inherits ISceneLayersManagerBase.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	CreateLayer (const SDKString &layer_name, const scene::LayerPriority &priority, const SDKPointF2D &pos, const SDKSizeF &size, SDKUInt64 flags, const SDKString &portrayal_layer_name, const SDKString &display_groups_filter, const SDKAny &renderer, ISceneLayerSP &created_layer, SceneLayerID *created_layer_id) const =0 throw ()
	Creates a new layer. This method does not add a new layer into the scene. More...
virtual SDKResult SDK_CALLTYPE	AddLayer (const ISceneLayerSP &new_layer, const SceneLayerID &parent_layer_id)=0 throw ()
	Adds the layer to the scene.
virtual SDKResult SDK_CALLTYPE	DeleteLayer (const SceneLayerID &layer_id)=0 throw ()
	Deletes layer from the scene.
virtual SDKResult SDK_CALLTYPE	GetLayers (ISceneLayersEnumeratorSP &layers) const =0 throw ()
	Returns layers enumerator.
virtual SDKResult SDK_CALLTYPE	FindLayerByID (const SceneLayerID &layer_id, ISceneLayerSP &layer) const =0 throw ()
	Finds layer by the id.
virtual SDKResult SDK_CALLTYPE	FindLayerByName (const SDKString &layer_name, ISceneLayerSP &layer) const =0 throw ()
	Finds layer by the name.
virtual SDKResult SDK_CALLTYPE	LoadLayerDescriptions (const base::ISDKStreamSP &data)=0 throw ()
	Reads layer configuration from formatted data.
virtual SDKResult SDK_CALLTYPE	GetAvailableLayerSets (IEnumSDKStringSP &layer_set_names) const =0 throw ()
	Returns available layer set names.
virtual SDKResult SDK_CALLTYPE	AddLayerSet (const SDKString &layer_set_name)=0 throw ()
	Adds layer-set layers read from configuration. Removes layers with the same type-name before adding.
virtual SDKResult SDK_CALLTYPE	Clear ()=0 throw ()
	Removes all layers.
virtual SDKResult	UpdateLayersManagerState (const ISceneLayersManagerSP &layers_manager, const ISceneLayersManagerUpdateParametersSP &parameters)=0
	Updates layers data.

Detailed Description

Allows to control scene overlays.

Member Function Documentation

CreateLayer()

virtual SDKResult SDK_CALLTYPE CreateLayer ( const SDKString &  layer_name, const scene::LayerPriority &  priority, const SDKPointF2D &  pos, const SDKSizeF &  size, SDKUInt64  flags, const SDKString &  portrayal_layer_name, const SDKString &  display_groups_filter, const SDKAny &  renderer, ISceneLayerSP &  created_layer, SceneLayerID *  created_layer_id  ) const throw ( )

pure virtual

Creates a new layer. This method does not add a new layer into the scene.

Parameters

layer_name	The layer name
priority	The layer priority
pos	Position in scene
size	Layer size
flags	See SceneLayerFlags
portrayal_layer_name	The portrayal layer name
display_groups_filter	The display groups filter
renderer	Reference to the Renderer or Renderer Name
created_layer	Created layer
created_layer_id	Created layer ID

---

The documentation for this class was generated from the following file:

• layers_manager_interface.h