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
poICrossSectionPlanar Class
poICrossSectionPlanar GetClipElements
Gets the boundary element clipping state for a section.

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
        poICrossSectionPlanar GetBase
        Gets the cross section base coordinate.
        poICrossSectionPlanar GetBaseFrame
        Gets the cross section base frame (for deformable sections only).
        poICrossSectionPlanar GetBaseTime
        Gets the cross section base time.
        poICrossSectionPlanar GetClipAbove
        Gets the current direction of the clipping surface (above or below).
        poICrossSectionPlanar GetClipElements
        Gets the boundary element clipping state for a section.
        poICrossSectionPlanar GetColor
        Gets the cross section color value.
        poICrossSectionPlanar GetColorOverride
        Gets the state of the color override option for a cross section.
        poICrossSectionPlanar GetComponentSet
        Gets the component set information of the cross section.
        poICrossSectionPlanar GetCrossSectionDisplayMethod
        Gets the display method of the cross section.
        poICrossSectionPlanar GetCrossSectionOnly
        Gets the cross section only state.
        poICrossSectionPlanar GetD
        Gets the plane "D" parameter for a cross section.
        poICrossSectionPlanar GetDeformMode
        Gets the deform mode.
        poICrossSectionPlanar GetDisplayOption
        Gets the state of the given section display option.
        poICrossSectionPlanar GetDMax
        Gets the maximum plane "D" parameter.
        poICrossSectionPlanar GetDMin
        Gets the minimum plane "D" parameter.
        poICrossSectionPlanar GetGridSpacingX
        Gets the distance between each grid line on the local X axis for a cross section.
        poICrossSectionPlanar GetGridSpacingY
        Gets the distance between each grid line on the local Y axis for a cross section.
        poICrossSectionPlanar GetGridTextPrecision
        Gets the precision of the grid text values for a cross section.
        poICrossSectionPlanar GetID
        Gets the cross section ID.
        poICrossSectionPlanar GetIType
        Gets the IType value of the cross section.
        poICrossSectionPlanar GetITypeID
        Gets the ITypeID value of the cross section.
        poICrossSectionPlanar GetLabel
        Gets the cross section label.
        poICrossSectionPlanar GetLENL
        Gets the LENL value of the cross section.
        poICrossSectionPlanar GetLENM
        Gets the LENM value of the cross section.
        poICrossSectionPlanar GetOrientation
        Gets the cross section's orientation.
        poICrossSectionPlanar GetOrientationMethod
        Gets the cross section orientation method.
        poICrossSectionPlanar GetRadius
        Gets the radius value of the cross section.
        poICrossSectionPlanar GetThickness
        Gets the thickness of the cross section lines.
        poICrossSectionPlanar GetType
        Gets the type of cross section.
        poICrossSectionPlanar GetVisibility
        Gets the cross section visibility state.
        poICrossSectionPlanar GetWidth
        Gets the width of a cross section.
        poICrossSectionPlanar GetXHEV
        Gets the XHEV value of the cross section.
        poICrossSectionPlanar GetYHEV
        Gets the YHEV value of the cross section.
        poICrossSectionPlanar GetZHEV
        Gets the ZHEV value of the cross section.
        poICrossSectionPlanar IsReadOnly
        Gets whether it is read only cross section or not.
        poICrossSectionPlanar MakeReadOnly
        Makes a cross section read only.
        poICrossSectionPlanar Reverse
        Reverses the current direction of the clipping plane.
        poICrossSectionPlanar SetBase
        Sets the cross section base coordinate.
        poICrossSectionPlanar SetClipAbove
        Toggles the current direction for the cross section.
        poICrossSectionPlanar SetClipElements
        Toggles the boundary element clipping state for a cross section.
        poICrossSectionPlanar SetClipTransparency
        Sets whether the clipped geometry (by iso or section cut) is displayed as transparent instead of being ignored.
        poICrossSectionPlanar SetColor
        Sets the cross section color.
        poICrossSectionPlanar SetColorOverride
        Sets the state of the color override option for a cross section.
        poICrossSectionPlanar SetComponentSet
        Sets the component set information to the cross section.
        poICrossSectionPlanar SetCrossSectionDisplayMethod
        Sets the display method to the cross section.
        poICrossSectionPlanar SetCrossSectionOnly
        Sets the cross section only state.
        poICrossSectionPlanar SetDisplayOption
        Sets the state of the given section display option.
        poICrossSectionPlanar SetIType
        Sets the IType value to the cross section.
        poICrossSectionPlanar SetITypeID
        Sets the ITypeID value to the cross section.
        poICrossSectionPlanar SetLabel
        Sets the cross section label.
        poICrossSectionPlanar SetLENL
        Sets the LENL value to the cross section.
        poICrossSectionPlanar SetLENM
        Sets the LENM value to the cross section.
        poICrossSectionPlanar SetOrientation
        Sets the cross section's orientation plane.
        poICrossSectionPlanar SetOrientationMethod
        Sets the cross section orientation method.
        poICrossSectionPlanar SetRadius
        Sets the radius value to the cross section.
        poICrossSectionPlanar SetThickness
        Sets the thickness of the cross section lines.
        poICrossSectionPlanar SetVisibility
        Sets the cross section visibility.
        poICrossSectionPlanar SetWidth
        Sets the width of a cross section.
        poICrossSectionPlanar SetXHEV
        Sets the XHEV value to the cross section.
        poICrossSectionPlanar SetYHEV
        Sets the YHEV value to the cross section.
        poICrossSectionPlanar SetZHEV
        Sets the YHEV value to the cross section.
      - 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
      - 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.

poICrossSectionPlanar GetClipElements

Gets the boundary element clipping state for a section.

Syntax

poICrossSectionPlanar_handle GetClipElements

Application

HyperView Tcl Query

Description

This command returns the boundary element clipping state for the section. Returns "True" if the cross section will clip the boundary elements.

Errors

Returns minus 2.