DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Collapse ModelsModels
Collapse DG Kernel ComponentsDG Kernel Components
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
Collapse ModelModel
Collapse ViewView
Collapse General ComputingGeneral Computing
Collapse Samples and TutorialsSamples and Tutorials
Collapse GraphicsGraphics
Collapse Math ObjectsMath Objects
Collapse DeprecatedDeprecated
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Search Documentation


IDynamicScreenItemManager_KC Interface

Enable
IsEnabled
GetItemCount
GetItem
SetSpacing
SetSpacingItemToObjects
RemoveItem
RemoveAll
EnableOnTop
IsEnabledOnTop
EnableOutside
IsEnabledOutside
Update
EnableHiddenItemRemoval
IsEnabledHiddenItemRemoval

Properties of Dynamic ScreenItem Manager. In the initial release it manages Smart Labels.

See also ISmartLabelManager_KC, Smart Labels, Smart Labels sample


HRESULT Enable(VARIANT_BOOL enable)
HRESULT IsEnabled(VARIANT_BOOL* enabled)

Acess to Enabled property of the manager. If false managed items will not be visible and no arrangement is performed


HRESULT GetItemCount(int* count)

Count of the managed items. Not all items in the model have to be managed


HRESULT GetItem(int index, IDynamicScreenItem_KC** item)

Returns index-th managed item


HRESULT SetSpacing(int pixels)
HRESULT GetSpacing(int* pixels)

Minimal space between labels and between labels and objects


HRESULT SetSpacingItemToObjects(int pixels)
GetSpacingItemToObjects(int* pixels)

This property is related to items located on margins of the window. It determines the minimal distance between items and any entity in the model. The default is 0.


HRESULT RemoveItem(int item)


HRESULT RemoveAll()

Deletes all managed items


HRESULT EnableOnTop(VARIANT_BOOL enable)
HRESULT IsEnabledOnTop(VARIANT_BOOL* enabled)

EnabledOnTop property. If true an item is attempted to be positioned on the top of its parent first. If it does not fit inside its silhouette and the EnabledOutside property below is true the item will be positioned on margins of the window. Setting both EnabledOnTop and EnabledOutside properties to false is equvalent to disabling items management with an Enable(false) call.


HRESULT EnableOutside(VARIANT_BOOL enable)
HRESULT IsEnabledOutside(VARIANT_BOOL* enabled)

EnabledOutside property. If true, items are positioned on margins of the window when required. See remarks for the previous method.


HRESULT Update()
As this method affects the perfomance is only recommended to be called after modifications of indirect properties like visibility of a label or text string and only if normal calls to update view is not reflected immediately


HRESULT EnableHiddenItemRemoval(VARIANT_BOOL enable)
HRESULT IsEnabledHiddenItemRemoval(VARIANT_BOOL* enabled)

EnabledHiddenItemRemoval property. If true, items are not shown when the point/object they are associated with is not visible due to being obscured by other surfaces in the current point of view