diguyPluginMouseEvent

Generated from diguyPluginMouseEvent.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyPluginMouseEvent.h. Do not edit this file directly; the changes will be lost.

Includes: declspec_diguy.h

Contents:

Alphabetical Index

Objects of this type are passed into the plugin mouse functions mouse_press(), mouse_drag(), mouse_release(), and mouse_move().

class diguyPluginMouseEvent

class BDI_DECLSPEC_diguy diguyPluginMouseEvent
{
public:
    diguyView* get_view();
    int get_x();
    int get_y();
    enum {
        BUTTON_STATE_LEFT   = 0x0001,
        BUTTON_STATE_RIGHT  = 0x0002,
        BUTTON_STATE_MIDDLE = 0x0004,
        BUTTON_STATE_SHIFT  = 0x0008,
        BUTTON_STATE_CTRL   = 0x0010,
        BUTTON_STATE_ALT    = 0x0020
    };
    int get_button_state();

function diguyPluginMouseEvent::get_view

Prototype:
diguyView* get_view();
Description:

This function returns the view in which the mouse event took place.
Returns:

object of type diguyView
Callable From:

C++

function diguyPluginMouseEvent::get_x

Prototype:
int get_x();
Description:

This function returns the screen x coordinate at which the mouse event took place.
Returns:

screen x coordinate
Callable From:

C++

function diguyPluginMouseEvent::get_y

Prototype:
int get_y();
Description:

This function returns the screen y coordinate at which the mouse event took place.
Returns:

screen y coordinate
Callable From:

C++

enumeration

	enum {
		BUTTON_STATE_LEFT   = 0x0001,
		BUTTON_STATE_RIGHT  = 0x0002,
		BUTTON_STATE_MIDDLE = 0x0004,
		BUTTON_STATE_SHIFT  = 0x0008,
		BUTTON_STATE_CTRL   = 0x0010,
		BUTTON_STATE_ALT    = 0x0020
	};
Description:

This is an enumeration of the different button states reported by get_button_state(). The values may be OR-ed together. e.g., the value 0x21 would indicate that the left mouse button was clicked while the ALT was down.
Usable From:

C++
Script

function diguyPluginMouseEvent::get_button_state

Prototype:
int get_button_state();
Description:

This function returns state of the mouse buttons when the mouse event took place. Refer to the enumeration above for possible values.
Returns:

OR-ed together state of mouse buttons
Callable From:

C++

Alphabetical Index

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.