HyperWorks Desktop

2021

Home
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Customization
There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
Preference Files
A preference file is an ASCII file that configures the application or its clients. It specifies default user settings, such as the order in which colors are assigned, the default printer and default page layout.
Preference File Statements

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 Desktop Reference Guides

Index

2021

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.
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.
- Start HyperWorks Desktop Applications
  Learn how to start HyperWorks Desktop applications on Windows and Linux.
- Start HyperMesh Batch
  HyperMesh Batch is a non-graphical version of HyperMesh that can be used to run command files or Tcl scripts in batch mode.
- Start-in Directory
  The start-in directory is the location from which the HyperWorks Desktop application is launched.
- Settings Files
  HyperWorks Desktop writes several different settings files.
- Customization
  There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
  - hmcustom.tcl
    HyperMesh allows you to create a script file named hmcustom.tcl that can be used to automatically execute a series of commands or to define custom settings during startup.
  - Environment Variables
    Environment variables can be defined to configure various aspects of HyperWorks Desktop.
  - hm.cfg
  - Preference Files
    A preference file is an ASCII file that configures the application or its clients. It specifies default user settings, such as the order in which colors are assigned, the default printer and default page layout.
    - Preference File Location
      On PC, when the application starts, it first reads the preference file in the installation directory, then the preference environment variable (HW_CONFIG_PATH). On Unix, the program first reads the preference file in your home directory, then the current working directory.
    - Preference File Structure
      Preference files always begins with the *Id() statement followed by statements grouped in blocks.
    - Preference File Loading
      When the program is started it checks for Templex statements in the preference file. If any Templex statements are found, they are evaluated prior to executing the preference statements.
    - Preference File Sample
    - Defining and Registering a Custom DLL to Export Curves
      Through the preference file *RegisterExportDLL(), you can register a DLL for use in exporting curves. The statement is found within the *BeginPlotDefaults() block in the preferences file.
    - Preference File Statements
      - Preference File Syntax
        Every statement in a script begins with an asterisk, *. Lines without asterisks are treated as comments.
      - Shared Preference File Statements
      - HyperGraph 2D Preference File Statements
      - HyperGraph 3D Preference File Statements
      - HyperView Preference File Statements
      - HyperStudy Preference File Statements
      - MediaView Preference File Statements
      - MotionView Preference File Statements
      - TextView Preference File Statements
      - *Add2DSymbolStyle()
        Loads a bitmap file for use as a 2D symbol.
      - *Add3DSymbolStyle()
        Loads any finite element model that can be displayed in HyperView and uses it as a 3D symbol.
      - *AddExportFormat()
        Adds the given format to the list of available export formats.
      - *AddPaperSize()
        Adds the given paper size to the list of available paper sizes.
      - *AddPrinter()
        Adds a printer to the dialog list.
      - *AdvancedReport()
        Adds additional parameters when saving a session as a report template.
      - *Alignment()
        Specifies the position of text in a header or footer region.
      - *AutoDefaultCurves()
        Specifies whether to automatically default new curves to be the same as the previous curve loaded from an external file.
      - *BackgroundColor()
        Specifies the background color for TextView.
      - *BeginBrowserContextMenu()
        Defines a submenu for the context menu in the Session Browser.
      - *BeginColumn()
        Begins a header or footer column block in the preferences file.
      - *BeginContextMenu()
        Begins a context menu block in the preferences file.
      - *BeginDefaults()
        Indicates the beginning of the default settings block.
      - *BeginDefinitions()
        Begins a definitions block in the preferences file.
      - *BeginExternalOptimizerDefaults()
        Indicates the beginning of the definition of the HyperStudy external optimizer block.
      - *BeginFepreDefaults()
        Indicates the beginning of the fe-pre default invoke settings.
      - *BeginFLD()
        Indicates the beginning of an FLD attribute block.
      - *BeginFooter()
        Indicates the beginning of a page footer block in a preferences file.
      - *BeginGraphicDefaults()
        Indicates the beginning of the graphics preferences block.
      - *BeginHeader()
        Indicates the beginning of a page header block in a preferences file.
      - *BeginInterpreter()
        Indicates the beginning of an interpreter block.
      - *BeginLibraryManagement()
        Begins a library management block in the preferences file.
      - *BeginMdlDefaults()
        Indicates the beginning of an MDL preferences block.
      - *BeginMenu()
        Indicates the beginning of a menu block.
      - *BeginModelDefaults()
        Indicates the beginning of the model preferences block.
      - *BeginModelGUIDefaults()
        Indicates the beginning of a model GUI defaults block.
      - *BeginPalette()
        Begins a palette block in the preferences file.
      - *BeginPlot3DDefaults()
        Begins the HyperGraph 3D-specific defaults block in the preferences file.
      - *BeginPlotDefaults()
        Indicates the beginning of the plot preferences block.
      - *BeginPlotMacros()
        Indicates the beginning of a plot macros block.
      - *BeginProfiles()
      - *BeginReaderDefaults()
        Indicates the beginning of the reader default preferences block.
      - *BeginRegion()
        Indicates the beginning of a header or footer region.
      - *BeginReports()
        Begins a reports block in the preferences file.
      - *BeginResources()
        Indicates the beginning of the general resource block.
      - *BeginSolverDefaults()
        Indicates the beginning of the definition of the HyperStudy solver block.
      - *BeginStatsTemplates()
        Begins a statistics templates block in the preferences file.
      - *BeginStudyDefaults()
        Indicates the beginning of the study preferences block.
      - *BeginTemplexFunction()
        Indicates the beginning of a Templex function.
      - *BeginTemplexFunctions()
        Indicates the beginning of a Templex functions block.
      - *BeginText()
        Indicates the beginning of a text block.
      - *BeginTextEditorDefaults()
        Indicates the beginning of a text editor preferences block.
      - *BeginToolbar()
        Specifies the list of toolbar icons to be displayed when HyperView is invoked.
      - *BeginUserMode()
        Indicates the beginning of a model user mode block.
      - *BeginUserUtilityDefaults()
        Indicates the beginning of the definition of the HyperStudy utilities block.
      - *BeginVideoDefaults()
        Indicates the beginning of the video preferences block.
      - *BorderWidth()
        Defines the region border in a header or footer.
      - *BrowserContextMenuItem()
        Creates a new, user-defined context menu item in the Session Browser that links selected items to Tcl scripts.
      - *CachePalette()
        Attempts to accelerate the process which converts AMF files using JPEG frame storage to a faster internal format.
      - *ClosestTimeSync()
        By default, displays the closest frame for the current time step for all windows on the current page.
      - *ContextMenuItem()
        Right-click on an entity to create a new, user-defined context menu item that launches a Tcl procedure.
      - *ContextMenuSeparator()
        Adds a separator to a context menu.
      - *ContourAverageAcrossParts()
        Specifies the "Average across part boundary" setting in the the Contour panel when a model is loaded.
      - *ContourAveragingMethod()
        Specifies the averaging method to be set in the Contour panel when a model is loaded.
      - *ContourAverageVariation()
        Specifies the averaging variation factor value to be set in the Contour panel when a model is loaded.
      - *ContourCornerDataRequested()
        Specifies the state of the Use corner data option in the Contour panel when a model is loaded.
      - *ContourMultiplier()
        Specifies the multiplication factor used to scale the displayed results.
      - *ContourResultComponent()
        Specifies the result component to be set in the Contour panel when a model is loaded.
      - *ContourResultType()
        Specifies the result type to be set in the Contour panel when a model is loaded.
      - *ContourShowMidsideNodeResults()
        Specifies the state of the "Show Midside Node" results in the the Contour panel when a model is loaded.
      - *ConverterOutputSettings()
        Specifies settings for an external converter.
      - *DABEnabled()
        Specifies the "display acceleration block" (DAB) setting in the Tools > Options > Performance dialog.
      - *DefaultFileAccessFromWorkingDirectory()
        When the application is launched, this statement specifies the state of default directory location for file browser.
      - *DefaultLegendEntityVisibility()
        Specifies whether legend entities should be shown or hidden by default.
      - *DefaultMaxFrameRate()
        Specifies the default setting for the Max Frame Rate slider in the Animation Controls panel.
      - *DefaultMouseSettings()
        Specifies the default mouse control settings for HyperView
      - *DefaultNumPoints()
        Specifies the number of points on the Stress Characterization Line (SCL).
      - *DefaultPostContourLegendFile()
        Sets the default legend for the contour plot.
      - *DefaultPostFLDZoneLegendFile()
        Sets the default legend for the contour plot.
      - *DefaultPostTensorLegendFile()
        Sets the default legend for the tensor plot.
      - *DefaultPostVectorLegendFile()
        Sets the default legend for the vector plot.
      - *DefaultResultMathTemplate()
        Sets the default template for result math operations.
      - *DefaultSignedVonMisesLegend()
        Specifies the color scheme that will be applied to a SignedVonMises contour legend.
      - *DefineNumericFormat()
        Given the value range, specifies the numeric format used for float results in 'Auto' mode.
      - *DeformedScaleFactor()
        Specifies the scale factor to be applied to the axes, as set in the Deformed panel.
      - *Disable3DGraphicsOutput()
        Disables 3D graphics output.
      - *DisableDirectShow()
        Specifies whether or not DirectShow should be disabled.
      - *DisableUnitScaling()
        Disables the unit scaling feature in HyperGraph 2D.
      - *ElementMarkEnabled()
        Specifies the check box setting of the Enable element marks option in the Tools > Options > Visualization dialog.
      - *EnableLegendLayoutScaling()
        Specifies whether or not layout scaling for the legend is enabled.
      - *EnableTemplexCurveNames()
        Enables or disables the generation of Templex curve names in the Build Plots panel.
      - *EndBrowserContextMenu()
        Ends a browser context menu block in the preferences file.
      - *EndColumn()
        Ends a header or footer column block in the preferences file.
      - *EndContextMenu()
        Ends a context menu block in the preferences file.
      - *EndDefaults()
        Indicates the end of the default settings.
      - *EndDefinitions()
        Ends a definitions block in the preferences file.
      - *EndExternalOptimizerDefaults()
        Indicates the end of the definition of the HyperStudy external optimizer block.
      - *EndFepreDefaults()
        Indicates the end of the fe-pre default invoke settings.
      - *EndFLD()
        Indicates the end of an FLD attribute block.
      - *EndFooter()
        Indicates the end of a page footer block in a preferences file.
      - *EndGraphicDefaults()
        Indicates the end of the graphic defaults block.
      - *EndHeader()
        Indicates the end of a page header block in a preferences file.
      - *EndInterpreter()
        Indicates the end of an interpreter block.
      - *EndLibraryManagement()
        Ends a library management block in the preferences file.
      - *EndMdlDefaults()
        Indicates the end of an MDL preferences block.
      - *EndMenu()
        Specifies the end of a menu block.
      - *EndModelDefaults()
        Indicates the end of a model defaults block.
      - *EndModelGUIDefaults()
        Indicates the end of a model GUI defaults block.
      - *EndPalette()
        Ends a palette block in the preferences file.
      - *EndPlot3DDefaults()
        Ends the HyperGraph 3D-specific defaults block in the preferences file.
      - *EndPlotDefaults()
        Indicates the end of the plot defaults block.
      - *EndPlotMacros()
        Indicates the end of a plot macros block.
      - *EndProfiles()
        Terminates the block started by *BeginProfiles().
      - *EndReaderDefaults()
        Indicates the end of the reader default preferences block.
      - *EndRegion()
        Indicates the end of a region block for a header or footer.
      - *EndReports()
        Ends a reports block in the preferences file.
      - *EndResources()
        Indicates the end of the general resource block.
      - *EndSolverDefaults()
        Indicates the end of the definition of the HyperStudy solver block.
      - *EndStatsTemplates()
        Ends a statistics templates block in the preferences file.
      - *EndStudyDefaults()
        Indicates the end of the study preferences block.
      - *EndTemplexFunction()
        Indicates the end of a templex function.
      - *EndTemplexFunctions()
        Indicates the end of a templex functions block.
      - *EndTextEditorDefaults()
        Specifies the end of a text editor defaults block.
      - *EndUserMode()
        Indicates the end of an MDL user mode block.
      - *EndUserUtilityDefaults()
        Indicates the end of the definition of the HyperStudy utilities block.
      - *EndVideoDefaults()
        Indicates the end of the video defaults block.
      - *EnvelopeCategoryLabel()
        Specifies whether to display the filename in the envelope subcase/simulation trace plot category legend.
      - *ExternalConverter()
        Specifies an external converter to be used.
      - *ExternalDecoder()
        Specifies an external decoder to be used.
      - *ExternalEncoder()
        Specifies an external encoder to be used.
      - *FLDDisplay()
        Specifies the legend type to be set in the FLD panel.
      - *FLDFitCurveFLC()
        Specifies the check box setting on the Fit curve (FLC) option in the FLD panel.
      - *Font()
        Specifies the font type, weight, style, and size of text for page headers and footers, and the text editor.
      - *Force()
        Specifies default display settings for forces.
      - *GroupDrawSize()
        Specifies the thickness of the entities in a group.
      - *GroupDrawStyle()
        Specifies the draw style for a group.
      - *GroupIDVisibility()
        Specifies whether or not the IDs in a group are visible.
      - *HeadType()
        Specifies how the heads of tensors will be drawn on a Tensor plot.
      - *Hide()
        Specifies tools to be turned off on the toolbar and pull-down menus.
      - *Hst_Precision()
        Personal setting in HyperStudy used to manipulate, read, and write numbers.
      - *Id()
        Indicates the start of a preference file and the release version of the program.
      - *Image()
        Adds an image to a page header or footer.
      - *IncrementBy()
        Specifies the setting on the Increment by option in the Animation Controls panel.
      - *InterpolationScaleFactor()
        Specifies the interpolation scale factor for the axes.
      - *InterpolationScaleMode()
        Specifies the interpolation scale mode for the axes.
      - *IsoShowMidsideNodeResults()
        Specifies the state of the "Show Midside Node" results in the the Iso panel when a model is loaded.
      - *Location()
        Specifies the location of the plot legend.
      - *Marker()
        Specifies the default display settings for markers.
      - *MeasureOptions()
        Specifies the measure options to be set in the Measure panel.
      - *MeasureType()
        Specifies the measure type to be set in the Measure panel.
      - *MenuItem()
        Creates a user-defined menu item.
      - *MessageLogGrouping()
        Controls client-specific groupings for posting messages into the Message Log.
      - *MinMax()
        Saves and restores the current minimum and maximum values of a displayed legend.
      - *ModelInfoDefaults()
        Sets the default settings for the Model Info (displayed in the top right corner of the of the graphics area).
      - *ModelInfoVisibility()
        Specifies the setting of the default model note display status on the graphics window when a model is loaded.
      - *NoteAnchorToScreen()
        Specifies the Anchor to screen setting in the Note panel when a new note is added to the loaded model.
      - *NoteAttachment()
        Specifies the attachment type to be set in the Note panel.
      - *NoteBackGroundColor()
        Specifies the note background color setting in the Note panel when a new note is added to the loaded model.
      - *NoteBorderThickness()
        Specifies the note border thickness setting in the Note panel when a new note is added to the loaded model.
      - *NoteDescription()
        Specifies the default description text when a new note is added to the loaded model.
      - *NoteFont()
        Specifies the note font setting (family, weight, slant, and size) for the HyperView notes being drawn in the graphics window.
      - *NoteForeGroundColor()
        Specifies the note foreground color setting in the Note panel when a new note is added to the loaded model.
      - *NoteShape()
        Specifies the default note shape when a new note is added to the loaded model.
      - *NoteTextAlignment()
        Specifies the setting on the Align text option in the Note panel when a new note is added to the loaded model.
      - *NoteTransparency()
        Specifies the Transparency setting in the Note panel when a new note is added to the loaded model.
      - *NumStepsToTrace()
        Specifies the default number of latent timesteps displayed behind traced entities.
      - *Object()
        Specifies primitive attributes.
      - *Optimization_Interactive_Execute()
        Sets the default to execute a OPT study in interactive or batch mode.
      - *Part()
        Specifies default part attributes such as part name, color, and visibility.
      - *PlotFooterColor()
        Defines the default text color for the plot footer.
      - *PlotHeaderColor()
        Defines the default text color for the plot header.
      - *PostScriptIdentifier()
        Specifies a postscript identifier.
      - *PrintAreaBorders()
        Specifies whether window borders are drawn when printing.
      - *PrintDisplayedBGColor()
        Specifies whether to use white or the displayed background color when printing plots in color.
      - *Recompress()
        Converts AMF files using JPEG-based frame compression to a faster playing internal video format.
      - *RegisterAssemblyWizardFile()
        Specifies the file to use as the assembly wizard file when you choose to set the wizard paths to those in the preference file.
      - *RegisterCtrlKeyProcedure()
        Assigns Tcl procedures to keyboard letter keys.
      - *RegisterCustomWizard()
        Adds a custom wizard defined in a preference file to a MotionView session.
      - *RegisterDefaultSolver()
        Sets the default option in the Solvers menu in the MotionView window.
      - *RegisterDirectReader()
        Registers a model/result reader for use by the Animation client during a HyperWorks session.
      - *RegisterExportDLL()
        Registers a DLL for use in exporting curves.
      - *RegisterExportTemplate()
        Adds new curve export formats to the list of existing formats.
      - *RegisterExternalColumnReader()
        Registers the specified external column reader.
      - *RegisterExternalDLLFunction()
        Registers a MATLAB function in a library compiled with MATLAB Compiler version 4 or later.
      - *RegisterExternalFunction()
        Adds external math functions to the program.
      - *RegisterExternalOptimizer()
        Adds new external optimizer to HyperStudy.
      - *RegisterExternalReader()
        Specifies an external reader for reading plot data.
      - *RegisterFunctionKeyProcedure()
        Assigns Tcl procedures to function keys.
      - *RegisterHMATHFunction()
        Registers a HyperMath HML file in the HyperWorks preferences file. This allows the HyperMath functions in the file to be available in HyperWorks Desktop, similar to the internal HyperWorks Desktop math functions.
      - *RegisterHMATHReader()
        Registers a HyperMath reader with the specified characteristics/attributes.
      - *RegisterImportTemplate()
        Specifies an import template for reading plot data.
      - *RegisterMdlStdIncFile()
        Specifies the file to use as the standard include file when you choose to set the wizard paths to those in the preference file.
      - *RegisterProfile()
        Loads profile definitions into HyperStudy.
      - *RegisterPythonFunction()
        Registers a Python function.
      - *RegisterReportsLog()
        Registers the log file for the reports that are listed when View Reports is selected from the Analysis menu in the MotionView window.
      - *RegisterResultMathPlugin()
        Defines a plug-in based operator, which is available through the Expression Builder under the plug-in library.
      - *RegisterResultMathTemplate()
        Registers a result math template.
      - *RegisterSharedReader()
        Registers a reader for HyperGraph or HyperView.
      - *RegisterSolver()
        Registers a solver in the MotionView window.
      - *RegisterSolverScript() - HyperStudy
        Adds new solver script to HyperStudy.
      - *RegisterSolverScript()
        Adds a new solver invoke script to the Run Solver option in MotionView.
      - *RegisterTaskWizardFile()
        Specifies the file to use as the task wizard file when you choose to set the wizard paths to those in the preference file.
      - *RegisterTemplexFunction()
        Adds Templex functions from a file to a session.
      - *RegisterUserUtility()
        Adds new user utility to HyperStudy.
      - *RegisterWizardLibDir()
        Specifies which directory will contain the wizard library files when you choose to set the wizard paths to those in the preference file.
      - *ResetCurveDefaults()
        Resets the curve defaults.
      - *ResultCacheMemoryConfig()
        Modifies memory usage by the Result Data Manager software.
      - *ResultMathState()
        Enables or disables the result math capabilities.
      - *SectionGridLineVisibility()
        Specifies whether or not section grid lines should be visible.
      - *SectionGridTextVisibility()
        Specifies whether or not the section grid text should be visible.
      - *Separator()
        Creates a separator in a user-defined menu.
      - *SetAnimBubbleColor()
        Specifies the color of the animation bubble on plots.
      - *SetAutoSaveInterval()
        Specifies how often the program automatically backs up your current work session.
      - *SetAVIFormat()
        Specifies the size and color range of images written to AVI files.
      - *SetAxisColor()
        Specifies the default color for x and y plot axes.
      - *SetAxisDefaults()
        Specifies default axis settings such as type and number of tics.
      - *SetAxisLabelFont()
        Specifies the font type, weight, style, and size for the axis of a plot.
      - *SetAxisTicFont()
        Specifies the font type, weight, style, and size for the axis tic mark labels of a plot.
      - *SetBackgroundColor()
        Sets the background color specified in the Options panel for plot or graphics windows.
      - *SetBarDefaults()
        Specifies the default bar color and bar pattern in the Bar Charts module.
      - *SetBorderColor()
        Specifies the default border color for plot windows.
      - *SetBrowserExtension()
        Specifies the file browser default extension for graphics, plot, and text editor files.
      - *SetBubbleHelpStatus()
        Specifies whether bubble help is on or off.
      - *SetCurveDataLineLength()
        Specifies the length of a line of data points when saved with the Save all curve data to file option.
      - *SetCurveDefaults()
        Specifies default curve attributes such as line style, symbol style, and color.
      - *SetDatumLineColor()
        Specifies the datum line color.
      - *SetDefaultPageLayout()
        Specifies the default window arrangement.
      - *SetDefaultPageTitleFont()
        Specifies the default font for page titles.
      - *SetDefaultPrinterOrientation()
        Specifies the default orientation of the printout on the paper.
      - *SetDefaultPrintGraphics()
        Specifies whether the default print graphics should be polygonal or bitmapped.
      - *SetDefaultPrintMargins()
        Specifies the width of the left, right, top, and bottom margins.
      - *SetDefaultPrintPageSize()
        Sets the default paper size to be used when printing.
      - *SetDefaultPrintQuality()
        Specifies whether the default print quality should be draft, normal, or high.
      - *SetDefaultPrintRange()
        Specifies the pages to print by default.
      - *SetDefaultPrintStyle()
        Specifies either black and white or color output.
      - *SetDefaultPSFile()
        Specifies the default Encapsulated PostScript (EPS) filename for printing to a file.
      - *SetDefaultPSPrinter()
        Specifies the default PostScript printer.
      - *SetFileOn()
        Sets a flag that indicates if the filename is displayed, as specified in the Options panel.
      - *SetFooterColor()
        Specifies the default color of text in plot footers.
      - *SetForegroundColor()
        Sets the foreground color as specified in the Options panel.
      - *SetFrameColor()
        Specifies the default frame color for plots.
      - *SetFrameOn()
        Sets a flag that indicates if the frame number is displayed as specified in the Options panel.
      - *SetFunctionUnitExpectation()
        Sets the expected units for each unit-dependent parameter of the given function.
      - *SetFunctionUnitPolicy()
        Defines the units to be used for a specific Templex function.
      - *SetGradiantType()
        Specifies the gradient type.
      - *SetGridlineColor()
        Specifies the default color of plot gridlines in a plot window.
      - *SetHeaderColor()
        Specifies the default color of text in plot headers.
      - *SetImplicitGraphicDefault()
        Sets the default state of the MDL model's implicit graphics.
      - *SetLegendColor()
        Defines the default color for the legend border.
      - *SetLegendFont()
        Specifies the default font for the legend in a plot window.
      - *SetLegendPlacement()
        Specifies the default legend position in a plot window.
      - *SetMemoryWaterMark()
        Specifies the upper and lower values for the memory watermark.
      - *SetNoteAlignment()
        Specifies the default text alignment for notes.
      - *SetNoteAttachment()
        Specifies the default attachment for notes in plot windows.
      - *SetNoteColor()
        Specifies the default color of note text for plots.
      - *SetNoteFont()
        Specifies the font type, weight, style, and size for note text in plots.
      - *SetNoteFontSize()
        Specifies the font size for notes.
      - *SetOrientation()
        Specifies the model orientation for graphics windows.
      - *SetPartColorList()
        Specifies a list of colors to be applied to parts when a model is loaded.
      - *SetPrecision()
        Sets the number of digits to the right of the decimal that are written to solver deck.
      - *SetPreloadMaximum()
        Specifies the maximum file size for loading the entire plot file into memory.
      - *SetPrimaryFooterFont()
        Specifies the font type, weight, style, and size for the first line of the plot footer.
      - *SetPrimaryHeaderFont()
        Specifies the font type, weight, style, and size for the first line of the plot header.
      - *SetPrinterCommand()
        Specifies a printer command.
      - *SetPrintLegendFontSize()
        Specifies the font size for legends while printing.
      - *SetPrintLineThickness()
        Specifies the default printed line thickness for curves.
      - *SetReportAutoFit()
        Specifies whether or not autofit is on for reports.
      - *SetSecondaryFooterFont()
        Specifies the font type, weight, style, and size for the second line of the plot footer.
      - *SetSecondaryHeaderFont()
        Specifies the font type, weight, style, and size for the second line of the plot header.
      - *SetSinglePairCreateDefault()
        Indicates whether the default for an entity type being added is single or pair.
      - *SetTertiaryFooterFont()
        Specifies the font type, weight, style, and size for the third line and all lines thereafter in a plot footer.
      - *SetTertiaryHeaderFont()
        Specifies the font type, weight, style, and size for the third line and all lines thereafter in a plot header.
      - *SetThickLineLimit()
        Sets the point at which all curves are drawn with the thin line style.
      - *SetTimeOn()
        Sets a flag that indicates if the timestep is displayed, as specified in the Options panel.
      - *SetToleranceValue()
        Sets the value of the time tolerance specified in the Options panel. Checks the Time Tolerance checkbox if the value of the tolerance is nonzero.
      - *SetUserMode()
        Sets the default user mode.
      - *SetWaitBackground()
        Specifies an image to be used for the wait background.
      - *SetXAxisLabel()
        Specifies the default label for the primary x axis.
      - *SetYAxisLabel()
        Specifies the default label for the primary y axis.
      - *SetZAxisLabel()
        Specifies the default label for the primary z axis.
      - *SetZerolineColor()
        Specifies the color of the zero line in plots.
      - *ShowAsEvaluated()
        Designates whether or not a Templex text file should be shown in its evaluated form when the file is read.
      - *ShowMillisecondLegend()
        Specifies whether the millisecond legend should be hidden or shown.
      - *SGIRGB()
        Configures the animation recording and screen capture mechanism to produce SGI-specific bitmap files instead of JPEG files.
      - *SpringAsCylinderCoilCount()
        Specifies the coil count for a spring, which is to be represented as a cylinder.
      - *Stereo3DOptions()
        Controls the 3D options used while viewing models in the 3D stereoscopic mode.
      - *SyncToActiveWindow()
        Specifies whether syncing with the active window is on or off.
      - *TensorFont()
        Specifies the font properties for the tensor plot text.
      - *TensorShowMidsideNodeResults()
        Specifies the state of the "Show Midside Node" results in the the Tensor panel when a model is loaded.
      - *TensorShowPrefix()
        Specifies the state of the Principal Prefix, Normal Prefix, and Shear Prefix check boxes in the Tensor panel.
      - *TensorTextColor()
        Specifies the color to be used for the tensor plot text.
      - *Text()
        Specifies the content of page headers and page footers.
      - *TextColor()
        Specifies the color of text for page headers and footers, and TextView.
      - *timestep_precision()
        Specifies the number of significant figures to be used in the timestep.
      - *TrackingSetAlignWithGlobal()
        Specifies the default state of the "Align with Global" option in the Tracking panel.
      - *UseLegacyCategoryColor()
        Specifies the color scheme that a category-based legend will use.
      - *VectorFont()
        Specifies the font properties for the vector plot text.
      - *VectorShowPrefix()
        Specifies the state of the Prefix check boxes in the Vector panel.
      - *VectorTextColor()
        Specifies the color to be used for the vector plot text.
      - *View()
        Sets the view of the model to either one of the preset named views or to a specific view given by the 16 values used to set the 4x4 view matrix.
      - *WindowIDs()
        Indicates the IDS for the windows associated with a report parameter.
      - *ZAxisLabel()
        Specifies the label for the z axis.
      - 201 more
  - Session Files
    A session file is an ASCII text file that contains a structured list of session statements.
  - Report Templates
    Report templates are ASCII text files that contain statements for creating reports.
