HyperWorks Desktop
HyperWorks Desktop

2022.3

  1. Home
  2. HyperWorks Reference Guides

    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.

  3. Tcl/Tk Commands

    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.

  4. Tcl/Tk Commands

    Tcl/Tk classes for the following HyperWorks Desktop applications.

  5. HyperView

  6. poIPart Class

  • What's New
  • Get Started
  • Tutorials
  • Startup Procedures and Customizations
  • Manage Files and Data
  • Display Controls
  • Session Navigation
  • Publish Sessions
  • Parameterize Report Templates
  • Workflow Automation
  • HyperWorks Collaboration Tools
  • HyperWorks Reference Guides
Index
HyperWorks Desktop

2022.3

HyperWorks Desktop
  • What's New

    View new features for HyperWorks Desktop 2022.3.

  • Get Started

    Learn the basics and discover the workspace.

  • Tutorials

    Discover HyperWorks Desktop functionality with interactive tutorials.

  • Startup Procedures and Customizations

    Start HyperWorks Desktop and configure the applications.

  • Manage Files and Data

    Create, open, import, and save models.

  • Display Controls

    Control the view and display of your model in the modeling window.

  • Session Navigation

    Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.

  • Publish Sessions

    Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.

  • Parameterize Report Templates

    Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.

  • Workflow Automation

    Automate common workflows using the Process Manager.

  • HyperWorks Collaboration Tools

    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.

  • HyperWorks Reference Guides

    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

      Extensions are programs integrated with HyperWorks 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.

    • Tcl/Tk Commands

      The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.

      • Program with HyperWorks APIs for Beginners

        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.

      • Object Hierarchy

        Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, 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 HyperWorks Tcl/Tk Command Tutorials

        Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.

      • Tcl/Tk Commands

        Tcl/Tk classes for the following HyperWorks Desktop applications.

        • HyperWorks Desktop

        • MotionView

        • HyperView

          • Hotspot Finder API Structure

          • Upfront Data Loader 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

            • poIPart ApplyDefaults

              Sets the part material to default values.

            • poIPart GetAutoColor

              Gets the part auto color index.

            • poIPart GetColor

              Gets the part color index.

            • poIPart GetDefaultColor

              Gets the part default color index.

            • poIPart GetDisplayMode

              Gets the part display option setting.

            • poIPart GetDisplayModeList

              Gets the list of part display modes.

            • poIPart GetEulerAngles

              Gets the Euler angles with respect to the transform set by the call to poIModel SetRelativeTo.

            • poIPart GetID

              Gets the part's ID.

            • poIPart GetIDVisibility

              Gets the part's ID visibility.

            • poIPart GetLabel

              Gets the part's label.

            • poIPart GetLocator

              Gets the internal locator string for a part (for internal use only).

            • poIPart GetMaterial

              Gets the part material ID (zero if none assigned).

            • poIPart GetMaterialID

              Gets the ID of the material related to a component.

            • poIPart GetMaterialName

              Gets the name of the material related to a component.

            • poIPart GetMeshMode

              Gets the part's mesh mode.

            • poIPart GetOrientation

              Gets the orientation in the local coordinate system.

            • poIPart GetOrigin

              Gets the origin with respect to the transform set by the call to poIModel SetRelativeTo.

            • poIPart GetPartAssemblyID

              Gets the ID for the part assembly that contains a component.

            • poIPart GetParentID

              Gets the part's parent assembly ID.

            • poIPart GetPolygonMode

              Gets the part's polygon mode.

            • poIPart GetPool

              Gets the part's pool label.

            • poIPart GetPoolType

              Gets the part's pool type.

            • poIPart GetPosition

              Gets the position in the local coordinate system.

            • poIPart GetPropertyName

              Gets the ID for the property related to a component.

            • poIPart GetRelativeTo

              Gets the positions relative to the parent assembly, local or global.

            • poIPart GetScale

              Gets the scale factors for each coordinate axis.

            • poIPart GetShadeMode

              Gets the shading mode for a specific part and overrides the global setting that was set with poIRenderOptions GetShadeMode.

            • poIPart GetTracingMode

              Gets the part's tracing mode.

            • poIPart GetType

              Gets the part type's string.

            • poIPart GetVisibility

              Gets the part's visibility.

            • poIPart Rotate

              Rotates the part about the axis and angle.

            • poIPart SetAutoColor

              Sets the part's auto color index.

            • poIPart SetColor

              Sets the part's color index.

            • poIPart SetDefaultColor

              Sets the part default color index.

            • poIPart SetDisplayMode

              Sets the part's display mode.

            • poIPart SetEulerAngles

              Sets the Euler angles (Z-X-Z) with respect to the system defined by the call to poIModel SetRelativeTo.

            • poIPart SetIDVisibility

              Sets the part's ID visibility.

            • poIPart SetLabel

              Sets the part's label.

            • poIPart SetMaterial

              Sets the part's material index.

            • poIPart SetMeshMode

              Sets the part's mesh mode.

            • poIPart SetOrientation

              Sets the part's orientation in the local coordinate system by the given Euler angles ZXZ.

            • poIPart SetOrigin

              Sets the part origin in the local coordinate system by the given vector.

            • poIPart SetPolygonMode

              Sets the part's polygon mode.

            • poIPart SetPosition

              Sets the part position in the local coordinate system by the given vector.

            • poIPart SetRelativeTo

              Sets positions relative to the parent assembly, local or global.

            • poIPart SetScale

              Sets the part scale factors for each axis.

            • poIPart SetShadeMode

              Sets the shading mode. This command overrides the global setting that was set with poIRenderOptions SetShadeMode.

            • poIPart SetTracingMode

              Sets the part's tracing mode.

            • poIPart SetVisibility

              Sets the part's visibility.

          • 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.

    • HyperWorks Record and Playback

      Record playback workflows in HyperView.

    • HyperWorks Report

    • 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.

