Drafting Triggers

Init Drafting Pre-Trigger

Event:

Every time a Drafting based program is started.

Type:

Pre

Name:

trig_draft_init

Input Parameters:

None

Allowed return values:

kcs_util.trigger_ok()

kcs_util.trigger_abort()

Override functionality:

None.

Notes:

None.

Init Drafting Post-Trigger

Event:

Every time a Drafting based program is started.

Type:

Post

Name:

trig_draft_init

Input Parameters:

None

Allowed return values:

kcs_util.trigger_ok()

Override functionality:

None.

Notes:

This trigger is used by some of the standard functionality. User additions can be done to this triggers, but the existing implementation should be left intact for the standard functionality to work properly.

The Vitesse API kcs_gui is designed to be used within this trigger.

See kcs_ex_gui1.py, kcs_ex_gui2.py, and kcs_ex_gui3.py for examples.

New drawing pre-trigger

Event:

File / New

Type:

Pre

Name:

trig_draft_dwg_new

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before user will be prompted to indicate name of the drawing frame.

New drawing post-trigger

Event:

File / New

Type:

Post

Name:

trig_draft_dwg_new

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger only runs after new drawing has been successfully created. If an error occurs during creation, the trigger will not be run.

Open drawing pre-trigger

Event:

File / Open

Type:

Pre

Name:

trig_draft_dwg_open

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before user will be prompted to indicate name of the drawing to open.

Open drawing post-trigger

Event:

File / Open

Type:

Post

Name:

trig_draft_dwg_open

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger only runs after drawing has been successfully opened. If an error occurs during opening, the trigger will not be run.

Close drawing pre-trigger

Event:

File / Close

Type:

Pre

Name:

trig_draft_dwg_open

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before drawing will be close.

Close drawing post-trigger

Event:

File / Close

Type:

Post

Name:

trig_draft_dwg_close

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger only runs after drawing has been successfully closed. If an error occurs during closing, the trigger will not be run.

Save drawing pre-trigger

Event:

File / Save

Type:

Pre

Name:

trig_draft_dwg_save

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before drawing will be save.

Save drawing post-trigger

Event:

File / Save

Type:

Post

Name:

trig_draft_dwg_save

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger only runs after drawing has been successfully saved. If an error occurs during saving, the trigger will not be run.

Save As drawing pre-trigger

Event:

File / Save As

Type:

Pre

Name:

trig_draft_dwg_save_as

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before drawing will be save.

Save As drawing post-trigger

Event:

File / Save As

Type:

Post

Name:

trig_draft_dwg_save_as

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger only runs after drawing has been successfully saved. If an error occurs during saving, the trigger will not be run.

Print drawing pre-trigger

Event:

File / Print

Type:

Pre

Name:

trig_draft_dwg_print

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before drawing will be print.

Print drawing post-trigger

Event:

File / Print

Type:

Post

Name:

trig_draft_dwg_print

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger will be run if the interactive command is completed without errors.

Insert Model pre-trigger

Event:

Insert / Model

Type:

Pre

Name:

trig_draft_insert_model

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before user will be indicated to select model.

Insert Model post-trigger

Event:

Insert / Model

Type:

Post

Name:

trig_draft_insert_model

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger will be run if the insertion of model will end with success.

Model Info pre-trigger

Event:

Tools / Inquiry / Model

Type:

Pre

Name:

trig_draft_model_info

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Note:

This trigger fires before user will be indicated to select model.

Model Info post-trigger

Event:

Tools / Inquiry / Model

Type:

Post

Name:

trig_draft_model_info

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger will be run if the model info will be obtained successfully.

Model Info property edit pre-trigger

Event:

Tools / Inquiry / Model / Edit

Type:

Pre

Name:

trig_draft_property_edit

Input Parameters:

Name

Type

Description

Model object

Model

Model information

Value

string

First value

Value

string

Last value

Allowed return values:

kcs_util.trigger_ok()

Note:

This trigger will be fired when the Edit function is selected in the dialog.

Verify drawing pre-trigger

Event:

Tools / Inquiry / Verify

Type:

Pre

Name:

trig_draft_dwg_verify

Input Parameters:

None

Allowed return values:

Standard for Pre-Trigger

Override functionality:

If kcs_util.trigger_override() is returned, no part of the standard input model function will not be performed.

Note:

This trigger fires before user will be indicated to select geometry.

Verify drawing post-trigger

Event:

Tools / Inquiry / Verify

Type:

Post

Name:

trig_draft_dwg_verify

Input Parameters:

None

Allowed return values:

Standard for Post-Trigger

Note:

This trigger will be run if the geometry info will be obtained successfully.

Insert Model Filter Pre-Trigger

Event:

When the user clicks the "Filter" button in the Insert/Model dialog.

Type:

Pre

Name

trig_draft_insert_model_filter

Input Parameters:

Name

Type

Description

Model object

Model

First model information

Model object

Model

Last model information

Allowed return values:

Name

Type

Description

kcs_util.trigger_ok()

kcs_util.trigger_abort()

If kcs_util.trigger_ok(), a number of model classes could also be returned (see below).

Model objects

List of Models

Python list of all models to be included.

Override functionality:

None.

Note:

See kcs_ex_att3.py for an example.