IScene2D Class Reference

Main 2D Scene component which contains a tree of layers and backend. More...

#include <scene_2d_interface.h>

Inheritance diagram for IScene2D:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetLayer (const LayerID &id, ILayerSP &layer)=0 throw ()
	Retrieves layer reference by its id.
virtual SDKResult SDK_CALLTYPE	GetLayerByName (const SDKString &name, ILayerSP &layer)=0 throw ()
	Retrieves layer reference by its name.
virtual SDKResult SDK_CALLTYPE	AddLayer (const LayerID &parent_id, const SDKString &name, const LayerPriority &priority, const SDKRectF2D &bounds, const SDKUInt64 &flags, const ResourceType &layer_resource_type, ILayerSP &new_layer, IRenderersSetSP &new_layer_renderers_set)=0 throw ()
	Adds new layer to the scene.
virtual SDKResult SDK_CALLTYPE	DeleteLayer (const LayerID &id)=0 throw ()
	Deletes sub-layer.
virtual SDKResult SDK_CALLTYPE	Render (const SDKArray &layers_to_render)=0 throw ()
	Renders scene layers.
virtual SDKResult SDK_CALLTYPE	Display ()=0 throw ()
	Display rendered layers on the backend.
virtual SDKResult SDK_CALLTYPE	AttachBackend (const IBackendSP &backend)=0 throw ()
	Attaches backend to render scene to.
virtual SDKResult SDK_CALLTYPE	GetBackend (IBackendSP &backend)=0 throw ()
	Returns attached backend.
virtual SDKResult SDK_CALLTYPE	CreateViewport (Scene2DViewportTypes type, IScene2DViewportBaseSP &viewport)=0 throw ()
	Creates scene viewport.
virtual SDKResult SDK_CALLTYPE	SetViewport (const IScene2DViewportBaseSP &viewport)=0 throw ()
	Sets scene viewport transformation matrix.
virtual SDKResult SDK_CALLTYPE	GetViewport (IScene2DViewportBaseSP &viewport) const =0 throw ()
	Returns scene viewport transformation matrix.
virtual SDKResult SDK_CALLTYPE	WinToScene (const SDKPointF2D &win_coordinate, SDKPointF2D &scene_coordinate) const =0 throw ()
	Converts viewport coordinate to scene coordinate.
virtual SDKResult SDK_CALLTYPE	SceneToWin (const SDKPointF2D &scene_coordinate, SDKPointF2D &win_coordinate) const =0 throw ()
	Converts scene coordinate to viewport coordinate.
virtual SDKResult SDK_CALLTYPE	SetCallback (const IScene2DCallbacksSP &listener)=0 throw ()
	Attaches callback to the scene.
Public Member Functions inherited from ISDKProperties
virtual SDKResult SDK_CALLTYPE	SetProperty (const SDKPropertyID &id, const SDKAny &value)=0 throw ()
	Sets a property value.
virtual SDKResult SDK_CALLTYPE	GetProperty (const SDKPropertyID &id, SDKAny &value) const =0 throw ()
	Retrieves a property value.

Detailed Description

Main 2D Scene component which contains a tree of layers and backend.

---

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

• scene_2d_interface.h