Mouse and Cursor Extension Example

This is an example of an extension that displays information about both the mouse and cursor.

This example shows how to write an extension, how to display information about the mouse and cursor, how to display the information in the viewport, and how to add a menu item with its own function.

Note

You can assign a hotkey to a menu item you created by hovering your mouse over it and pressing the END button.

Installation

To install the extension in 3DCoat, copy this file to:

Documents\3DCoat\UserPrefs\Scripts\cExtensions\MouseTest\MouseTest.py

Create any missing folders.

After 3DCoat is loaded, the MouseTest extension will appear in the “Extensions” window. To enable it, click the “Start” button to the right of the extension’s name. If you want the extension to start automatically after 3DCoat starts, check the box to the left of the extension’s name.

Debugging and Editing

To easily edit extensions, open the Documents\3DCoat\UserPrefs\Scripts folder in Visual Studio Code.

Then you can:

• See the documentation in hints.

• Go to modules by holding down the Ctrl key and clicking.

• Activate the debugger by pressing F5 in Visual Studio Code after launching 3DCoat.

MouseTest.py

# Place this file in Documents\3DCoat\UserPrefs\Scripts\cExtensions\MouseTest\MouseTest.py so that it appears in 3DCoat's list of extensions in the "Extensions" window.
import coat
import CMD
import cPy.cCore
import cPy.cRender

from cTemplates.Structs import *
import cTemplates.MainMenu.View


# A variable that determines whether to show or hide information about the mouse and cursor.
ShowMouseInfo = True

# The function that will be called when a menu item is clicked. We use the d_slot dicatorator to get a command that calls it for the coat.menu_item function.
@d_slot
def ToggleMouseInfo():
    global ShowMouseInfo
    ShowMouseInfo = not ShowMouseInfo

# Create a separate section for our extension in the View menu.
@d_menu_section(cTemplates.MainMenu.View.CreateViewMenu)
def MouseInfoSection():
    # Add a menu item to this section that will enable and disable information about the mouse and cursor.
    coat.menu_item(ToggleMouseInfo.UICmd()) 


#############################################################################################################
# Create our extension class; in order for it to work correctly, it must be inherited from cPy.cCore.cExtension #
class MouseTestExtension(cPy.cCore.cExtension):

    def __init__(self):
        cPy.cCore.cExtension.__init__(self)        

    # Rewrite the inherited "postrender" function, which will be called every time after rendering to display our information on the screen.
    def postrender(self):
        # Display information only if ShowMouseInfo is True
        if not ShowMouseInfo:
            return
        
        # display information about the mouse and cursor as text on the viewport.
        cPy.cRender.RenderUtils.draw_text(300, 200, f"Cursor pos: {coat.io.cursorPos().x}, {coat.io.cursorPos().y}") #cursor pos (variant 1)
        cPy.cRender.RenderUtils.draw_text(300, 230, f"Cursor pos: {CMD.GetMouseX()}, {CMD.GetMouseY()}")#cursor pos (variant 2)

        cPy.cRender.RenderUtils.draw_text(300, 290, f"Left mouse button: {CMD.LMBPressed()}")
        cPy.cRender.RenderUtils.draw_text(300, 320, f"Middle mouse button: {CMD.MMBPressed()}")
        cPy.cRender.RenderUtils.draw_text(300, 350, f"Right mouse button: {CMD.RMBPressed()}")
        cPy.cRender.RenderUtils.draw_text(300, 380, f"Wheel pressed: {CMD.WheelPressed()}")

        cPy.cRender.RenderUtils.draw_text(300, 410, f"Screen space pen radius: {CMD.GetVisiblePenRadius()}")

        cPy.cRender.RenderUtils.draw_text(300, 440, f"Picks Object: {CMD.ScreenRayPicksObject(CMD.GetMouseX(), CMD.GetMouseY())}")

        # If the cursor is hovering over an object, we draw a sphere on the object and display the 3D coordinates of the point the cursor is hovering over.
        if CMD.ScreenRayPicksObject(CMD.GetMouseX(), CMD.GetMouseY()):

            # Find out the 3D coordinates of the point the cursor is hovering over.
            pickPos: coat.vec3 = cPy.cRender.RenderUtils.PickPointSpacePos()

            # draw a sphere
            cPy.cRender.RenderUtils.drawCoolSphere(pickPos, 10.0, int("FF00FFFF", 16))

            # Displaying 3D coordinates as text in the viewport
            mx = CMD.GetMouseX()
            my = CMD.GetMouseY()
            cPy.cRender.RenderUtils.draw_text(mx, my, " 3D Coord")
            cPy.cRender.RenderUtils.draw_text(mx, my+30, f" X: {pickPos.x}")
            cPy.cRender.RenderUtils.draw_text(mx, my+60, f" Y: {pickPos.y}")
            cPy.cRender.RenderUtils.draw_text(mx, my+90, f" Z: {pickPos.z}")



# Create an extension (an instance of the class that will perform the work of our extension).
myMouseTestExtension = MouseTestExtension()