Manage Files and Data
Learn how to 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 or Automate tool.
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 Desktop 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.

View All Altair HyperWorks Help

HyperWorks Desktop

2021

Home
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Customization
There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
Preference Files
A preference file is an ASCII file that configures the application or its clients. It specifies default user settings, such as the order in which colors are assigned, the default printer and default page layout.
Preference File Statements

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 Desktop Reference Guides

Index

Preference File Statements

Preference File Syntax
Every statement in a script begins with an asterisk, *. Lines without asterisks are treated as comments.
Shared Preference File Statements
HyperGraph 2D Preference File Statements
HyperGraph 3D Preference File Statements
HyperView Preference File Statements
HyperStudy Preference File Statements
MediaView Preference File Statements
MotionView Preference File Statements
TextView Preference File Statements
*Add2DSymbolStyle()
Loads a bitmap file for use as a 2D symbol.
*Add3DSymbolStyle()
Loads any finite element model that can be displayed in HyperView and uses it as a 3D symbol.
*AddExportFormat()
Adds the given format to the list of available export formats.
*AddPaperSize()
Adds the given paper size to the list of available paper sizes.
*AddPrinter()
Adds a printer to the dialog list.
*AdvancedReport()
Adds additional parameters when saving a session as a report template.
*Alignment()
Specifies the position of text in a header or footer region.
*AutoDefaultCurves()
Specifies whether to automatically default new curves to be the same as the previous curve loaded from an external file.
*BackgroundColor()
Specifies the background color for TextView.
*BeginBrowserContextMenu()
Defines a submenu for the context menu in the Session Browser.
*BeginColumn()
Begins a header or footer column block in the preferences file.
*BeginContextMenu()
Begins a context menu block in the preferences file.
*BeginDefaults()
Indicates the beginning of the default settings block.
*BeginDefinitions()
Begins a definitions block in the preferences file.
*BeginExternalOptimizerDefaults()
Indicates the beginning of the definition of the HyperStudy external optimizer block.
*BeginFepreDefaults()
Indicates the beginning of the fe-pre default invoke settings.
*BeginFLD()
Indicates the beginning of an FLD attribute block.
*BeginFooter()
Indicates the beginning of a page footer block in a preferences file.
*BeginGraphicDefaults()
Indicates the beginning of the graphics preferences block.
*BeginHeader()
Indicates the beginning of a page header block in a preferences file.
*BeginInterpreter()
Indicates the beginning of an interpreter block.
*BeginLibraryManagement()
Begins a library management block in the preferences file.
*BeginMdlDefaults()
Indicates the beginning of an MDL preferences block.
*BeginMenu()
Indicates the beginning of a menu block.
*BeginModelDefaults()
Indicates the beginning of the model preferences block.
*BeginModelGUIDefaults()
Indicates the beginning of a model GUI defaults block.
*BeginPalette()
Begins a palette block in the preferences file.
*BeginPlot3DDefaults()
Begins the HyperGraph 3D-specific defaults block in the preferences file.
*BeginPlotDefaults()
Indicates the beginning of the plot preferences block.
*BeginPlotMacros()
Indicates the beginning of a plot macros block.
*BeginProfiles()
*BeginReaderDefaults()
Indicates the beginning of the reader default preferences block.
*BeginRegion()
Indicates the beginning of a header or footer region.
*BeginReports()
Begins a reports block in the preferences file.
*BeginResources()
Indicates the beginning of the general resource block.
*BeginSolverDefaults()
Indicates the beginning of the definition of the HyperStudy solver block.
*BeginStatsTemplates()
Begins a statistics templates block in the preferences file.
*BeginStudyDefaults()
Indicates the beginning of the study preferences block.
*BeginTemplexFunction()
Indicates the beginning of a Templex function.
*BeginTemplexFunctions()
Indicates the beginning of a Templex functions block.
*BeginText()
Indicates the beginning of a text block.
*BeginTextEditorDefaults()
Indicates the beginning of a text editor preferences block.
*BeginToolbar()
Specifies the list of toolbar icons to be displayed when HyperView is invoked.
*BeginUserMode()
Indicates the beginning of a model user mode block.
*BeginUserUtilityDefaults()
Indicates the beginning of the definition of the HyperStudy utilities block.
*BeginVideoDefaults()
Indicates the beginning of the video preferences block.
*BorderWidth()
Defines the region border in a header or footer.
*BrowserContextMenuItem()
Creates a new, user-defined context menu item in the Session Browser that links selected items to Tcl scripts.
*CachePalette()
Attempts to accelerate the process which converts AMF files using JPEG frame storage to a faster internal format.
*ClosestTimeSync()
By default, displays the closest frame for the current time step for all windows on the current page.
*ContextMenuItem()
Right-click on an entity to create a new, user-defined context menu item that launches a Tcl procedure.
*ContextMenuSeparator()
Adds a separator to a context menu.
*ContourAverageAcrossParts()
Specifies the "Average across part boundary" setting in the the Contour panel when a model is loaded.
*ContourAveragingMethod()
Specifies the averaging method to be set in the Contour panel when a model is loaded.
*ContourAverageVariation()
Specifies the averaging variation factor value to be set in the Contour panel when a model is loaded.
*ContourCornerDataRequested()
Specifies the state of the Use corner data option in the Contour panel when a model is loaded.
*ContourMultiplier()
Specifies the multiplication factor used to scale the displayed results.
*ContourResultComponent()
Specifies the result component to be set in the Contour panel when a model is loaded.
*ContourResultType()
Specifies the result type to be set in the Contour panel when a model is loaded.
*ContourShowMidsideNodeResults()
Specifies the state of the "Show Midside Node" results in the the Contour panel when a model is loaded.
*ConverterOutputSettings()
Specifies settings for an external converter.
*DABEnabled()
Specifies the "display acceleration block" (DAB) setting in the Tools > Options > Performance dialog.
*DefaultFileAccessFromWorkingDirectory()
When the application is launched, this statement specifies the state of default directory location for file browser.
*DefaultLegendEntityVisibility()
Specifies whether legend entities should be shown or hidden by default.
*DefaultMaxFrameRate()
Specifies the default setting for the Max Frame Rate slider in the Animation Controls panel.
*DefaultMouseSettings()
Specifies the default mouse control settings for HyperView
*DefaultNumPoints()
Specifies the number of points on the Stress Characterization Line (SCL).
*DefaultPostContourLegendFile()
Sets the default legend for the contour plot.
*DefaultPostFLDZoneLegendFile()
Sets the default legend for the contour plot.
*DefaultPostTensorLegendFile()
Sets the default legend for the tensor plot.
*DefaultPostVectorLegendFile()
Sets the default legend for the vector plot.
*DefaultResultMathTemplate()
Sets the default template for result math operations.
*DefaultSignedVonMisesLegend()
Specifies the color scheme that will be applied to a SignedVonMises contour legend.
*DefineNumericFormat()
Given the value range, specifies the numeric format used for float results in 'Auto' mode.
*DeformedScaleFactor()
Specifies the scale factor to be applied to the axes, as set in the Deformed panel.
*Disable3DGraphicsOutput()
Disables 3D graphics output.
*DisableDirectShow()
Specifies whether or not DirectShow should be disabled.
*DisableUnitScaling()
Disables the unit scaling feature in HyperGraph 2D.
*ElementMarkEnabled()
Specifies the check box setting of the Enable element marks option in the Tools > Options > Visualization dialog.
*EnableLegendLayoutScaling()
Specifies whether or not layout scaling for the legend is enabled.
*EnableTemplexCurveNames()
Enables or disables the generation of Templex curve names in the Build Plots panel.
*EndBrowserContextMenu()
Ends a browser context menu block in the preferences file.
*EndColumn()
Ends a header or footer column block in the preferences file.
*EndContextMenu()
Ends a context menu block in the preferences file.
*EndDefaults()
Indicates the end of the default settings.
*EndDefinitions()
Ends a definitions block in the preferences file.
*EndExternalOptimizerDefaults()
Indicates the end of the definition of the HyperStudy external optimizer block.
*EndFepreDefaults()
Indicates the end of the fe-pre default invoke settings.
*EndFLD()
Indicates the end of an FLD attribute block.
*EndFooter()
Indicates the end of a page footer block in a preferences file.
*EndGraphicDefaults()
Indicates the end of the graphic defaults block.
*EndHeader()
Indicates the end of a page header block in a preferences file.
*EndInterpreter()
Indicates the end of an interpreter block.
*EndLibraryManagement()
Ends a library management block in the preferences file.
*EndMdlDefaults()
Indicates the end of an MDL preferences block.
*EndMenu()
Specifies the end of a menu block.
*EndModelDefaults()
Indicates the end of a model defaults block.
*EndModelGUIDefaults()
Indicates the end of a model GUI defaults block.
*EndPalette()
Ends a palette block in the preferences file.
*EndPlot3DDefaults()
Ends the HyperGraph 3D-specific defaults block in the preferences file.
*EndPlotDefaults()
Indicates the end of the plot defaults block.
*EndPlotMacros()
Indicates the end of a plot macros block.
*EndProfiles()
Terminates the block started by *BeginProfiles().
*EndReaderDefaults()
Indicates the end of the reader default preferences block.
*EndRegion()
Indicates the end of a region block for a header or footer.
*EndReports()
Ends a reports block in the preferences file.
*EndResources()
Indicates the end of the general resource block.
*EndSolverDefaults()
Indicates the end of the definition of the HyperStudy solver block.
*EndStatsTemplates()
Ends a statistics templates block in the preferences file.
*EndStudyDefaults()
Indicates the end of the study preferences block.
*EndTemplexFunction()
Indicates the end of a templex function.
*EndTemplexFunctions()
Indicates the end of a templex functions block.
*EndTextEditorDefaults()
Specifies the end of a text editor defaults block.
*EndUserMode()
Indicates the end of an MDL user mode block.
*EndUserUtilityDefaults()
Indicates the end of the definition of the HyperStudy utilities block.
*EndVideoDefaults()
Indicates the end of the video defaults block.
*EnvelopeCategoryLabel()
Specifies whether to display the filename in the envelope subcase/simulation trace plot category legend.
*ExternalConverter()
Specifies an external converter to be used.
*ExternalDecoder()
Specifies an external decoder to be used.
*ExternalEncoder()
Specifies an external encoder to be used.
*FLDDisplay()
Specifies the legend type to be set in the FLD panel.
*FLDFitCurveFLC()
Specifies the check box setting on the Fit curve (FLC) option in the FLD panel.
*Font()
Specifies the font type, weight, style, and size of text for page headers and footers, and the text editor.
*Force()
Specifies default display settings for forces.
*GroupDrawSize()
Specifies the thickness of the entities in a group.
*GroupDrawStyle()
Specifies the draw style for a group.
*GroupIDVisibility()
Specifies whether or not the IDs in a group are visible.
*HeadType()
Specifies how the heads of tensors will be drawn on a Tensor plot.
*Hide()
Specifies tools to be turned off on the toolbar and pull-down menus.
*Hst_Precision()
Personal setting in HyperStudy used to manipulate, read, and write numbers.
*Id()
Indicates the start of a preference file and the release version of the program.
*Image()
Adds an image to a page header or footer.
*IncrementBy()
Specifies the setting on the Increment by option in the Animation Controls panel.
*InterpolationScaleFactor()
Specifies the interpolation scale factor for the axes.
*InterpolationScaleMode()
Specifies the interpolation scale mode for the axes.
*IsoShowMidsideNodeResults()
Specifies the state of the "Show Midside Node" results in the the Iso panel when a model is loaded.
*Location()
Specifies the location of the plot legend.
*Marker()
Specifies the default display settings for markers.
*MeasureOptions()
Specifies the measure options to be set in the Measure panel.
*MeasureType()
Specifies the measure type to be set in the Measure panel.
*MenuItem()
Creates a user-defined menu item.
*MessageLogGrouping()
Controls client-specific groupings for posting messages into the Message Log.
*MinMax()
Saves and restores the current minimum and maximum values of a displayed legend.
*ModelInfoDefaults()
Sets the default settings for the Model Info (displayed in the top right corner of the of the graphics area).
*ModelInfoVisibility()
Specifies the setting of the default model note display status on the graphics window when a model is loaded.
*NoteAnchorToScreen()
Specifies the Anchor to screen setting in the Note panel when a new note is added to the loaded model.
*NoteAttachment()
Specifies the attachment type to be set in the Note panel.
*NoteBackGroundColor()
Specifies the note background color setting in the Note panel when a new note is added to the loaded model.
*NoteBorderThickness()
Specifies the note border thickness setting in the Note panel when a new note is added to the loaded model.
*NoteDescription()
Specifies the default description text when a new note is added to the loaded model.
*NoteFont()
Specifies the note font setting (family, weight, slant, and size) for the HyperView notes being drawn in the graphics window.
*NoteForeGroundColor()
Specifies the note foreground color setting in the Note panel when a new note is added to the loaded model.
*NoteShape()
Specifies the default note shape when a new note is added to the loaded model.
*NoteTextAlignment()
Specifies the setting on the Align text option in the Note panel when a new note is added to the loaded model.
*NoteTransparency()
Specifies the Transparency setting in the Note panel when a new note is added to the loaded model.
*NumStepsToTrace()
Specifies the default number of latent timesteps displayed behind traced entities.
*Object()
Specifies primitive attributes.
*Optimization_Interactive_Execute()
Sets the default to execute a OPT study in interactive or batch mode.
*Part()
Specifies default part attributes such as part name, color, and visibility.
*PlotFooterColor()
Defines the default text color for the plot footer.
*PlotHeaderColor()
Defines the default text color for the plot header.
*PostScriptIdentifier()
Specifies a postscript identifier.
*PrintAreaBorders()
Specifies whether window borders are drawn when printing.
*PrintDisplayedBGColor()
Specifies whether to use white or the displayed background color when printing plots in color.
*Recompress()
Converts AMF files using JPEG-based frame compression to a faster playing internal video format.
*RegisterAssemblyWizardFile()
Specifies the file to use as the assembly wizard file when you choose to set the wizard paths to those in the preference file.
*RegisterCtrlKeyProcedure()
Assigns Tcl procedures to keyboard letter keys.
*RegisterCustomWizard()
Adds a custom wizard defined in a preference file to a MotionView session.
*RegisterDefaultSolver()
Sets the default option in the Solvers menu in the MotionView window.
*RegisterDirectReader()
Registers a model/result reader for use by the Animation client during a HyperWorks session.
*RegisterExportDLL()
Registers a DLL for use in exporting curves.
*RegisterExportTemplate()
Adds new curve export formats to the list of existing formats.
*RegisterExternalColumnReader()
Registers the specified external column reader.
*RegisterExternalDLLFunction()
Registers a MATLAB function in a library compiled with MATLAB Compiler version 4 or later.
*RegisterExternalFunction()
Adds external math functions to the program.
*RegisterExternalOptimizer()
Adds new external optimizer to HyperStudy.
*RegisterExternalReader()
Specifies an external reader for reading plot data.
*RegisterFunctionKeyProcedure()
Assigns Tcl procedures to function keys.
*RegisterHMATHFunction()
Registers a HyperMath HML file in the HyperWorks preferences file. This allows the HyperMath functions in the file to be available in HyperWorks Desktop, similar to the internal HyperWorks Desktop math functions.
*RegisterHMATHReader()
Registers a HyperMath reader with the specified characteristics/attributes.
*RegisterImportTemplate()
Specifies an import template for reading plot data.
*RegisterMdlStdIncFile()
Specifies the file to use as the standard include file when you choose to set the wizard paths to those in the preference file.
*RegisterProfile()
Loads profile definitions into HyperStudy.
*RegisterPythonFunction()
Registers a Python function.
*RegisterReportsLog()
Registers the log file for the reports that are listed when View Reports is selected from the Analysis menu in the MotionView window.
*RegisterResultMathPlugin()
Defines a plug-in based operator, which is available through the Expression Builder under the plug-in library.
*RegisterResultMathTemplate()
Registers a result math template.
*RegisterSharedReader()
Registers a reader for HyperGraph or HyperView.
*RegisterSolver()
Registers a solver in the MotionView window.
*RegisterSolverScript() - HyperStudy
Adds new solver script to HyperStudy.
*RegisterSolverScript()
Adds a new solver invoke script to the Run Solver option in MotionView.
*RegisterTaskWizardFile()
Specifies the file to use as the task wizard file when you choose to set the wizard paths to those in the preference file.
*RegisterTemplexFunction()
Adds Templex functions from a file to a session.
*RegisterUserUtility()
Adds new user utility to HyperStudy.
*RegisterWizardLibDir()
Specifies which directory will contain the wizard library files when you choose to set the wizard paths to those in the preference file.
*ResetCurveDefaults()
Resets the curve defaults.
*ResultCacheMemoryConfig()
Modifies memory usage by the Result Data Manager software.
*ResultMathState()
Enables or disables the result math capabilities.
*SectionGridLineVisibility()
Specifies whether or not section grid lines should be visible.
*SectionGridTextVisibility()
Specifies whether or not the section grid text should be visible.
*Separator()
Creates a separator in a user-defined menu.
*SetAnimBubbleColor()
Specifies the color of the animation bubble on plots.
*SetAutoSaveInterval()
Specifies how often the program automatically backs up your current work session.
*SetAVIFormat()
Specifies the size and color range of images written to AVI files.
*SetAxisColor()
Specifies the default color for x and y plot axes.
*SetAxisDefaults()
Specifies default axis settings such as type and number of tics.
*SetAxisLabelFont()
Specifies the font type, weight, style, and size for the axis of a plot.
*SetAxisTicFont()
Specifies the font type, weight, style, and size for the axis tic mark labels of a plot.
*SetBackgroundColor()
Sets the background color specified in the Options panel for plot or graphics windows.
*SetBarDefaults()
Specifies the default bar color and bar pattern in the Bar Charts module.
*SetBorderColor()
Specifies the default border color for plot windows.
*SetBrowserExtension()
Specifies the file browser default extension for graphics, plot, and text editor files.
*SetBubbleHelpStatus()
Specifies whether bubble help is on or off.
*SetCurveDataLineLength()
Specifies the length of a line of data points when saved with the Save all curve data to file option.
*SetCurveDefaults()
Specifies default curve attributes such as line style, symbol style, and color.
*SetDatumLineColor()
Specifies the datum line color.
*SetDefaultPageLayout()
Specifies the default window arrangement.
*SetDefaultPageTitleFont()
Specifies the default font for page titles.
*SetDefaultPrinterOrientation()
Specifies the default orientation of the printout on the paper.
*SetDefaultPrintGraphics()
Specifies whether the default print graphics should be polygonal or bitmapped.
*SetDefaultPrintMargins()
Specifies the width of the left, right, top, and bottom margins.
*SetDefaultPrintPageSize()
Sets the default paper size to be used when printing.
*SetDefaultPrintQuality()
Specifies whether the default print quality should be draft, normal, or high.
*SetDefaultPrintRange()
Specifies the pages to print by default.
*SetDefaultPrintStyle()
Specifies either black and white or color output.
*SetDefaultPSFile()
Specifies the default Encapsulated PostScript (EPS) filename for printing to a file.
*SetDefaultPSPrinter()
Specifies the default PostScript printer.
*SetFileOn()
Sets a flag that indicates if the filename is displayed, as specified in the Options panel.
*SetFooterColor()
Specifies the default color of text in plot footers.
*SetForegroundColor()
Sets the foreground color as specified in the Options panel.
*SetFrameColor()
Specifies the default frame color for plots.
*SetFrameOn()
Sets a flag that indicates if the frame number is displayed as specified in the Options panel.
*SetFunctionUnitExpectation()
Sets the expected units for each unit-dependent parameter of the given function.
*SetFunctionUnitPolicy()
Defines the units to be used for a specific Templex function.
*SetGradiantType()
Specifies the gradient type.
*SetGridlineColor()
Specifies the default color of plot gridlines in a plot window.
*SetHeaderColor()
Specifies the default color of text in plot headers.
*SetImplicitGraphicDefault()
Sets the default state of the MDL model's implicit graphics.
*SetLegendColor()
Defines the default color for the legend border.
*SetLegendFont()
Specifies the default font for the legend in a plot window.
*SetLegendPlacement()
Specifies the default legend position in a plot window.
*SetMemoryWaterMark()
Specifies the upper and lower values for the memory watermark.
*SetNoteAlignment()
Specifies the default text alignment for notes.
*SetNoteAttachment()
Specifies the default attachment for notes in plot windows.
*SetNoteColor()
Specifies the default color of note text for plots.
*SetNoteFont()
Specifies the font type, weight, style, and size for note text in plots.
*SetNoteFontSize()
Specifies the font size for notes.
*SetOrientation()
Specifies the model orientation for graphics windows.
*SetPartColorList()
Specifies a list of colors to be applied to parts when a model is loaded.
*SetPrecision()
Sets the number of digits to the right of the decimal that are written to solver deck.
*SetPreloadMaximum()
Specifies the maximum file size for loading the entire plot file into memory.
*SetPrimaryFooterFont()
Specifies the font type, weight, style, and size for the first line of the plot footer.
*SetPrimaryHeaderFont()
Specifies the font type, weight, style, and size for the first line of the plot header.
*SetPrinterCommand()
Specifies a printer command.
*SetPrintLegendFontSize()
Specifies the font size for legends while printing.
*SetPrintLineThickness()
Specifies the default printed line thickness for curves.
*SetReportAutoFit()
Specifies whether or not autofit is on for reports.
*SetSecondaryFooterFont()
Specifies the font type, weight, style, and size for the second line of the plot footer.
*SetSecondaryHeaderFont()
Specifies the font type, weight, style, and size for the second line of the plot header.
*SetSinglePairCreateDefault()
Indicates whether the default for an entity type being added is single or pair.
*SetTertiaryFooterFont()
Specifies the font type, weight, style, and size for the third line and all lines thereafter in a plot footer.
*SetTertiaryHeaderFont()
Specifies the font type, weight, style, and size for the third line and all lines thereafter in a plot header.
*SetThickLineLimit()
Sets the point at which all curves are drawn with the thin line style.
*SetTimeOn()
Sets a flag that indicates if the timestep is displayed, as specified in the Options panel.
*SetToleranceValue()
Sets the value of the time tolerance specified in the Options panel. Checks the Time Tolerance checkbox if the value of the tolerance is nonzero.
*SetUserMode()
Sets the default user mode.
*SetWaitBackground()
Specifies an image to be used for the wait background.
*SetXAxisLabel()
Specifies the default label for the primary x axis.
*SetYAxisLabel()
Specifies the default label for the primary y axis.
*SetZAxisLabel()
Specifies the default label for the primary z axis.
*SetZerolineColor()
Specifies the color of the zero line in plots.
*ShowAsEvaluated()
Designates whether or not a Templex text file should be shown in its evaluated form when the file is read.
*ShowMillisecondLegend()
Specifies whether the millisecond legend should be hidden or shown.
*SGIRGB()
Configures the animation recording and screen capture mechanism to produce SGI-specific bitmap files instead of JPEG files.
*SpringAsCylinderCoilCount()
Specifies the coil count for a spring, which is to be represented as a cylinder.
*Stereo3DOptions()
Controls the 3D options used while viewing models in the 3D stereoscopic mode.
*SyncToActiveWindow()
Specifies whether syncing with the active window is on or off.
*TensorFont()
Specifies the font properties for the tensor plot text.
*TensorShowMidsideNodeResults()
Specifies the state of the "Show Midside Node" results in the the Tensor panel when a model is loaded.
*TensorShowPrefix()
Specifies the state of the Principal Prefix, Normal Prefix, and Shear Prefix check boxes in the Tensor panel.
*TensorTextColor()
Specifies the color to be used for the tensor plot text.
*Text()
Specifies the content of page headers and page footers.
*TextColor()
Specifies the color of text for page headers and footers, and TextView.
*timestep_precision()
Specifies the number of significant figures to be used in the timestep.
*TrackingSetAlignWithGlobal()
Specifies the default state of the "Align with Global" option in the Tracking panel.
*UseLegacyCategoryColor()
Specifies the color scheme that a category-based legend will use.
*VectorFont()
Specifies the font properties for the vector plot text.
*VectorShowPrefix()
Specifies the state of the Prefix check boxes in the Vector panel.
*VectorTextColor()
Specifies the color to be used for the vector plot text.
*View()
Sets the view of the model to either one of the preset named views or to a specific view given by the 16 values used to set the 4x4 view matrix.
*WindowIDs()
Indicates the IDS for the windows associated with a report parameter.
*ZAxisLabel()
Specifies the label for the z axis.

Intellectual Property Rights Notice | Technical Support