Versions Compared

Version Old Version 16 New Version Current
Changes made by

Lukas Kaser

Sonu Shahi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

These events are fired when a command executes:

Message Name

Descriptions

commandWillStart

whenever the execution of a command will start.

commandEnded

whenevever the execution of a command has ended

commandCancelled

whenevever the execution of a command has been canceled.

commandFailed

whenevever the execution of a command has failed.

modelessOperationWillStart

whenever a modeless operation is about to start.

modelessOperationEnded

whenever a modeless operation has ended.

Structure of the Messages

commandWillStart

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [ {"command name": string } ], 
  "eventType": "commandWillStart"}"
}

commandEnded

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [ {"command name": string } ], 
  "eventType": "commandEnded"}"
}

commandCancelled

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [ {"command name": string } ], 
  "eventType": "commandCancelled"}"
}

commandFailed

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [ {"command name": string } ], 
  "eventType": "commandFailed"}"
}

modelessOperationWillStart

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [ {"modeless operation": string } ], 
  "eventType": "modelessOperationWillStart"}"
}

modelessOperationEnded

Code Block
{
  "messageName": "commandEvent",
  "message": "{"data": [  {"modeless operation": string } ], 
  "eventType": "modelessOperationEnded"}"
}

Lisp Events

Event name for registration: lispEvent

These events are fired when a lisp action is performed:

Message Name

Descriptions

lispEnded

whenevever the execution of a lisp has ended

lispCancelled

whenevever the execution of a lisp has cancelled

Structure of the Messages

lispEnded

Code Block
{
  "messageName": "lispEvent",
  "message": "{"data": [ {"lisp called function": string } ], 
  "eventType": "lispEnded"}"
}

lispCancelled

Code Block
{
  "messageName": "lispEvent",
  "message": "{"data": [ {"lisp called function": string } ], 
  "eventType": "lispCancelled"}"
}

System Variables Events

Event name for registration: sysVarEvent

These events are fired when a system variable change action is performed:

Message Name

Descriptions

sysvarChanged

Occurs when a change is made to the value of a system variable.

Structure of the Messages

sysvarChanged

Code Block
{
  "messageName": "sysVarEvent",
  "message": "{"data": [ {"System Variable": string } ], 
  "eventType": "sysVarChanged"}"
}

Drawing Events

Event name for registration: drawingEvent

These events are fired when an action is performed on drawing:

Message Name

Descriptions

drawingSaved

when a drawing is saved.

UploadBegin

when a drawing upload is going to start

UploadComplete

when a drawing upload was done

drawingDescription*

(*not implemented yet)

Structure of the Messages

drawingSaved

Code Block
{
  "messageName": "drawingEvent",
  "message": "{ 
  "eventType": "drawingSaved"
   }"
}

UploadBegin

Code Block
{
  "messageName": "drawingEvent",
  "message": "{ 
  "eventType": "UploadBegin"
   }"
}

UploadComplete

Code Block
{
  "messageName": "drawingEvent",
  "message": "{"data": [ {"upload complete": bool} ], 
  "eventType": "UploadComplete"}"
}

View Events

Event name for registration: viewChangedEvent

These events are fired when a view change action is performed:

Message Name

Descriptions

viewChanged

whenever the World to Eye transformation matrix has been changed.

Structure of the Messages

viewChanged

Code Block
{
  "messageName": "viewChangedEvent",
  "message": "{"data": [ {"position": string,
  "target": string,
  "upVector": string,
  "fieldWidth": string,
  "fieldHeight":string
  ], 
  "eventType": "viewChanged"}"
}

Selection Events

Event name for registration: selectionEvent

These events are fired when a selection action is performed:

Message Name

Descriptions

selectionChanged

when a change takes place to the current selection set.

selectionCancelled

when a current selection is cancelled.

Structure of the Messages

selectionChanged

Code Block
{
  "messageName": "selectionEvent",
  "message": "{"data": [ {"selectionMethod": string,
  "numberOfEntities": string,
  "entity Properties": string,
  "entity Properties": string,
  "entity Properties": string
  ...
  } ], 
  "eventType": "selectionChanged"}"
}

selectionCancelled

Code Block
{
  "messageName": "selectionEvent",
  "message": "{
  "eventType": "selectionCancelled"}"
}

Drawing Modified Events

Event name for registration: drawingModifiedEvent

These events are fired when a drawing edit action is performed:

Message Name

Descriptions

drawingModified

whenever any command or modeless operation is performed which could cause database modification.

Structure of the Messages

drawingModified

Code Block
{
  "messageName": "drawingModifiedEvent",
  "message": "{"data": [ 
     {"command name": string},
     {"drawing should be saved":bool}
    ], 
  "eventType": "drawingModified"}"
}