vidIVideo GetBackgroundColor
Returns the background color.
Syntax
vidIVideo_handle GetBackgroundColor
Application
HyperWorks Tcl Query
Description
Returns an integer from 0 to 63 that specifies the background color.
Errors
None.
View new features for HyperWorks Desktop 2021.1.
Learn the basics and discover the workspace.
Discover HyperWorks Desktop functionality with interactive tutorials.
Start HyperWorks Desktop and configure the applications.
Create, open, import, and save models.
Control the view and display of your model in the modeling window.
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Automate common workflows using the Process Manager or Automate tool.
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
Batch mode allows you perform a series of operations outside the program interface.
External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, MotionView, MediaView and TextView.
Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
Examples of script uses cases.
Learn more about Tcl/Tk with this basic example.
Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
Tcl/Tk classes for the following HyperWorks Desktop applications.
Cancels an overlay after it has been triggered.
Adds a measure object to the associated video.
Adds a new video.
Adds an empty note to the video.
Adds a file to the Overlay Panel list, turning on the file.
Adds a traceable marker to the video.
Changes the timestep on the current page to show given measure.
Clears all data from the video.
Sets the display status for the master measure to off.
Clears the measuring line.
Deletes all measures from the specified video.
Deletes the specified measure object.
Deletes a tracing marker from the video.
Forces the video to redraw.
Draws the measuring line.
Exports the markers currently defined on the video to a file.
Finds the location of the annotation.
Returns the background color.
Gets a string containing the x and y locations of the crosshair cursor.
Gets the color used for drawing the text in the user coordinate system symbol.
Gets the color used for drawing the X axis arrow of the user coordinate system symbol.
Gets the color used for drawing the Y axis arrow of the user coordinate system symbol.
Gets the value of the flag denoting whether or not the marker trace lines will be displayed on the video.
Gets the value of the flag denoting whether or not the video will be displayed.
Returns the state of edge detection.
Gets a handle to a pltITitle interface for the footer.
Returns the foreground color.
Gets a handle to a pltITitle interface for the header.
Returns the state of maximum area display.
Returns the handle to an amfIMeasure object.
Returns the x value of the first point in the indexed measure.
Returns the y value of the first point in the indexed measure.
Returns the x value of the first point in the indexed measure.
Returns the y value of the first point in the indexed measure.
Returns a font handle.
Returns the handle to the Media information note of the video.
Gets a handle to a loaded movie.
Gets a handle to a pltINote interface for the specified note.
Returns the number of measures currently added to the selected video.
Returns the number of movies.
Returns the number of notes in the video.
Determines if the overlay is applied to all windows.
Determines the overlay duration.
Returns a list of all videos/images and overlays.
Determines the number of overlay reps.
Returns a list of overlay states in the order they should be displayed on the Overlay Panel.
Returns the flag which causes animation of the video to stay fixed at the origin of the user defined coordinate system.
Returns the state of a flag which determines if the selected unit system will be used for plotting.
Determines whether the video is stretched.
Determines the tolerance.
Returns a font handle.
Gets a handle to the specified marker, to be used to access the APIs available to markers.
Gets a flag which indicates whether lengths and annotations of measures to be reported in the user defined units.
Returns the flag indicating if the unit system, if defined, will be used in creating plots for measures and markers.
Returns a flag specifying whether a coordinate system, if defined, will be used in calculating measures.
Imports the markers saved to a marker (*.mark) file to the video.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Determines whether the filename is shown.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Determines whether the frame number is shown.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Determines whether the time step is shown.
Determines if the tolerance is on.
Returns a flag indicating whether the master measure is displayed on the screen.
Recenters the video.
Removes a movie.
Removes the specified note from the video.
Sets the active movie.
Sets the location of the annotation.
Sets the background color.
Sets the location of the marker.
Sets the color used for drawing the text in the user coordinate system symbol.
Sets the color used for drawing the X axis arrow of the user coordinate system symbol.
Gets the color used for drawing the Y axis arrow of the user coordinate system symbol.
Sets the value of the flag denoting whether or not the marker trace lines will be displayed on the video.
Sets the value of the flag denoting whether or not the video will be displayed.
Sets the value of the flag denoting whether or not the video will be displayed.
Sets the state of edge detection.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Sets the foreground color.
Sets the state of the maximum area display.
Sets a particular command to the middle mouse button.
Sets the first point of the measuring line.
Sets the x coordinate of the first point of a static measure.
Sets the y coordinate of the first point of a static measure.
Sets the second point of the measuring line.
Sets the x coordinate of the second point of a static measure.
Sets the y coordinate of the second point of a static measure.
Sets the type of measure.
Sets if the overlay is applied to all windows.
Sets the overlay duration.
Sets the number of overlay reps.
Sets a flag which causes animation of the video to stay fixed at the origin of the user defined coordinate system.
Sets a flag which determines if the selected unit system will be used for plotting.
Sets whether the video is stretched.
Sets the tolerance.
Sets a flag which causes lengths and annotations of measures to be reported in the user defined units
Sets the flag determining if the unit system, if defined, should be used in creating plots for measures and markers.
Sets a flag specifying whether a coordinate system, if defined, will be used in calculating measures.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Sets whether the filename is shown.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Sets whether the frame number is shown.
IMPORTANT: This API is now obsolete. Please refer to the topics/reference/tcl/vidivideo_getmediainfonotehandle.html API to achieve this functionality. Sets whether the time step is shown.
Switches the active video with the overlay video.
Sets a specified overlay to toggle between on and off.
Activates the video overlay.
Unzooms the video.
Sets if the tolerance is on.
Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
XML commands in the Result Math Module.
Record playback workflows in HyperView.
The Script Exchange is a database of freely accessible scripts posted by users and Altair engineers.
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk classes for the following HyperWorks Desktop applications.
Returns the background color.
Returns the background color.
vidIVideo_handle GetBackgroundColor
HyperWorks Tcl Query
Returns an integer from 0 to 63 that specifies the background color.
None.
(c) 2021. Altair Engineering Inc. All Rights Reserved.