Mouse Modes
Mouse clicks can be customized in VCollabPro
These following are the mouse modes and its index values.
NONE = 0 : Does nothing
ROTATE = 1 : Applies rotation on mouse drag
ZOOM = 2 : Appliles model zoom on mouse drag
PAN = 3 : Applies pan transformation on mouse drag
HILIGHT = 4 : Selects an part on mouse down
DISTANCE = 5 : Finds distance between 2 points on mouse click
For more info, See VCollabPro Main Menu -> Edit -> Mouse Mode…
->Mouse Customization Dialog.
pxGetSingleClickMouseModes
Gets applied ‘Single Click’ mouse modes.
List<int> pxGetSingleClickMouseModes()
return
Returns an array of size 3 for ‘Single Click’ modes.
retArray[0] = Left mouse ‘Single Click’ mode
retArray[1] = Middle mouse ‘Single Click’ mode
retArray[2] = Right mouse ‘Single Click’ mode
xSetSingleClickMouseModes
Applies ‘Single Click’ mouse modes.
bool xSetSingleClickMouseModes(List<int> mouseSingleClicks)
return
Returns True, if successful.
mouseSingleClicks
Mouse ‘Single Click’ modes for left, middle and right mouse buttons in an input array of size 3.
pxGetDoubleClickMouseModes
Gets applied ‘Double Click’ mouse modes.
List<int> pxGetDoubleClickMouseModes()
return
Returns an array of size 3 for ‘Double Click’ modes.
retArray[0] = Left mouse ‘Double Click’ mode
retArray[1] = Middle mouse ‘Double Click’ mode
retArray[2] = Right mouse ‘Double Click’ mode
xSetDoubleClickMouseModes
Applies ‘Double Click’ mouse modes.
bool xSetDoubleClickMouseModes(List<int> mouseDoubleClicks)
return
Returns True, if successful.
mouseDoubleClicks
Mouse ‘Double Click’ modes for left, middle and right mouse buttons in an input array of size 3.
pxGetShiftClickMouseModes
Gets applied ‘Shift Key + Single Click’ mouse modes.
List<int> pxGetShiftClickMouseModes()
return
Returns an array of size 3 for ‘Shift +Single Click’ mouse mode.
retArray[0] = Left mouse ‘Shift + Single Click’ mode
retArray[1] = Middle mouse ‘Shift + Single Click’ mode
retArray[2] = Right mouse ‘Shift + Single Click’ mode
xSetShiftClickMouseModes
Applies ‘Shift Key + Single Click’ mouse modes.
bool xSetShiftClickMouseModes(List<int> mouseShiftClicks)
return
Returns True, if successful.
mouseShiftClicks
Mouse ‘Shift Key + Single Click’ modes for left, middle and right mouse buttons in an input array of size 3.
pxGetCtrlClickMouseModes
Gets applied ‘Ctrl Key + Single Click’ mouse modes.
List<int> pxGetCtrlClickMouseModes()
return
Returns an array of size 3 of applied mouse modes for ‘Ctrl Key + Single Click’ event.
retArray[0] = Left mouse ‘Ctrl Key + Single Click’ mode
retArray[1] = Middle mouse ‘Ctrl Key + Single Click’ mode
retArray[2] = Right mouse ‘Ctrl Key + Single Click’ mode
xSetCtrlClickMouseModes
Applies ‘Ctrl Key + Single Click’ mouse modes.
bool xSetCtrlClickMouseModes(List<int> mouseCtrlClicks)
return
Returns True, if successful.
mouseCtrlClicks
Mouse ‘Ctrl Key + Single Click’ modes for left, middle and right mouse buttons in an input array of size 3.
pxGetShiftCtrlClickMouseModes
Gets applied ‘Shift Key + Ctrl Key + Single Click’ mouse modes.
List<int> pxGetShiftCtrlClickMouseModes()
return
Returns an array of size 3 of applied mouse modes for ‘Single Click’ event.
retArray[0] = Left mouse ‘Shift Key + Ctrl Key + Single Click’ mode
retArray[1] = Middle mouse ‘Shift Key + Ctrl Key + Single Click’ mode
retArray[2] = Right mouse ‘Shift Key + Ctrl Key + Single Click’ mode
xSetShiftCtrlClickMouseModes
Applies ‘Shift Key +Ctrl Key + Single Click’ mouse modes.
bool xSetShiftCtrlClickMouseModes(List<int> mouseShiftCtrlClicks)
return
Returns True, if successful.
mouseShiftCtrlClicks
Mouse ‘Shift Key +Ctrl Key + Single Click’ modes for left, middle and right mouse buttons in an input array of size 3.
xSetDefaultMouseModes
Resets Mode modes to default.
void xSetDefaultMouseModes()
xGetMouseModeName
Get associated VCollabPro’s mouse mode action name
String xGetMouseModeName(int iMouseMode)
return
Returns associated action name name for input iMouseMode.
iMouseMode
Mouse mode. Valid Range 0 to 5.
0 - None : Does nothing
1 - Rotate : Rotation on mouse drag
2 - Zoom : Model zoom on mouse drag
3 - Pan : Pan transformation on mouse drag
4 - HiLight : Part Selection on mouse down
5 - Distance: Distance between 2 points on mouse click
pxGetMouseModes
Gets mouse mode id list for the given mouse mode index.
List<int> pxGetMouseModes()
return
Returns mouse mode id list if succeeds.Returns empty list otherwise.
[0] = MOUSEMODE_DEFAULT
[1] = MOUSEMODE_PICK_N_MOVE
[2] = MOUSEMODE_MEASURE
[3] = MOUSEMODE_HILIGHT
[4] = MOUSEMODE_CAE_PROBE
[5] = MOUSEMODE_CAE_SCAN_HOTSPOTS
[6] = MOUSEMODE_MOVE_LABEL
[7] = MOUSEMODE_REMOVE_LABEL
[8] = MOUSEMODE_HIDE_LABEL
[9] = MOUSEMODE_RUBBERBAND_ZOOM
[10]= MOUSEMODE_PART_SELECTION
xGetMouseMode
Gets mouse mode name for the given mouse mode index.
String xGetMouseMode(int iMouseMode)
return
Returns mouse mode name if succeeds.
Returns empty string otherwise.
Refer pxGetMouseModes for mouse modes
iMouseMode
Valid range 0 to 10
xGetCurrentMouseMode
Gets current mouse mode ID.
int xGetCurrentMouseMode()
return
Returns mouse mode ID, positive integer if succeeds.
Returns -1 otherwise
Refer pxGetMouseModes for mouse modes
xSetCurrentMouseMode
Sets given mouse mode id as current mouse mode.
bool xSetCurrentMouseMode(int iMouseMode = 0)
return
Returns True if it succeeds.
Returns False otherwise.
iMouseMode
Mouse mode ID. Default mouse mode is zero.
Refer pxGetMouseModes for mouse modes
xSetMouseModeDefault
Sets default mouse mode to the application.
void xSetMouseModeDefault()
xIsMouseModeDefault
Checks if current mouse mode is a default one.
bool xIsMouseModeDefault()
return
Returns True if current mouse mode is a default mode.
Returns False otherwise.