hwIPage GetCurrentAnimationFramerate

Gets the current animation frame rate, in frames per second.

Syntax

page_handle GetCurrentAnimationFramerate

Application

Tcl Query

Description

This command gets the current animation frame rate. This is the same value that is shown in the Frame Rate window that is visible when you click the Frame Rate button on the Animation Controls panel.

Example

To get the average across the part state from contour control:

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]
page_handle GetCurrentAnimationFramerate
hwi CloseStack

Error

This command should always return a floating point value.