Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
HyperView
poIRenderOptions Class
poIRenderOptions SetUndeformedUserColor
Sets the color for undeformed shape.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  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
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  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.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
        poIRenderOptions GetAllFeaturesMode
        Gets the state of the global flag controlling the display of non-visible geometry using feature lines.
        poIRenderOptions GetAllTransparencyMode
        Gets the state of the global flag controlling the display of non-visible geometry as transparent.
        poIRenderOptions GetAnimateEnabled
        Gets the state of Animation during Dynamic view manipulation.
        poIRenderOptions GetAntiAliasing
        Gets the current anti-aliasing setting.
        poIRenderOptions GetAxisColor
        Gets the color of the specified global axis.
        poIRenderOptions GetAxisLabelColor
        Gets the color of the labels for the global axis.
        poIRenderOptions GetBackgroundColor
        Gets the background color of the view.
        poIRenderOptions GetCaptureImageQuality
        Gets the quality of images to be captured or printed.
        poIRenderOptions GetCollectorColor
        Gets the selection highlighting color.
        poIRenderOptions GetCollectorTransparentMode
        Gets the selection highlighting mode.
        poIRenderOptions GetContourLightingEnabled
        Gets the lighting state when a contour is applied.
        poIRenderOptions GetCoordinateSystemSize
        Gets the size used to draw coordinate systems.
        poIRenderOptions GetDABEnabled
        Indicates whether the Display Acceleration Block (DAB) display acceleration is enabled or disabled.
        poIRenderOptions GetDefaultCollectorColor
        Gets the default selection highlighting color.
        poIRenderOptions GetElementMarkEnabled
        Gets the element mark drawing state.
        poIRenderOptions GetElementMarkShape
        Gets the element mark shape for a given element configuration.
        poIRenderOptions GetEnvironmentMapping
        Gets the status of the environment mapping option.
        poIRenderOptions GetEnvMapFormat
        Gets the image format of the environment mapping textures.
        poIRenderOptions GetEnvMapPath
        Gets the relative path of the environment mapping textures folder.
        poIRenderOptions GetElementMarkSize
        Gets the element mark size in model percentage units.
        poIRenderOptions GetErosionDrawEnabled
        Gets the erosion draw enabled status (true/false).
        poIRenderOptions GetEyeScreenRatio
        Gets the ratio of distance between the viewer's eyes and the distance from the screen.
        poIRenderOptions GetFeatureAngle
        Gets the feature or crease angle between elements.
        poIRenderOptions GetForegroundColor
        Gets the foreground color of the view.
        poIRenderOptions GetGeneratedLineThickness
        Gets the thickness of the lines generated from iso value and section cut operations.
        poIRenderOptions GetGlobalAxisEnabled
        Gets the global axis draw option.
        poIRenderOptions GetGradientType
        Gets the gradient background layout.
        poIRenderOptions GetGradientTypeList
        Gets a list of available background gradient layouts.
        poIRenderOptions GetLightingMode
        Gets the current lighting mode.
        poIRenderOptions GetLightPosition
        Gets the light position in the form "x y".
        poIRenderOptions GetMaterialShininess
        Gets the material shininess.
        poIRenderOptions GetMeshColor
        Gets the mesh line color.
        poIRenderOptions GetMeshColorMode
        Gets the mesh color mode.
        poIRenderOptions GetMeshColorModeList
        Gets the list of all mesh color modes.
        poIRenderOptions GetMeshDetails
        Gets the current value of the mesh detail slider.
        poIRenderOptions GetNumberOfTracingSteps
        Gets the number of simulation steps to trace.
        poIRenderOptions GetOptimizeRotatePanViewEnabled
        Gets the status of the optimize rotate/pan option.
        poIRenderOptions GetPerspectiveMode
        Gets the current view mode.
        poIRenderOptions GetPickApertureSize
        Gets the pick aperture size or tolerance for the mouse cursor.
        poIRenderOptions GetPreloadDataEnabled
        Gets the PreLoad Simulation Data state.
        poIRenderOptions GetRealisticRendering
        Gets the status of the realistic rendering option.
        poIRenderOptions GetReverseLegendCaptureEnabled
        Gets the legend image capturing state.
        poIRenderOptions GetReverseVideoCaptureEnabled
        Gets the image capturing state.
        poIRenderOptions GetScaleCaptureAnnotations
        Gets whether to scale annotations during image capture.
        poIRenderOptions GetShadeMode
        Gets the shading mode.
        poIRenderOptions GetShowAxisArrows
        Gets the display state of the triad axis arrows.
        poIRenderOptions GetSpecularColor
        Gets the specular color.
        poIRenderOptions GetSpringAsCyclinderCoilCount
        Gets the number of spring coils beyond which a cylinder will be generated (rather than a spring).
        poIRenderOptions GetStereo
        Returns whether or not the stereoscopic display is enabled.
        poIRenderOptions GetStereoPerspectiveAngle
        Gets the perspective field of view angle when the stereoscopic display is enabled.
        poIRenderOptions GetUndeformedColorMode
        Gets the undeformed shape color mode.
        poIRenderOptions GetUndeformedMeshMode
        Gets the undeformed shape mesh mode.
        poIRenderOptions GetUndeformedTrackEnabled
        Gets the undeformed track enabled state.
        poIRenderOptions GetUndeformedUserColor
        Gets the color specified for the undeformed shape.
        poIRenderOptions GetUseModelCenter
        Gets whether to use the model center during keyboard rotations.
        poIRenderOptions GetViewAccelerationEnabled
        Gets the view acceleration state.
        poIRenderOptions GetViewCubeDisplay
        Gets the display mode of the view cube.
        poIRenderOptions GetViewCubeGeometry
        Gets the geometry mode of the view cube.
        poIRenderOptions GetViewCubeOrientation
        Gets the current front face orientation of the view cube.
        poIRenderOptions GetViewCubePosition
        Gets the current position of the view cube.
        poIRenderOptions GetViewCubeReflectors
        Gets the reflectors display mode of the view cube.
        poIRenderOptions GetViewCubeRotatorIncrement
        Gets the rotator increment angle of the view cube.
        poIRenderOptions GetViewCubeRotators
        Gets the rotators display mode of the view cube.
        poIRenderOptions GetViewTransition
        Gets the status of the smooth view transition option.
        poIRenderOptions GetZoomFactor
        Gets the zoom factor.
        poIRenderOptions SetAllFeaturesMode (deprecated)
        Sets the global flag controlling the display of non-visible geometry using feature lines.
        poIRenderOptions SetAllTransparencyMode (deprecated)
        Sets the global flag controlling the display of non-visible geometry as transparent.
        poIRenderOptions SetAnimateEnabled
        Sets the state of Animation during Dynamic view manipulation.
        poIRenderOptions SetAntiAliasing
        Sets the current anti-aliasing setting.
        poIRenderOptions SetAxisColor
        Sets the color for the global axis.
        poIRenderOptions SetAxisLabelColor
        Sets the color of the labels for the global axis.
        poIRenderOptions SetBackgroundColor
        Sets the background color(s).
        poIRenderOptions SetCaptureImageQuality
        Sets the quality of images to be captured or printed.
        poIRenderOptions SetCollectorColor
        Sets the selection highlighting color.
        poIRenderOptions SetCollectorTransparentMode
        Sets the selection highlighting mode to transparent highlighting.
        poIRenderOptions SetContourLightingEnabled
        Sets the lighting state when a contour is applied.
        poIRenderOptions SetCoordinateSystemSize
        Sets the size used to draw coordinate systems.
        poIRenderOptions SetDABEnabled
        Allows you to enable or disable the Display Acceleration Block (DAB) display acceleration.
        poIRenderOptions SetElementMarkEnabled
        Sets the element mark state.
        poIRenderOptions SetElementMarkShape
        Sets the element mark shape for a given element configuration.
        poIRenderOptions SetElementMarkSize
        Sets the element mark size in model percentage units.
        poIRenderOptions SetEnvironmentMapping
        Sets the status of the environment mapping option.
        poIRenderOptions SetEnvMapPathAndFormat
        Sets the relative path and image format of the environment textures folder.
        poIRenderOptions SetErosionDrawEnabled
        Sets the erosion draw enabled status.
        poIRenderOptions SetEyeScreenRatio
        Sets the ratio of distance between the viewer's eyes and the distance from the screen.
        poIRenderOptions SetFeatureAngle
        Sets the feature or crease angle between elements.
        poIRenderOptions SetForegroundColor
        Sets the foreground color of the view.
        poIRenderOptions SetGeneratedLineThickness
        Sets the thickness of lines generated from iso value and section cut operations.
        poIRenderOptions SetGlobalAxisEnabled
        Sets the global axis draw option.
        poIRenderOptions SetGradientType
        Sets the gradient background layout.
        poIRenderOptions SetLightingMode
        Sets the current lighting mode.
        poIRenderOptions SetLightPosition
        Sets the light position.
        poIRenderOptions SetMaterialShininess
        Sets the material shininess.
        poIRenderOptions SetMeshColor
        Sets the mesh lines color.
        poIRenderOptions SetMeshColorMode
        Sets the mesh color mode.
        poIRenderOptions SetMeshDetails
        Sets the current value of the mesh detail slider.
        poIRenderOptions SetNumberOfTracingSteps
        Sets the number of simulation steps to trace.
        poIRenderOptions SetOptimizeRotatePanViewEnabled
        Sets the status of the optimize rotate/pan option.
        poIRenderOptions SetPerspectiveMode
        Enables/disables perspective viewing. If disabled, an orthographic view is displayed.
        poIRenderOptions SetPickApertureSize
        Sets the pick aperture size or tolerance for the mouse cursor.
        poIRenderOptions SetPreloadDataEnabled
        Sets the PreLoad Simulation Data state.
        poIRenderOptions SetRealisticRendering
        Sets the status of the realistic rendering option.
        poIRenderOptions SetReverseLegendCaptureEnabled
        Sets the legend image capturing state.
        poIRenderOptions SetReverseVideoCaptureEnabled
        Sets the image capturing state.
        poIRenderOptions SetScaleCaptureAnnotations
        Set to enable the scaling of annotations during image capture.
        poIRenderOptions SetShadeMode
        Sets the shading mode.
        poIRenderOptions SetShowAxisArrows
        Sets the display state of the triad axis arrows.
        poIRenderOptions SetSpecularColor
        Sets the specular color.
        poIRenderOptions SetSpringAsCyclinderCoilCount
        Sets the number of spring coils beyond which a cylinder will be generated (rather than a spring).
        poIRenderOptions SetStereo
        Enables/disables the stereoscopic display.
        poIRenderOptions SetStereoPerspectiveAngle
        Sets the perspective field of view angle when the stereoscopic display is enabled.
        poIRenderOptions SetUndeformedColorMode
        Sets the undeformed shape color mode.
        poIRenderOptions SetUndeformedMeshMode
        Sets the undeformed shape mesh mode.
        poIRenderOptions SetUndeformedTrackEnabled
        Sets the undeformed track enabled state.
        poIRenderOptions SetUndeformedUserColor
        Sets the color for undeformed shape.
        poIRenderOptions SetUseModelCenter
        Set whether to use the model center for keyboard rotations.
        poIRenderOptions SetViewAccelerationEnabled
        Sets the view acceleration state.
        poIRenderOptions SetViewCubeDisplay
        Sets the view cube display state.
        poIRenderOptions SetViewCubeGeometry
        Sets the view cube geometry state.
        poIRenderOptions SetViewCubeOrientation
        Sets the view cube front face orientation.
        poIRenderOptions SetViewCubePosition
        Sets the view cube position.
        poIRenderOptions SetViewCubeReflectors
        Sets the view cube reflectors display state.
        poIRenderOptions SetViewCubeRotatorIncrement
        Sets the view cube rotator increment angle.
        poIRenderOptions SetViewCubeRotators
        Sets the view cube rotators display state.
        poIRenderOptions SetViewTransition
        Sets the smooth view transition state.
        poIRenderOptions SetZoomFactor
        Sets the zoom factor.
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

poIRenderOptions SetUndeformedUserColor

Sets the color for undeformed shape.

Syntax

poIRenderOptions_handle SetUndeformedUserColor color

Application

HyperView Tcl Modify

Description

This command sets the color for undeformed shape.

Note: This option is valid only if a tracking system had been defined.

Inputs

color: Set the color value using the RGB format (for example, 255 255 255).

Errors

Returns 0 if successful, otherwise an error code.