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
poISection Class
poISection GetClipAbove
Gets the current direction of the clipping surface (above or below).

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
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
        poISection AlignView
        Align view from the normal direction of a planar section.
        poISection GetBase
        Gets the section base coordinate.
        poISection GetBaseFrame
        Gets the section base frame (for deformable sections only).
        poISection GetBaseTime
        Gets the section base time.
        poISection GetClipAbove
        Gets the current direction of the clipping surface (above or below).
        poISection GetClipElements
        Gets the boundary element clipping state for a section.
        poISection GetColor
        Gets the section cut color value.
        poISection GetColorOverride
        Gets the state of color override option for a section cut.
        poISection GetCrossSectionOnly
        Gets the cross section only state.
        poISection GetD
        Gets the plane "D" parameter for a Planar section type.
        poISection GetDeformMode
        Gets the deform mode. Section cuts operate in either deformable or section_type (planar or spherical) mode.
        poISection GetDisplayOption
        Gets the state of the given section display option.
        poISection GetDMax
        Gets the maximum plane "D" parameter for a Planar section type.
        poISection GetDMin
        Gets the minimum plane "D" parameter for a Planar section type.
        poISection GetGridSpacingX
        Gets the distance between each grid line on the local X axis for a Planar section type.
        poISection GetGridSpacingY
        Gets the distance between each grid line on the local Y axis for a Planar section type.
        poISection GetGridTextPrecision
        Gets the precision of the grid text values for a Planar section type.
        poISection GetID
        Gets the section ID.
        poISection GetLabel
        Gets the section label.
        poISection GetOrientation
        Gets the section's orientation plane for a Planar section type.
        poISection GetOrientationMethod
        Gets the section display mode, used to control polygon visibility for a Planar section type.
        poISection GetRadius
        Gets the clipping sphere radius for a Spherical section type.
        poISection GetThickness
        Gets the thickness of the section cut edge lines.
        poISection GetType
        Gets the type of section.
        poISection GetVisibility
        Gets the section visibility state.
        poISection GetWidth
        Gets the width of a cross section.
        poISection Reverse
        Reverses the current direction of the clipping plane.
        poISection SetBase
        Sets the section base coordinate.
        poISection SetBaseFrame
        Sets the section base frame (for deformable sections only).
        poISection SetBaseNode
        Sets the section base coordinate.
        poISection SetBaseTime
        Sets the base time for a section cut.
        poISection SetClipAbove
        Toggles the current direction for the section.
        poISection SetClipElements
        Toggles the boundary element clipping state for a section.
        poISection SetClipTransparency
        Sets whether the clipped geometry (by iso or section cut) is displayed as transparent instead of being ignored.
        poISection SetColor
        Sets the section cut color.
        poISection SetColorOverride
        Sets the state of the color override option for a section.
        poISection SetCrossSectionOnly
        Sets the cross section only state.
        poISection SetD
        Sets the plane "D" parameter for a Planar section type.
        poISection SetDeformMode
        Toggles the deformable section mode.
        poISection SetDIncrement
        Sets the amount to increment the plane's "D" when translating the section along the normal for a Planar section type.
        poISection SetDisplayOption
        Sets the state of the given section display option.
        poISection SetGridSpacingX
        Sets the distance between each grid line on the local X axis for a Planar section type.
        poISection SetGridSpacingY
        Sets the distance between each grid line on the local Y axis for a Planar section type.
        poISection SetGridTextPrecision
        Sets the precision of the grid text values for a Planar section type.
        poISection SetLabel
        Sets the section label.
        poISection SetOrientation
        Sets the section's orientation plane for a Planar section type.
        poISection SetOrientationMethod
        Sets the section orientation method for a Planar section type.
        poISection SetOrientationNode
        Sets the section's orientation plane by model/node ID pairs for a Planar section type.
        poISection SetRadius
        Sets the clipping sphere radius for a Spherical section type.
        poISection SetThickness
        Sets the thickness of the section cut edge lines.
        poISection SetVisibility
        Sets the section visibility.
        poISection SetWidth
        Sets the width of a cross section for a Planar section type.
      - 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.

poISection GetClipAbove

Gets the current direction of the clipping surface (above or below).

Syntax

poISection_handle GetClipAbove

Application

HyperView Tcl Query

Description

This command returns the current direction of the clipping surface. Returns "True" if the clip is above, or "False" if the clip is below.

Example

To get the current direction of the clipping surface:

hwi OpenStack
hwi GetSessionHandle sess
sess GetProjectHandle proj
proj GetPageHandle page [proj GetActivePage]
page GetWindowHandle win [page GetActiveWindow]
win GetClientHandle post_handle
post_handle GetSectionHandle section_handle [post_handle AddSection 0]
# Get clip side
section_handle GetClipAbove
hwi CloseStack

Errors

Returns false.