Controls several user interface components.
GSErrCode ACAPI_Interface ( API_InterfaceID code, void* par1 = nullptr, void* par2 = nullptr, void* par3 = nullptr, void* par4 = nullptr, void* par5 = nullptr );
Parameters
- code
- [in] Interface function identifier.
- par1
- [in/out] The parameter depends on the
code
parameter. - par2
- [in/out] The parameter depends on the
code
parameter. - par3
- [in/out] The parameter depends on the
code
parameter. - par4
- [in/out] The parameter depends on the
code
parameter. - par5
- [in/out] The parameter depends on the
code
parameter.
Return Values
NoError
- The interface function completed with success.
APIERR_BADID
- Invalid
code
parameter was passed.
More return values can be found at the description of each interface functions.
Remarks
This function collects all of the user interface control capability that can be used from an API tool add-on (except the DG functionality).
The type of the interface function is specified with the code
parameter.
Description
Menu items
Returns the flag values of a specified menu item.
Sets the flag values of a specified menu item.
Returns the text of a specified menu item.
Sets the text of a specified menu item.
Sets the text of a specified menu item that will appear in the Work Environment dialog.
Process Window
Opens the process window.
Closes the process window.
Starts the next process phase in the process window.
Sets the value of the progress bar.
Increases the value of the progress bar.
Checks for user breaks during long processes.
Returns whether the process window will appear.
Turns the process window on/off.
User input
Initializes the neig filter for an input.
Sets one of the neig types to be filtered.
Sets one of the neig types not to be filtered.
Performs a point input.
Performs a line input.
Performs an arc input.
Performs a polygon input.
Draws graphical feedback during an input process.
Draws graphical feedback during an input process.
Opens a pet palette for the add-on.
Finishes the user input.
Cancels the user input.
Sets the default callback procedures for user controls.
Brings up the Object/Lamp/Window/Door Settings dialog.
Opens any Settings dialog.
Sets the drawing constraint for graphical user input.
Dissolves the drawing constraint.
File dialogs
Opens a Library Part file saving dialog window.
Cutting Planes
Returns whether the 3DCutaway is enabled.
Turns the 3DCutaway on/off.
Returns whether the Cutting Planes are visible.
Shows or hides the Cutting Planes.
Requirements
- Version: API 2.1 or later
- Header: ACAPinc.h