Source code for cPy.cUI

from __future__ import annotations
import cPy.cTypes
import cPy.cScene
#cUI
import Coat_CPP
import typing
from typing import ClassVar
from typing import TypeAlias
from typing import Any
from enum import Enum


[docs] class RoomBehavior(): def __init__(self): pass # CPP source def __init__(self): pass # CPP source RoomName: str #: std :: string (T)
[docs] def SetRoomName(self, room_name: str): pass # cpp source
[docs] def Room(self) -> any: pass # cpp source
[docs] def Apply(self): pass # cpp source
[docs] def UseScriptsForToolset(self) -> bool: pass # cpp source
[docs] def UseScriptsForMenu(self) -> bool: pass # cpp source
[docs] def UseScriptsForNavigation(self) -> bool: pass # cpp source
[docs] def UseScriptsForRmb(self) -> bool: pass # cpp source
[docs] def UseScriptsForCurves(self) -> bool: pass # cpp source
[docs] def UpdateToolsList(self): pass # cpp source
[docs] def UpdateNavigationControls(self): pass # cpp source
[docs] def UpdateMainMenu(self): pass # cpp source
[docs] def OnStartPage(self): pass # cpp source
[docs] def ShowPopupMenu(self, propertytype: str): pass # cpp source
[docs] class CustomRoom():
[docs] @staticmethod def dynamic_cast(pObject : any)->CustomRoom: ''' An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a CustomRoom class or its descendant, and if so, returns the specified object, but of the CustomRoom type. ''' pass # cpp source
RoomName: cPy.cTypes.cStr #: cStr (T) RoomFolderName: cPy.cTypes.cStr #: cStr (T) SourceFile: cPy.cTypes.cStr #: cStr (T)
[docs] def GetRoomName(self) -> str: pass # cpp source
[docs] def SetRoomName(self, room_name: str): pass # cpp source
UseScriptsForToolset: bool #: bool (T) UseScriptsForMenu: bool #: bool (T) UseScriptsForNavigation: bool #: bool (T) UseScriptsForRmb: bool #: bool (T) UseScriptsForCurves: bool #: bool (T) MandatoryRenderRetopoObjects: bool #: bool (T) MandatoryRenderPaintObjects: bool #: bool (T) UsePythonByDefault: bool #: bool (T) ToolsetScriptText: cPy.cTypes.cStr #: cStr (T) MenuScriptText: cPy.cTypes.cStr #: cStr (T) NavigationText: cPy.cTypes.cStr #: cStr (T) RmbText: cPy.cTypes.cStr #: cStr (T) CurvesText: cPy.cTypes.cStr #: cStr (T) LayoutText: cPy.cTypes.cStr #: cStr (T) LockName: bool #: bool (T) IsDefault: bool #: bool (T) PerformLocalization: bool #: bool (T) Visible: bool #: bool (T) pBehavior: RoomBehavior #: RoomBehavior * (T)
[docs] def Behavior(self) -> RoomBehavior: pass # cpp source
RMBPropertyType: str = Coat_CPP.CustomRoom.RMBPropertyType #: static std :: string (T) SaveMode: bool = Coat_CPP.CustomRoom.SaveMode #: static bool (T) SkipRmbMenuAppearance: bool = Coat_CPP.CustomRoom.SkipRmbMenuAppearance #: static bool (T) CallPageInit: bool = Coat_CPP.CustomRoom.CallPageInit #: static bool (T) RoomsLoaded: bool = Coat_CPP.CustomRoom.RoomsLoaded #: static bool (T) RoomChanged: bool = Coat_CPP.CustomRoom.RoomChanged #: static bool (T) ToolsList: any #: StringsList (T) HiddenElements: any #: StringsList (T) TemporaryTools: any #: StringsList (T) Order: int #: int (T) SpacePanelColumns: int #: int (T) def __init__(self): pass # CPP source
[docs] @staticmethod def drop_undo(): pass # cpp source
[docs] @staticmethod def RefreshInterface(): pass # cpp source
[docs] @staticmethod def CreateNewRoom(Name: str) -> CustomRoom: pass # cpp source
[docs] @staticmethod def FindRoom(Name: str) -> CustomRoom: pass # cpp source
[docs] @staticmethod def FindRoomByFolder(Name: str) -> CustomRoom: pass # cpp source
[docs] @staticmethod def IsInCustomRoom() -> bool: pass # cpp source
[docs] @staticmethod def LoadCustomRooms(): pass # cpp source
[docs] @staticmethod def SaveCustomRooms(): pass # cpp source
[docs] @staticmethod def CurrentCustomRoom() -> CustomRoom: pass # cpp source
[docs] @staticmethod def CurrentRoomName() -> str: pass # cpp source
[docs] @staticmethod def GetRootPath() -> cPy.cTypes.cStr: pass # cpp source
[docs] @staticmethod def RestoreDefaultRoomsVisibility(): pass # cpp source
[docs] @staticmethod def RestoreAllRoomsVisibility(): pass # cpp source
[docs] @staticmethod def RestoreDefaultRoomsLayout(): pass # cpp source
[docs] @staticmethod def HideCurrentRoom(): pass # cpp source
[docs] @staticmethod def AddNewPage(): pass # cpp source
[docs] @staticmethod def StoreThisPageLayout(): pass # cpp source
[docs] @staticmethod def RestoreThisPageLayout(): pass # cpp source
[docs] @staticmethod def StoreAllPagesLayout(): pass # cpp source
[docs] @staticmethod def RestoreAllPagesLayout(): pass # cpp source
[docs] @staticmethod def SetVoxTreeContext(tb: cPy.cScene.VoxTreeBranch): pass # cpp source
[docs] @staticmethod def SetCurveContext(tb: any): pass # cpp source
[docs] @staticmethod def GetVoxTreeContext() -> cPy.cScene.VoxTreeBranch: pass # cpp source
[docs] @staticmethod def GetCurveContext() -> any: pass # cpp source
[docs] @staticmethod def SetGlobalContextForHotkeyAction(): ''' when the hotkey is pressid this function setups contexts for RMB actions with hotkeys ''' pass # cpp source
[docs] @staticmethod def RunCustomRmbMenu(propertytype: str = "rmb"): ''' Handle RMB UP. Call it within RMB UP handling routines ''' pass # cpp source
[docs] @staticmethod def StartCustomRmb(): ''' This command shold be called from script, no need to call it directly from program code ''' pass # cpp source
[docs] @staticmethod def FinishAndShowCustomRmb(): ''' If you called StartCustomRmb(), use menu commands lime menu_item(...) and then call FinishAndShowCustomRmb(). If you will not call it 3D-Coat will not work correctly!!! ''' pass # cpp source
[docs] @staticmethod def StopAllContexts(): ''' Stop all contexts when RMB panel disappears ''' pass # cpp source
[docs] @staticmethod def RmbPropPanelActive() -> bool: ''' returns true if properties (RMB) panel is active. ''' pass # cpp source
[docs] @staticmethod def ToolForPage(Page: str) -> cPy.cTypes.cStr: ''' returns reference to the name of the current tool for the given page ''' pass # cpp source
[docs] @staticmethod def PrevToolForPage(Page: str) -> cPy.cTypes.cStr: pass # cpp source
[docs] @staticmethod def SetToolForPage(Page: str, tool: str): pass # cpp source
[docs] @staticmethod def AutoUpdateToolForPage(tool: any, SubMode: int): pass # cpp source
[docs] @staticmethod def GetCurrrentDefaultTool() -> cPy.cTypes.cStr: pass # cpp source
[docs] @staticmethod def TryToSetNewDefailtTool(Tool: str): pass # cpp source
[docs] @staticmethod def ActivateToolCommandByName(name: str): ''' find and activate tool by it's name ''' pass # cpp source
[docs] @staticmethod def ActivateLastCustomRoom(): pass # cpp source
ActivationSource: cPy.cTypes.cStr = Coat_CPP.CustomRoom.ActivationSource #: static cStr (T)
[docs] @staticmethod def IsPythonScript(text: str) -> bool: pass # cpp source
[docs] def GetRoomFileInfo(self, idx: int, r: any) -> bool: pass # cpp source
[docs] def EditRoomParameters(self): pass # cpp source
[docs] def AddTool(self, ToolID: str, Section: str): pass # cpp source
[docs] def AddSection(self, SectionName: str): pass # cpp source
[docs] def RemoveThisRoom(self): pass # cpp source
[docs] def HideThisRoom(self): pass # cpp source
[docs] def Rename(self, NewName: str) -> bool: pass # cpp source
[docs] def SaveRoomLayout(self, filename: str): pass # cpp source
[docs] def LoadRoomLayout(self, filename: str): pass # cpp source
[docs] def AutoSaveRoomLayout(self): pass # cpp source
[docs] def EditCppItem(self, suffix: str): pass # cpp source
[docs] def AskAboutBaseToolset(self): pass # cpp source
[docs] def EditScript(self, path: str): pass # cpp source
[docs] def GetRoomFileRef(self, alias: str = "room.xml") -> cPy.cTypes.cStr: pass # cpp source
[docs] def CheckIfFilesChanged(self): pass # cpp source
[docs] def GetScript(self, suffix: str, script: cPy.cTypes.cStr) -> bool: pass # cpp source
[docs] def GetPyScriptPath(self, suffix: str) -> cPy.cTypes.cStr: pass # cpp source
[docs] def ExecuteScript(self, suffix: str, function: str = "main"): pass # cpp source
[docs] def DefaultsAvailable(self) -> bool: pass # cpp source
[docs] def RestoreDefaultScriptsAndLayout(self): pass # cpp source
[docs] def OnRmbOverItemInCustomMode(self, w: any): pass # cpp source
[docs] def CopyToolsetFromOtherRoom(self): pass # cpp source
[docs] @staticmethod def Hide(ID: str): ''' Hiding management ''' pass # cpp source
[docs] @staticmethod def CheckHidden(ID: str, L: int = 0) -> bool: pass # cpp source
[docs] @staticmethod def RemoveHidden(ID: str): pass # cpp source
[docs] @staticmethod def HideSection(ID: str): pass # cpp source
[docs] @staticmethod def UnHideSection(ID: str): pass # cpp source
[docs] @staticmethod def HasSculptTools() -> bool: ''' Check for specific toolsets ''' pass # cpp source
[docs] @staticmethod def HasPaintTools() -> bool: pass # cpp source
[docs] @staticmethod def HasRetopoTools() -> bool: pass # cpp source
[docs] @staticmethod def HasModelingTools() -> bool: pass # cpp source
[docs] @staticmethod def HasRender() -> bool: pass # cpp source
[docs] @staticmethod def HasUVTools() -> bool: pass # cpp source
[docs] def GetPageID(self) -> str: pass # cpp source
ToolsPriory: any #: StringsList (T) Drag&dropped items
[docs] def SortDragNDropped(self, List: any): pass # cpp source
[docs] def DragAndDropTool(self, Src: str, dst: str, before: int): pass # cpp source
[docs] def RaisePriory(self, Tool: str): pass # cpp source
[docs] def RestoreDefaultOrder(self): pass # cpp source
[docs] def AddCustomSectionAbove(self, SectionName: str, AbboveTool: str): pass # cpp source
[docs] def RenameSection(self, SectionName: str, NewName: str): pass # cpp source
[docs] def RemoveSection(self, SectionName: str): pass # cpp source
[docs] @staticmethod def get_alias(str: cPy.cTypes.cStr, alias: cPy.cTypes.cStr): pass # cpp source
[docs] @staticmethod def de_alias(id: cPy.cTypes.cStr) -> str: pass # cpp source
[docs] @staticmethod def pure_id(id: cPy.cTypes.cStr) -> str: pass # cpp source