new webCGMEvent()
webCGMEvent constructor
Methods
getAltKey() → {boolean}
Returns indication whether the 'alt' key was depressed during the firing of the event.
Returns:
altKey
Type: boolean
getButton() → {int}
Returns button. During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state. The values for button range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.
Returns:
button
Type: int
getClientX() → {float}
Returns the horizontal coordinate at which the event occurred expressed in Normalized VDC.
Returns:
clientX
Type: float
getClientY() → {float}
Returns the vertical coordinate at which the event occurred expressed in Normalized VDC.
Returns:
clientY
Type: float
getCtrlKey() → {boolean}
Returns indication whether the 'ctrl' key was depressed during the firing of the event.
Returns:
ctrlKey
Type: boolean
getMetaKey() → {boolean}
Returns indication whether the 'meta' key was depressed during the firing of the event.
Returns:
metaKey
Type: boolean
getNumPressed() → {int}
Returns the number of times a mouse button has been pressed and released over the same screen location during a user action. The attribute value is 1 when the user begins this action and increments by 1 for each full sequence of pressing and releasing. If the user moves the mouse between the mousedown and mouseup the value will be set to 0, indicating that no click is occurring.
Returns:
numPressed
Type: int
getShiftKey() → {boolean}
Returns indication whether the 'shift' key was depressed during the firing of the event.
Returns:
shiftKey
Type: boolean
getTarget() → {webCGMAppStruct|webCGMPicture|webCGMAttr|webCGMNode|null}
If the event was triggered by an action involving a webCGMAppStruct, webCGMPicture, webCGMAttr or webCGMNode thenthis method returns a target of that type, otherwise this returns null. Most often used to indicate the WebCGMAppStruct(Application Structure) to which the event was originally dispatched.
Returns:
target
Type: webCGMAppStruct | webCGMPicture | webCGMAttr | webCGMNode | null
type() → {string}
Returns the name of the event (case-insensitive). The name must be an XML name.
Returns:
type
Type: string