View All Altair Simulation Help

HyperWorks Desktop
HyperWorks Desktop

2022.3

  1. Home
  2. HyperWorks Reference Guides

    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.

  3. Tcl/Tk Commands

    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.

  4. Tcl/Tk Commands

    Tcl/Tk classes for the following HyperWorks Desktop applications.

  5. HyperView

  6. poIPart Class

  • What's New
  • Get Started
  • Tutorials
  • Startup Procedures and Customizations
  • Manage Files and Data
  • Display Controls
  • Session Navigation
  • Publish Sessions
  • Parameterize Report Templates
  • Workflow Automation
  • HyperWorks Collaboration Tools
  • HyperWorks Reference Guides
Index

poIPart Class

Note: See Entity Attributes and Component View in the HyperView User's Guide for additional information.
  • poIPart ApplyDefaults
    Sets the part material to default values.
  • poIPart GetAutoColor
    Gets the part auto color index.
  • poIPart GetColor
    Gets the part color index.
  • poIPart GetDefaultColor
    Gets the part default color index.
  • poIPart GetDisplayMode
    Gets the part display option setting.
  • poIPart GetDisplayModeList
    Gets the list of part display modes.
  • poIPart GetEulerAngles
    Gets the Euler angles with respect to the transform set by the call to poIModel SetRelativeTo.
  • poIPart GetID
    Gets the part's ID.
  • poIPart GetIDVisibility
    Gets the part's ID visibility.
  • poIPart GetLabel
    Gets the part's label.
  • poIPart GetLocator
    Gets the internal locator string for a part (for internal use only).
  • poIPart GetMaterial
    Gets the part material ID (zero if none assigned).
  • poIPart GetMaterialID
    Gets the ID of the material related to a component.
  • poIPart GetMaterialName
    Gets the name of the material related to a component.
  • poIPart GetMeshMode
    Gets the part's mesh mode.
  • poIPart GetOrientation
    Gets the orientation in the local coordinate system.
  • poIPart GetOrigin
    Gets the origin with respect to the transform set by the call to poIModel SetRelativeTo.
  • poIPart GetPartAssemblyID
    Gets the ID for the part assembly that contains a component.
  • poIPart GetParentID
    Gets the part's parent assembly ID.
  • poIPart GetPolygonMode
    Gets the part's polygon mode.
  • poIPart GetPool
    Gets the part's pool label.
  • poIPart GetPoolType
    Gets the part's pool type.
  • poIPart GetPosition
    Gets the position in the local coordinate system.
  • poIPart GetPropertyName
    Gets the ID for the property related to a component.
  • poIPart GetRelativeTo
    Gets the positions relative to the parent assembly, local or global.
  • poIPart GetScale
    Gets the scale factors for each coordinate axis.
  • poIPart GetShadeMode
    Gets the shading mode for a specific part and overrides the global setting that was set with poIRenderOptions GetShadeMode.
  • poIPart GetTracingMode
    Gets the part's tracing mode.
  • poIPart GetType
    Gets the part type's string.
  • poIPart GetVisibility
    Gets the part's visibility.
  • poIPart Rotate
    Rotates the part about the axis and angle.
  • poIPart SetAutoColor
    Sets the part's auto color index.
  • poIPart SetColor
    Sets the part's color index.
  • poIPart SetDefaultColor
    Sets the part default color index.
  • poIPart SetDisplayMode
    Sets the part's display mode.
  • poIPart SetEulerAngles
    Sets the Euler angles (Z-X-Z) with respect to the system defined by the call to poIModel SetRelativeTo.
  • poIPart SetIDVisibility
    Sets the part's ID visibility.
  • poIPart SetLabel
    Sets the part's label.
  • poIPart SetMaterial
    Sets the part's material index.
  • poIPart SetMeshMode
    Sets the part's mesh mode.
  • poIPart SetOrientation
    Sets the part's orientation in the local coordinate system by the given Euler angles ZXZ.
  • poIPart SetOrigin
    Sets the part origin in the local coordinate system by the given vector.
  • poIPart SetPolygonMode
    Sets the part's polygon mode.
  • poIPart SetPosition
    Sets the part position in the local coordinate system by the given vector.
  • poIPart SetRelativeTo
    Sets positions relative to the parent assembly, local or global.
  • poIPart SetScale
    Sets the part scale factors for each axis.
  • poIPart SetShadeMode
    Sets the shading mode. This command overrides the global setting that was set with poIRenderOptions SetShadeMode.
  • poIPart SetTracingMode
    Sets the part's tracing mode.
  • poIPart SetVisibility
    Sets the part's visibility.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent