ToolAskMsgData Struct Reference

#include <c4d_baselist.h>

Detailed Description

Message struct for the MSG_TOOL_ASK message.
Sent to tools on mouse input to query them on whether they accept/use certain input such as modifier keys, right or middle mouse button. This allows them to override the normal Cinema 4D functionality.

Public Member Functions

 ToolAskMsgData ()

Input Values

Int32 version
Int32 x
Int32 y
Int32 button
const BaseContainermsg

Result Values

Bool popup_exit
Bool popup_allowed
Int32 popup_menuid
Bool use_middlemouse
Bool use_rightmouse
Bool resize_allowed
Bool use_singleclick

Constructor & Destructor Documentation

◆ ToolAskMsgData()

Default constructor.

Member Data Documentation

◆ version

Int32 version

The version number of this structure.

◆ bw

The editor window.

◆ doc

The document.

◆ x

Int32 x

X position of the mouse.

◆ y

Int32 y

Y position of the mouse.

◆ button

Int32 button

The pressed mouse buttons: KEY

◆ msg

const BaseContainer* msg

The message container.

◆ bd

BaseDraw* bd

The base draw.

◆ popup_exit

Bool popup_exit

Set to true if you already did everything and canceling mouse input in the core.

◆ popup_allowed

Bool popup_allowed

Set to false to prevent core from opening a popup.

◆ popup_menuid

Int32 popup_menuid

Set to any menu ID to use the standard popup. e.g. M_MODELING_POLYGON.

◆ use_middlemouse

Bool use_middlemouse

Set to true to use the middle mouse button to do something in ToolData::MouseInput().

◆ use_rightmouse

Bool use_rightmouse

Set to true to use the right mouse button to do something in ToolData::MouseInput().

◆ resize_allowed

Bool resize_allowed

Set to true to accept sizing messages for brushes.

◆ use_singleclick

Bool use_singleclick

Set to true to allow single clicks to select components/objects.