cTemplates.Rooms module

cTemplates.Rooms module#

DefaultMenu = Structs.cTemplate object>[source]#

Constructs the default main menu bar for the application.

It conditionally includes sub-menus (File, Edit, View, Room-specific menus) based on the active room (Paint, Voxels, Retopo, etc.) and debug state.

Items:

VoxTreeRmb = Structs.RMBMenu object>[source]#

The main Right-Click Menu (RMB) for the VoxTree (Sculpt Tree).

Dynamic content based on whether the object is cached (Proxy) or is a Surface.

Items:

CurvesRMB = Structs.RMBMenu object>[source]#: The Right-Click Menu (RMB) for Curves.

Initializes global variables based on the properties of the clicked curve (Primitive, Closed).

NavigationBar = Structs.cTemplate object>[source]#: Defines the main navigation bar structure and includes the viewport menu.

SculptTools = Structs.cTemplate object>[source]#: Main entry point for the Sculpt Room toolset.

Determines which toolset (Proxy, Surface, or Voxel) to load based on the current object state.

pathToRoomName(file_path: str)[source]#: Extracts the room name from the given file path by looking at the parent directory name.

class RoomBehavior[source]#

Bases: RoomBehavior

Base class for defining the behavior of a custom room in the application.

It handles updates for tools, menus, navigation bars, and context menus based on the active room.

UpdateToolsList()[source]#: Updates the list of available tools.

Loads the specific toolset for the room if defined; otherwise, loads default SculptTools.

OnStartPageToolsList()[source]#: Loads the toolset configuration specifically for the Start Page if defined for this room.

UpdateNavigationControls()[source]#: Updates the navigation bar controls.

Loads the specific navigation bar for the room if defined; otherwise, loads the default NavigationBar.

UpdateMainMenu()[source]#: Updates the main menu structure.

Loads the specific main menu for the room if defined; otherwise, loads the DefaultMenu.

ShowPopupMenu(propertytype)[source]#

Displays a context-sensitive popup menu (Right-Click Menu).

Parameters:: propertytype (str) – The type of property triggering the menu (e.g., “curves”).

reg_toolset(ref)[source]#: Registers a function as the toolset definition for a specific room.

The room name is derived from the file path of the reference function.

reg_main_menu(ref)[source]#: Registers a function as the main menu definition for a specific room.

reg_rmb(ref)[source]#: Registers a function as the Right Mouse Button (RMB) menu definition for a specific room.

reg_curves_rmb(ref)[source]#: Registers a function as the Curves context menu definition for a specific room.

reg_navigation_bar(ref)[source]#: Registers a function as the navigation bar definition for a specific room.

reg_room(room_beh)[source]#

Registers a new room behavior and automatically imports associated components

(Tools, CurvesMenu, RMBMenu, MainMenu, NavigationBar) if they exist in the room’s directory.