Command.getCursor Method
Parent Object:
CommandDefined in namespace "adsk::core" and the header file is <Core/UserInterface/Command.h>
Description
Gets the custom cursor information currently being used.
Syntax
"command_var" is a variable referencing a Command object.
(returnValue, cursorImage, xHotSpot, yHotSpot) = command_var.getCursor() |
#include <Core/UserInterface/Command.h
// Declare the output arguments.
string cursorImage;
integer xHotSpot;
integer yHotSpot;
boolean returnValue = command_var->getCursor(cursorImage, xHotSpot, yHotSpot);
|
Return Value
| boolean |
Returns true if getting the cursor information was successful. |
Parameters
| cursorImage |
string |
The full path to the png image that is being displayed as the cursor. |
| xHotSpot |
integer |
Gets the position of the x pixel within the image that is the "hot" spot or the point that is used as the mouse point. A value of zero indicates the left of the image. |
| yHotSpot |
integer |
Gets the position of the y pixel within the image that is the "hot" spot or the point that is used as the mouse point. A value of zero indicates the top of the image. |
Version
Introduced in version April 2019
