poISymmetry GetEnableState

Gets the enable state of the symmetry controller.

Syntax

sym_handle GetEnableState

Application

HyperView Tcl Query

Description

This command returns the current enable state of the symmetry controller. If the enable state is "true", then the symmetry plot can be seen. If the enable state is "false", then the symmetry plot is not visible. In order for the symmetry plot to be drawn, the display option state needs to be set to "true" in the post client; you can retrieve this state by using GetDisplayOptions symmetry command in the client handle.

This command returns an integer value indicating the symmetry options that are currently applied. For example, this command returns "7" if reflection, rectangular copy, and circular are all applied. This command returns "1" if only reflection is applied, etc.

Example

To get the enable state of the symmetry controller:

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 GetSymmetryCtrlHandle sym_handle

set enable_state [sym_handle GetEnableState]

hwi CloseStack

Errors

This command should not return any errors. If no model is loaded, the symmetry handle is not retrievable and thus this command is unable to be called.