display_groups_manager_interface.h File Reference

Describes visualization display groups interfaces. More...

#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>

Go to the source code of this file.

Data Structures
class	ISceneDisplayGroup
	Describes one display group. (E.g. viewing group) More...
class	ISceneDisplayGroupsManager
	Allows to control scene display groups. (E.g. viewing groups) More...

Enumerations
enum	DisplayGroupProperties {   kDisplayGroupProperty_ShortDescription, kDisplayGroupProperty_FullDescription, kDisplayGroupProperty_Name, kDisplayGroupProperty_TypeName,   kDisplayGroupProperty_IsVisible, kDisplayGroupProperty_SymbolScale, kDisplayGroupProperty_DLIndex, kDisplayGroupProperty_IsCovered }
	The set of properties that can be queried from the display group. More...
enum	DisplayGroupCovered { kDisplayGroupCovered_NotCovered, kDisplayGroupCovered_PartiallyCovered, kDisplayGroupCovered_FullyCovered }
	Possible values for kDisplayGroupProperty_IsCovered. More...
enum	DisplayGroupsManagerProperties { kDisplayGroupsManagerProperty_DisplayMode_Short, kDisplayGroupsManagerProperty_DisplayMode }
	The set of properties that can be set and queried from the display groups manager. More...
enum	DisplayModeEnum {   kDisplayMode_Base_Minus = 0, kDisplayMode_Base = 1, kDisplayMode_Base_Plus = 2, kDisplayMode_Standard = 3,   kDisplayMode_Standard_Plus = 4, kDisplayMode_Full = 5 }
	DisplayMode property values. More...

Variables
static const char	kDisplayGroupView_Default [] = "default"
	View is set of the complex display groups that defines the tree-view representation of the simple display groups. SDK suggests one View which is named 'default'.
static const char	kDisplayGroupView_Default_Root [] = "default.display_category"
	The display category - complex display group.
static const char	kDisplayGroupView_Default_Base [] = "default.display_category.base"
	The display category - base complex display group.
static const char	kDisplayGroupView_Default_Standard [] = "default.display_category.standard"
	The display category - standard complex display group.
static const char	kDisplayGroupView_Default_Other [] = "default.display_category.other"
	The display category - other complex display group.
static const char	kDisplayGroupView_Default_RoutesInfo [] = "default.routes_information"
	The display category - routes information complex display group.
static const char	kDisplayGroupView_Default_MarinersInfo [] = "default.mariners_information"
	The display category - mariners information complex display group.
static const char	kDisplayGroupView_Default_Additional [] = "default.additional_information"
	The display groups root for additional_information.
static const char	kDisplayGroupView_Default_Texts [] = "default.texts"
	The display groups root for texts.
static const wchar_t *	kDisplayGroupType_ViewingGroupName = L"viewing_group"
	The predefined name for 'viewing group' type.
static const wchar_t *	kDisplayGroupType_TextGroupName = L"texts"
	The predefined name for 'text' type.
static const char	kDisplayGroupView_Default [] = "default"
	View is set of the complex display groups that defines the tree-view representation of the simple display groups. SDK suggests one View which is named 'default'.
static const char	kDisplayGroupView_Default_Root [] = "default.display_category"
	The display category - complex display group.
static const char	kDisplayGroupView_Default_Base [] = "default.display_category.base"
	The display category - base complex display group.
static const char	kDisplayGroupView_Default_Standard [] = "default.display_category.standard"
	The display category - standard complex display group.
static const char	kDisplayGroupView_Default_Other [] = "default.display_category.other"
	The display category - other complex display group.
static const char	kDisplayGroupView_Default_RoutesInfo [] = "default.routes_information"
	The display category - routes information complex display group.
static const char	kDisplayGroupView_Default_MarinersInfo [] = "default.mariners_information"
	The display category - mariners information complex display group.
static const char	kDisplayGroupView_Default_Additional [] = "default.additional_information"
	The display groups root for additional_information.
static const char	kDisplayGroupView_Default_Texts [] = "default.texts"
	The display groups root for texts.
static const wchar_t *	kDisplayGroupType_ViewingGroupName = L"viewing_group"
	The predefined name for 'viewing group' type.
static const wchar_t *	kDisplayGroupType_TextGroupName = L"texts"
	The predefined name for 'text' type.

Detailed Description

Describes visualization display groups interfaces.

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

Author

The NAVTOR SDK authors.

Date

04/2012

Maintenance:

The NAVTOR SDK authors.

Enumeration Type Documentation

DisplayGroupProperties

enum DisplayGroupProperties

The set of properties that can be queried from the display group.

Enumerator
kDisplayGroupProperty_ShortDescription	Group short description.
kDisplayGroupProperty_FullDescription	Group full description.
kDisplayGroupProperty_Name	Name of the group.
kDisplayGroupProperty_TypeName	Name of the group type.
kDisplayGroupProperty_IsVisible	Set to true if switched on.
kDisplayGroupProperty_SymbolScale	Scale factor for display group objects symbols.
kDisplayGroupProperty_DLIndex	Corresponding index in display list.
kDisplayGroupProperty_IsCovered	See DisplayGroupCovered enum below.

DisplayGroupCovered

enum DisplayGroupCovered

Possible values for kDisplayGroupProperty_IsCovered.

Enumerator
kDisplayGroupCovered_NotCovered	The display group itself and its children are not turned on.
kDisplayGroupCovered_PartiallyCovered	At least one of the display group children is turned on.
kDisplayGroupCovered_FullyCovered	The display group itself and all its children are turned on.

DisplayGroupsManagerProperties

enum DisplayGroupsManagerProperties

The set of properties that can be set and queried from the display groups manager.

Enumerator
kDisplayGroupsManagerProperty_DisplayMode_Short	Only Base, Standard, Other from DisplayModeEnum.
kDisplayGroupsManagerProperty_DisplayMode	Display mode, see DisplayModeEnum.

DisplayModeEnum

enum DisplayModeEnum

DisplayMode property values.

Enumerator
kDisplayMode_Base_Minus	Less than base display.
kDisplayMode_Base	Base display.
kDisplayMode_Base_Plus	Base display with some more display groups.
kDisplayMode_Standard	Standard display.
kDisplayMode_Standard_Plus	Standard display with some more display groups.
kDisplayMode_Full	Full display (Base+Standard+Other).