poISelectionSet GetIDVisibility

Retrieves the visibility setting for the entity IDs of the current selection set.

Syntax

selectionSet_handle GetIDVisibility

Application

HyperView Tcl Query

Description

This command returns the current setting for the entity ID visibility on the selection set. The return value can either be false or true. If the entity IDs are currently visible, this command returns true; if they are not visible it returns false.
Note: The IDs can only be displayed if the state of GetVisibility is true.

Example

To create a selection set containing all nodes, makes it visible in the graphic area, and show the entity IDs:
hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetModelHandle model_handle [client_handle GetActiveModel]
model_handle AddSelectionSet node
puts "Current selection sets: [model_handle GetSelectionSetList]\n"

model_handle GetSelectionSetHandle selection_set_handle 1
selection_set_handle SetLabel "OurNodeSelectionSet"
selection_set_handle Add all

puts "Current selection set ID: [selection_set_handle GetID]"
puts "   Label: [selection_set_handle GetLabel]"
puts "   Size:  [selection_set_handle GetSize] [selection_set_handle GetType]s"
puts "   Default color:      [selection_set_handle GetColor]"
puts "   Default visibility: [selection_set_handle GetVisibility]"
puts "   Default ID visibility: [selection_set_handle GetIDVisibility]"
puts "----------------------"

selection_set_handle SetVisibility true
selection_set_handle SetIDVisibility true
puts "   Current ID visibility: [selection_set_handle GetIDVisibility]"
hwi CloseStack

Errors

This command should always return the current visibility for entity IDs. If the selection set handle is not retrievable, this command returns false.