Events

sd-create-event
sd-process-event
sd-subscribe-event
sd-unsubscribe-event

Standard Events

SD-CREATE-EVENT

(sd-create-event event)

Description:

Creates a new event which can be processed to invoke subscribed functions.

Parameters:

event {STRING} - the new event name

Return Value:

event {STRING} - new event if successful

nil - event already exists

Example:

(sd-create-event "foo-event")

SD-PROCESS-EVENT  [function]

(sd-process-event event arguments)

Description:

Invokes all functions subscribed to the event.

Parameters:

event {STRING} - the event name

arguments {LISP forms} - any number of arguments to be passed to all functions subscribed to event

Return Value:

nil - always

Example:

(sd-process-event "foo-event" 12.5 '("string1" "string2"))

SD-SUBSCRIBE-EVENT  [function]

(sd-subscribe-event event function arguments)

Description:

Subscribes a function to be invoked when the event is processed.

Parameters:

event {STRING} - the event name

function {SYMBOL} - The function to subscribe to the event.

Note: As a rule, subscribed functions should ALWAYS include a &rest parameter to handle additional arguments that maybe passed to the function by sd-process-event.

arguments {LISP forms} - any number of arguments to be passed to function when event is processed

Return Value:

functions {LIST} - a list of functions subscribed to the event

Example:

(defun foo-func (arg &rest more-args)
  (pprint arg)
  (when more-args (pprint more-args)))

(sd-subscribe-event "foo-event" 'foo-func 12.5)
(sd-process-event "foo-event" 24.2)

=> 12.5
   (24.2)

SD-UNSUBSCRIBE-EVENT  [function]

(sd-unsubscribe-event event function)

Description:

Removes a function from the subscription list of an event.

Parameters:

event {STRING} - the event name

function {SYMBOL} - the function to unsubscribe

Return Value:

functions {LIST} - list of functions still subscribed to the event

function {SYMBOL} - the specified function if the event does not exist

Standard Events

The following constants identify standard events which are available for use. These constants can be used as parameters for the event functions.

• *SD-BUSY-EVENT*
  • Processed when system is busy with a computation
• *SD-CHANGE-MODIFIED-STATUS-EVENT*
  • Processed when the modification status of an object changes
• *SD-CHANGE-OBJECT-TREE-EVENT*
  • Processed when a new object is created
  • Processed when an object is deleted
  • Processed when an object relationship changes
• *SD-CHANGE-CURRENT-OBJECT-EVENT*
  • Processed when the current part or workplane is changed
• *SD-INTERACTIVE-EVENT*
  • Processed before user input is received
• *SD-TERMINATE-EVENT*
  • Processed on exit from Creo Elements/Direct Modeling
• *SD-ENTER-COMMAND-EVENT*
  • Processed when Creo Elements/Direct Modeling returns to the "Enter Command" state
• *SD-UPDATE-SCREEN-EVENT*
  • Processed on every screen update
• *SD-CURRENT-VIEWPORT-EVENT*
  • Processed when the current viewport changes
• *SD-CHANGE-CURRENT-DIRECTORY-EVENT*
  • Processed when the current directory is changed
• *SD-CHANGE-CATCH-EVENT*
  • Processed when the catch parameters are changed permanently
• *SD-CHANGE-UNITS-EVENT*
  • Processed when the units are changed
• *SD-MINIMIZE-EVENT*
  • Processed when the application window is minimized.
• *SD-RESTORE-EVENT*
  • Processed when the minimized application window is restored.
• *SD-SWITCH-APPLICATION-EVENT*
  • Processed when the current application changed. The subscribed event function has to accept two arguments. The first argument will be filled with the name of the application which was current before the switch and the second argument will be the name of the application which now is current.

  NOTE: Additional modules available for Creo Elements/Direct Modeling have activation and deactivation events associated with them. These events are processed once when the modules are activated or deactivated. The following two functions return the module specific activation and deactivation events:

• sd-module-activation-event
• sd-module-deactivation-event