<Interface>

Class defining the user interface for the extension.

Remarks

This interface element information pertains specifically to the GUI.

Examples

None.

Table 49: XML Tag Listing

Tag

<Callbacks>

No details provided.

Tag

<filter>

Defines one or more filters.

Callback

<GetLocalString>

Get the localized string.

Callback

<GetPostCommands>

Called to collect all "post" commands to add to the solver input file.

Callback

<GetPreCommands>

Called to collect all "pre" commands to add to the solver input file.

Callback

<GetSolveCommands>

Called to collect all "solve" commands to add to the solver input file.

Callback

<GetToolTips>

Collect the GUI Entries ToolTips.

Tag

<images>

Defines the default folder where images to be used by the extension are stored.

Callback

<IsAnalysisValid>

Called to know if an analysis is valid.

Callback

<OnActiveObjectChange>

Called when the active object change.

Callback

<OnAfterGeometryUpdate>

OnAfterGeometryUpdate.

Callback

<OnAfterObjectChanged>

Called when an object has been changed.

Callback

<OnAfterRemove>

OnAfterRemove.

Callback

<OnAfterSolve>

Called when an analysis has been solved.

Callback

<OnBeforeGeometryUpdate>

OnBeforeGeometryUpdate.

Callback

<OnBeforeSolve>

Called when an analysis starts to solve.

Callback

<OnBodySuppressStateChange>

Called when the body suppress state change.

Callback

<OnDraw>

Called when the application is drawn.

Callback

<OnDraw2D>

Called when the application is drawn.

Callback

<OnExternalModelImport>

Called when an external model is imported.

Callback

<OnInit>

Called when the given context is initialized.

Callback

<OnLoad>

Called when a project is loaded - invoked from non-Workbench products

Callback

<OnMeshCleaned>

Called when the mesh is cleaned.

Callback

<OnMeshGenerated>

Called when the mesh is generated.

Callback

<OnPostFinished>

Called when the post process end for a given analysis.

Callback

<OnPostStarted>

Called when the post process start for a given analysis.

Callback

<OnReady>

OnReady.

Callback

<OnSave>

Called when a project is saved - invoked from non-Workbench products

Callback

<OnTerminate>

Called when the given context is terminated.

Callback

<OnUnitsChanged>

OnUnitsChanged. Called when the unit system changes.

Callback

<Resume>

Called when a project is loaded. Usefull to retreive aditional data.

Callback

<Save>

Called when a project is saved. Usefull to save aditional data.

Tag

<toolbar>

Defines one or more toolbars.

Attribute

context=

Context or combination of contexts (separated using '|') for the interface.

Attribute

engineType=

Allows user to specify what scripting engine to use for the extensions. It defaults to IronPython but can be switched to CPython.

Attribute

liteAPI=

Specifies for what context or combinations of contexts (separated using '|') liteAPI should be invoked

Attribute

propertyEvents=

Specifies when property events should be invoked. This could be set to 'UI,' which means that property events are only invoked when changing properties from the UI. When set to 'All,' property events are invoked when properties are changed from UI and via scripting. Event firing is directly associated with the state an  application may end up. For example, if propertyEvents was set to 'UI,' and a property is changed via script, the application may not be in the correct/expected state after the property change is complete.