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.
HyperGraph 3D
plt3DIPlot Class
plt3DIPlot GetIncludeAxesInFit
Gets whether clipped data is partially visible (displayed transparently).

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
    - HyperGraph 2D
    - HyperGraph 3D
      - plt3DIAxis Class
      - plt3DIBarChart Class
      - plt3DIChart Class
      - plt3DICursor Class
      - plt3DICurve Class
      - plt3DICurveGroup Class
      - plt3DILegend Class
      - plt3DINote Class
      - plt3DIParametric Class
      - plt3DIPlane Class
      - plt3DIPlot Class
        plt3DIPlot AddBarChart
        Adds a new bar chart curve to the HyperGraph 3D window. Bar chart curves display each point in the 3-D curve as a bar rising from the XY plane.
        plt3DIPlot AddCategory
        Adds a category string to the specified axis.
        plt3DIPlot AddCurveGroup
        Adds a new curve group to the HyperGraph 3D window. Curve groups hold multiple 3-D line curves.
        plt3DIPlot AddNote
        Adds a new note to the HyperGraph 3D window.
        plt3DIPlot AddPlane
        Adds a new plane to the HyperGraph 3D window.
        plt3DIPlot AddProjectionCurveGroup
        Adds a new curve group to the HyperGraph 3D window.
        plt3DIPlot AddSurface
        Add a new 3-D Surface curve to the HyperGraph 3D window.
        plt3DIPlot AddSymbolStyle
        Returns whether or not the axes are displayed.
        plt3DIPlot AddWaterfall
        Adds a new waterfall curve to the HyperGraph 3D window. Waterfall curves hold multiple 3-D line curves.
        plt3DIPlot Autoscale
        Forces the plot to re-compute the minimum and maximum values for its axes.
        plt3DIPlot Clear
        Clears all data from the plot.
        plt3DIPlot ClearSymbolStyle
        Returns whether or not the axes are displayed.
        plt3DIPlot CopyBarChart
        Copies the bar chart curve to the internal clipboard.
        plt3DIPlot CopyCurveGroup
        Copies the curve group to the internal clipboard.
        plt3DIPlot CopyNote
        Copies the note to the internal clipboard.
        plt3DIPlot CopyPlane
        Copies the plane to the internal clipboard.
        plt3DIPlot CopyProjectionCurveGroup
        Copies the curve group to the internal clipboard.
        plt3DIPlot CopySurface
        Copies the curve to the internal clipboard.
        plt3DIPlot CopyWaterfall
        Copies the waterfall curve to the internal clipboard.
        plt3DIPlot Draw
        Forces the plot to redraw.
        plt3DIPlot GetAspectRatio
        Gets the relative lengths of the Y and Z axes with respect to X.
        plt3DIPlot GetAspectRatioLocked
        Gets whether the axis ratios are locked.
        plt3DIPlot GetAxesScaleMethod
        Returns the current axes scaling method.
        plt3DIPlot GetAxesType
        Returns whether or not the axes are displayed.
        plt3DIPlot GetAxisHandle
        Gets a handle to a plt3DIAxis interface for the specified axis.
        plt3DIPlot GetBackgroundColor
        Returns the current background color of the HyperGraph 3D window.
        plt3DIPlot GetBarChartHandle
        Gets a pointer to a bar chart curve.
        plt3DIPlot GetCategory
        Returns a category string from the specified axis.
        plt3DIPlot GetClipTransparency
        Gets whether clipped data is partially visible (displayed transparently).
        plt3DIPlot GetContourEnabled
        Obtains the contour display state.
        plt3DIPlot GetCurveGroupHandle
        Gets a pointer to a curve group.
        plt3DIPlot GetCurvePicking
        Gets whether the client wishes to receive curve-picking information.
        plt3DIPlot GetDiscreteColor
        Gets the state of blended versus discrete contour shading.
        plt3DIPlot GetFooterHandle
        Gets a handle to a pltITitle interface for the footer.
        plt3DIPlot GetForegroundColor
        Returns the current foreground color of the HyperGraph 3D window.
        plt3DIPlot GetGridLineColor
        Returns the current axes grid line color of the HyperGraph 3D window.
        plt3DIPlot GetHeaderHandle
        Gets a handle to a pltITitle interface for the header.
        plt3DIPlot GetIncludeAxesInFit
        Gets whether clipped data is partially visible (displayed transparently).
        plt3DIPlot GetLegendHandle
        Gets a handle to a pltILegend interface for the legend.
        plt3DIPlot GetLegendLocation
        Gets the legend location for the plot.
        plt3DIPlot GetLighting
        Gets the lighting state.
        plt3DIPlot GetMeshLineThickness
        Gets the thickness of the mesh lines.
        plt3DIPlot GetMetaData
        Gets a named meta-data value previously associated with the plot.
        plt3DIPlot GetNoteHandle
        Gets a pointer to a note.
        plt3DIPlot GetNumberOfBarCharts
        Returns the number of bar charts in the HyperGraph 3D window.
        plt3DIPlot GetNumberOfBarChartsOnClipboard
        Gets the current number of bar charts on the clipboard.
        plt3DIPlot GetNumberOfCategories
        Returns the number of categories in the plot.
        plt3DIPlot GetNumberOfCurveGroups
        Gets the number of curves groups in the HyperGraph window.
        plt3DIPlot GetNumberOfCurveGroupsOnClipboard
        Gets the current number of curve groups on the clipboard.
        plt3DIPlot GetNumberOfNotes
        Gets the number of notes in the HyperGraph window.
        plt3DIPlot GetNumberOfNotesOnClipboard
        Gets the current number of notes on the clipboard.
        plt3DIPlot GetNumberOfPlanes
        Gets the number of planes in the HyperGraph window.
        plt3DIPlot GetNumberOfPlanesOnClipboard
        Gets the current number of planes on the clipboard.
        plt3DIPlot GetNumberOfProjectionCurveGroups
        Gets the number of projection curve groups in the HyperGraph window.
        plt3DIPlot GetNumberOfProjectionCurveGroupsOnClipboard
        Gets the current number of projection curve groups on the clipboard.
        plt3DIPlot GetNumberOfSurfaces
        Gets the number of surfaces in the HyperGraph window.
        plt3DIPlot GetNumberOfSurfacesOnClipboard
        Gets the current number of surfaces on the clipboard.
        plt3DIPlot GetNumberOfWaterfalls
        Gets the number of waterfall curves in the HyperGraph window.
        plt3DIPlot GetNumberOfWaterfallsOnClipboard
        Gets the current number of waterfalls on the clipboard.
        plt3DIPlot GetPickApertureSize
        Finds the size of the aperture.
        plt3DIPlot GetPickedObjectHandle
        Gets a handle to an interface for the picked object.
        plt3DIPlot GetPlaneHandle
        Gets a pointer to a plane.
        plt3DIPlot GetProjectionCurveGroupHandle
        Gets a pointer to a curve group.
        plt3DIPlot GetShiftPicking
        Gets whether the client receives shift-picking information.
        plt3DIPlot GetSmoothNormals
        Gets the state of normal smoothing.
        plt3DIPlot GetSurfaceHandle
        Gets a pointer to a surface curve.
        plt3DIPlot GetSymbolStyleComponent
        Gets original component name of a 3D symbol.
        plt3DIPlot GetSymbolStyleList
        Returns whether the axes are displayed.
        plt3DIPlot GetSymbolStylePathName
        Gets the original component name of a 3D symbol.
        plt3DIPlot GetWaterfallHandle
        Gets a pointer to a waterfall curve.
        plt3DIPlot GetZeroLineColor
        Returns the current zero axes grid line color of the HyperGraph 3D window.
        plt3DIPlot PasteBarChart
        Pastes the bar chart curve from the internal clipboard.
        plt3DIPlot PasteCurveGroup
        Pastes the curve group from the internal clipboard.
        plt3DIPlot PasteNote
        Pastes the note from the internal clipboard.
        plt3DIPlot PastePlane
        Pastes the plane from the internal clipboard.
        plt3DIPlot PasteProjectionCurveGroup
        Pastes the curve group from the internal clipboard.
        plt3DIPlot PasteSurface
        Pastes the curve from the internal clipboard.
        plt3DIPlot PasteWaterfall
        Pastes the waterfall curve from the internal clipboard.
        plt3DIPlot Recalculate
        Forces the plot to regenerate all calculated data and reread all file data.
        plt3DIPlot ReleaseMouseCapture
        Releases MFC mouse capture to avoid problems with TCL menus.
        plt3DIPlot RemoveBarChart
        Deletes a bar chart curve from the HyperGraph 3D window.
        plt3DIPlot RemoveCurveGroup
        Deletes a bar chart curve from the HyperGraph 3D window.
        plt3DIPlot RemoveNote
        Deletes a note from the HyperGraph 3D window.
        plt3DIPlot RemovePlane
        Deletes a plane from the HyperGraph 3D window.
        plt3DIPlot RemoveProjectionCurveGroup
        Deletes a curve group from the HyperGraph 3D window.
        plt3DIPlot RemoveSurface
        Deletes a surface curve from the HyperGraph 3D window.
        plt3DIPlot RemoveWaterfall
        Deletes a waterfall curve from the HyperGraph 3D window.
        plt3DIPlot SetAspectRatio
        Sets the relative lengths of Y and Z axes with respect to X.
        plt3DIPlot SetAspectRatioLocked
        Sets whether the axis ratios are locked.
        plt3DIPlot SetAxesScaleMethod
        Returns the current axes scaling method.
        plt3DIPlot SetAxesType
        Sets whether the axes are displayed.
        plt3DIPlot SetBackgroundColor
        Sets the current background color of the HyperGraph 3D window.
        plt3DIPlot SetClipTransparency
        Sets whether clipped data is partially visible (displayed transparently).
        plt3DIPlot SetContourEnabled
        Turns the contour display on and off.
        plt3DIPlot SetCurvePicking
        Sets whether the client receives curve-picking information.
        plt3DIPlot SetDiscreteColor
        Displays the contour lines with edges or blended.
        plt3DIPlot SetForegroundColor
        Sets the current foreground color of the HyperGraph window.
        plt3DIPlot SetGridLineColor
        Sets the current axes grid line color of the HyperGraph 3D window.
        plt3DIPlot SetIncludeAxesInFit
        Sets whether the axes box is kept visible by a fit operation.
        plt3DIPlot SetLegendLocation
        Sets the legend location for the plot.
        plt3DIPlot SetLighting
        Turns lighting and shadows on and off.
        plt3DIPlot SetMeshLineThickness
        Sets the display thickness of the mesh lines.
        plt3DIPlot GetMetaData
        Gets a named meta-data value previously associated with the plot.
        plt3DIPlot SetMouseFunction
        Returns whether the axes are displayed.
        plt3DIPlot SetPickApertureSize
        Finds the size of the aperture.
        plt3DIPlot SetShiftPicking
        Sets whether the client receives shift-picking information.
        plt3DIPlot SetSmoothNormals
        Turns edge smoothing on and off.
        plt3DIPlot SetZeroLineColor
        Sets the current zero axes grid line color of the HyperGraph 3D window.
      - plt3DISurface Class
      - plt3DIWaterfall Class
    - 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.

plt3DIPlot GetIncludeAxesInFit

Gets whether clipped data is partially visible (displayed transparently).

Syntax

plt3DIPlot_handle GetIncludeAxesInFit

Application

Tcl Query

Description

In box axis mode, by default, the axes box is included in bounding box calculations, so as to keep it visibile when a fit operation occurs. Turning this flag off causes the plot to appear larger after a fit operation, but parts of the axes box may not be visible.

Returns true or false.

Example

To check if the axes box is included during fit operations:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetIncludeAxesInFit

Errors

None.