layer_interface.h File Reference

Definition of 2D Scene layer interfaces. More...

#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/geometry/geometry_base_types.h>
#include <base/inc/math/matrix_base_types.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include "renderer_interface.h"

Go to the source code of this file.

Data Structures
class	ILayer
	2D Scene layer - prepares one semantic group representation texture. More...
class	ILayerEnum
	Child layers enumerator. More...
class	IRenderContext
	Rendering context. More...
class	ILayerClipping
	Layer clipping figure. More...

Typedefs
typedef SDKUInt32	RenderingThreadID
	The rendering thread ID, Valid ID starts from 1 to value, defined by kScene2DProperty_RenderingThreadsNumber property value (see Scene2DPropertyIDs), in case thread ID is not defined, kUndefinedRenderingThreadID will be used.

Enumerations
enum	LayerRenderingPriorities { kLayerRenderingPriority_High, kLayerRenderingPriority_Normal, kLayerRenderingPriority_Low }
	Layer rendering priorities level. More...
enum	LayerPropertiesID {   kLayerProperty_Opacity, kLayerProperty_BindToSceneViewport, kLayerProperty_RenderingPriority, kLayerProperty_RenderingOrder,   kLayerProperty_Dynamic, kLayerProperty_OpaqueLayer, kLayerProperty_Max }
	Generic layer properties. More...
enum	LayerTransformationType {   kLayerTransformationType_Local, kLayerTransformationType_World, kLayerTransformationType_Position2, kLayerTransformationType_Position3,   kLayerTransformationType_Position4 }
	Available layer transformation types. More...
enum	RenderParametersID { kRenderParameter_Viewport_SizeX, kRenderParameter_Viewport_SizeY, kRenderParameter_Viewport_Max }
	Generic render properties. More...

Variables
static const RenderingThreadID	kUndefinedRenderingThreadID = 0
	In case rendering thread is undefined, given value will be used.

Detailed Description

Definition of 2D Scene layer interfaces.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author

The NAVTOR SDK authors.

Date

02/2012

Maintenance:

The NAVTOR SDK authors.

Enumeration Type Documentation

LayerRenderingPriorities

enum LayerRenderingPriorities

Layer rendering priorities level.

Enumerator
kLayerRenderingPriority_High	High rendering priority, layer is rendered on a dedicated thread.
kLayerRenderingPriority_Normal	Normal rendering priority.
kLayerRenderingPriority_Low	Low rendering priority, same as Normal for now.

LayerPropertiesID

enum LayerPropertiesID

Generic layer properties.

Enumerator
kLayerProperty_Opacity	Opacity.
kLayerProperty_BindToSceneViewport	Bind to scene viewport.
kLayerProperty_RenderingPriority	Rendering priority of the layer.
kLayerProperty_RenderingOrder	Rendering order of the layer.
kLayerProperty_Dynamic	Dynamic layers are not cached during Display.
kLayerProperty_OpaqueLayer	Layer texture is opaque flag.
kLayerProperty_Max	Equals to the number of layer properties.

LayerTransformationType

enum LayerTransformationType

Available layer transformation types.

Enumerator
kLayerTransformationType_Local	Layer transformation is multiplied on all upper relatives transformations.
kLayerTransformationType_World	Only internal layer transformation is used.
kLayerTransformationType_Position2	Additional second layer matrix.
kLayerTransformationType_Position3	Additional third layer matrix.
kLayerTransformationType_Position4	Additional forth layer matrix.

RenderParametersID

enum RenderParametersID

Generic render properties.

Enumerator
kRenderParameter_Viewport_SizeX	Viewport X size.
kRenderParameter_Viewport_SizeY	Viewport Y size.
kRenderParameter_Viewport_Max	Viewport maximum.