c4d.gui.EditorWindow

Definition

class c4d.gui.EditorWindow

• EditorWindow.DrawXORLine()

• EditorWindow.MouseDragStart()
• EditorWindow.MouseDrag()
• EditorWindow.MouseDragEnd()

• EditorWindow.BfGetInputState()
• EditorWindow.BfGetInputEvent()

• EditorWindow.Screen2Local()
• EditorWindow.Local2Screen()
• EditorWindow.Global2Local()
• EditorWindow.Local2Global()

Members

EditorWindow.DrawXORLine(x1, y1, x2, y2)

Draw an XOR line in the editor view.

Parameters:

• x1 (int) – Starting x coordinate of the line.
• y1 (int) – Starting y coordinate of the line.
• x2 (int) – End x coordinate of the line.
• y2 (int) – End y coordinate of the line.

EditorWindow.MouseDragStart(button, mx, my, flags)

Initialise a mouse dragging loop.

Parameters:

• button (int) – State of the mouse buttons
• mx (float) – The mouse x coordinate.
• my (float) – The mouse y coordinate.
• flags (int) –

  The drag flags, these are:

  MOUSEDRAG_DONTHIDEMOUSE	Show the mouse pointer during drag.
  MOUSEDRAG_NOMOVE	Return if no mouse movement was done.
  MOUSEDRAG_EVERYPACKET	Receive every packet of the queue, otherwise only data of the last packet.
  MOUSEDRAG_COMPENSATEVIEWPORTORG	Compensates the viewport origin during drag.
  MOUSEDRAG_ESCAPE	Drag aborted.
  MOUSEDRAG_FINISHED	Drag finished.
  MOUSEDRAG_CONTINUE	Drag still in progress.

EditorWindow.MouseDrag()

Check for the mouse drag status.:

result, mx, my, channels = win.MouseDrag()

Return type:

tuple

Returns:

See example above.

Parameters:

• result (float) –

  The results.

  MOUSEDRAG_ESCAPE	Drag aborted.
  MOUSEDRAG_FINISHED	Drag finished.
  MOUSEDRAG_CONTINUE	Drag still in progress.

• mx (float) – The mouse x coordinate.
• my (float) – The mouse y coordinate.
• channels (BaseContainer) – The state of the mouse. Please check the C++ documentation.

EditorWindow.BfGetInputEvent(askdevice, res)

Gets the next input event for a certain device from the event queue. If the return value is True, the container stored in res is just like an input event message, otherwise no event was available.

Parameters:

• askdevice (int) –

  The device to ask. One of the following types:

  BFM_INPUT_MOUSE	Mouse
  BFM_INPUT_KEYBOARD	Keyboard

• res (BaseContainer) – The result is stored in this container.

Return type:

bool

Returns:

True if the event could be retrieved, otherwise False.

EditorWindow.BfGetInputState(askdevice, askchannel, res)

Polls a certain channel of a device for the current input state. If the return value is True, the container stored in res is just like an input event message, otherwise no state was available.

Parameters:

• askdevice (int) –

  The device to ask.. One of the following types:

  BFM_INPUT_MOUSE	Mouse
  BFM_INPUT_KEYBOARD	Keyboard

• askchannel (int) –

  The channel contains the key or button (‘A’ means A, KEY_F1 means F1):

  BFM_INPUT_MOUSELEFT	Left mouse button.
  BFM_INPUT_MOUSERIGHT	Right mouse button.
  BFM_INPUT_MOUSEMIDDLE	Middle mouse button.
  BFM_INPUT_MOUSEX1	Fourth mouse button.
  BFM_INPUT_MOUSEX2	Five mouse button.
  BFM_INPUT_MOUSEWHEEL	Mouse wheel message.
  BFM_INPUT_MOUSEMOVE	Mouse move message.

• res (BaseContainer) – The result is stored in this container.

Return type:

bool

Returns:

True if a state could be retrieved, otherwise False.

EditorWindow.MouseDragEnd()

Check why the mouse drag ended. This enabled you to perform any undo operations needed if the user cancelled the drag.

Return type:int Returns:The results.

MOUSEDRAG_ESCAPE	Drag aborted.
MOUSEDRAG_FINISHED	Drag finished.
MOUSEDRAG_CONTINUE	Drag still in progress.

EditorWindow.Screen2Local()

Transforms screen coordinates (relative to the top left corner of the system screen) to local coordinates (relative to the top left corner of the user area):

x, y = win.Screen2Local()

Parameters:

• x (int) – The screen X coordinate.
• y (int) – The screen Y coordinate.

Raises RuntimeError:  

If the coordinates cannot be transformed.

EditorWindow.Local2Screen()

Transforms local coordinates (relative to the top left corner of the user area) to screen coordinates (relative to the top left corner of the system screen):

x, y = win.Local2Screen()

Parameters:

• x (int) – The local X coordinate.
• y (int) – The local Y coordinate.

Raises RuntimeError:  

If the coordinates cannot be transformed.

EditorWindow.Global2Local()

Transforms global window coordinates (relative to the top left corner of the application window) to local coordinates (relative to the top left corner of the user area):

x, y = win.Global2Local()

Parameters:

• x (int) – The global X coordinate.
• y (int) – The global Y coordinate.

Raises RuntimeError:  

If the coordinates cannot be transformed.

EditorWindow.Local2Global()

Transforms local coordinates (relative to the top left corner of the user area) to global window coordinates (relative to the top left corner of the application window):

x, y = win.Local2Global()

Parameters:

• x (int) – The local X coordinate.
• y (int) – The local Y coordinate.

Raises RuntimeError:  

If the coordinates cannot be transformed.