cPy.cUI module

Contents

cPy.cUI module#

class RoomBehavior[source]#

Bases: object

RoomName: str#

SetRoomName(room_name: str)[source]#

Room() → any[source]#

Apply()[source]#

UseScriptsForToolset() → bool[source]#

UseScriptsForMenu() → bool[source]#

UseScriptsForNavigation() → bool[source]#

UseScriptsForRmb() → bool[source]#

UseScriptsForCurves() → bool[source]#

UpdateToolsList()[source]#

UpdateNavigationControls()[source]#

UpdateMainMenu()[source]#

OnStartPage()[source]#

ShowPopupMenu(propertytype: str)[source]#

class CustomRoom[source]#

Bases: object

static dynamic_cast(pObject: any) → CustomRoom[source]#: 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.

RoomName: cStr#

RoomFolderName: cStr#

SourceFile: cStr#

GetRoomName() → str[source]#

SetRoomName(room_name: str)[source]#

UseScriptsForToolset: bool#

UseScriptsForMenu: bool#

UseScriptsForNavigation: bool#

UseScriptsForRmb: bool#

UseScriptsForCurves: bool#

MandatoryRenderRetopoObjects: bool#

MandatoryRenderPaintObjects: bool#

UsePythonByDefault: bool#

ToolsetScriptText: cStr#

MenuScriptText: cStr#

NavigationText: cStr#

RmbText: cStr#

CurvesText: cStr#

LayoutText: cStr#

LockName: bool#

IsDefault: bool#

PerformLocalization: bool#

Visible: bool#

pBehavior: RoomBehavior#

Behavior() → RoomBehavior[source]#

RMBPropertyType: str = ''#

SaveMode: bool = False#

SkipRmbMenuAppearance: bool = False#

CallPageInit: bool = True#

RoomsLoaded: bool = True#

RoomChanged: bool = True#

ToolsList: any#

HiddenElements: any#

TemporaryTools: any#

Order: int#

SpacePanelColumns: int#

static drop_undo()[source]#

static RefreshInterface()[source]#

static CreateNewRoom(Name: str) → CustomRoom[source]#

static FindRoom(Name: str) → CustomRoom[source]#

static FindRoomByFolder(Name: str) → CustomRoom[source]#

static IsInCustomRoom() → bool[source]#

static LoadCustomRooms()[source]#

static SaveCustomRooms()[source]#

static CurrentCustomRoom() → CustomRoom[source]#

static CurrentRoomName() → str[source]#

static GetRootPath() → cStr[source]#

static RestoreDefaultRoomsVisibility()[source]#

static RestoreAllRoomsVisibility()[source]#

static RestoreDefaultRoomsLayout()[source]#

static HideCurrentRoom()[source]#

static AddNewPage()[source]#

static StoreThisPageLayout()[source]#

static RestoreThisPageLayout()[source]#

static StoreAllPagesLayout()[source]#

static RestoreAllPagesLayout()[source]#

static SetVoxTreeContext(tb: VoxTreeBranch)[source]#

static SetCurveContext(tb: any)[source]#

static GetVoxTreeContext() → VoxTreeBranch[source]#

static GetCurveContext() → any[source]#

static SetGlobalContextForHotkeyAction()[source]#: when the hotkey is pressid this function setups contexts for RMB actions with hotkeys

static RunCustomRmbMenu(propertytype: str = 'rmb')[source]#: Handle RMB UP. Call it within RMB UP handling routines

static StartCustomRmb()[source]#: This command shold be called from script, no need to call it directly from program code

static FinishAndShowCustomRmb()[source]#: 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!!!

static StopAllContexts()[source]#: Stop all contexts when RMB panel disappears

static RmbPropPanelActive() → bool[source]#: returns true if properties (RMB) panel is active.

static ToolForPage(Page: str) → cStr[source]#: returns reference to the name of the current tool for the given page

static PrevToolForPage(Page: str) → cStr[source]#

static SetToolForPage(Page: str, tool: str)[source]#

static AutoUpdateToolForPage(tool: any, SubMode: int)[source]#

static GetCurrrentDefaultTool() → cStr[source]#

static TryToSetNewDefailtTool(Tool: str)[source]#

static ActivateToolCommandByName(name: str)[source]#: find and activate tool by it’s name

static ActivateLastCustomRoom()[source]#

ActivationSource: cStr = CreateToolsPanel#

static IsPythonScript(text: str) → bool[source]#

GetRoomFileInfo(idx: int, r: any) → bool[source]#

EditRoomParameters()[source]#

AddTool(ToolID: str, Section: str)[source]#

AddSection(SectionName: str)[source]#

RemoveThisRoom()[source]#

HideThisRoom()[source]#

Rename(NewName: str) → bool[source]#

SaveRoomLayout(filename: str)[source]#

LoadRoomLayout(filename: str)[source]#

AutoSaveRoomLayout()[source]#

EditCppItem(suffix: str)[source]#

AskAboutBaseToolset()[source]#

EditScript(path: str)[source]#

GetRoomFileRef(alias: str = 'room.xml') → cStr[source]#

CheckIfFilesChanged()[source]#

GetScript(suffix: str, script: cStr) → bool[source]#

GetPyScriptPath(suffix: str) → cStr[source]#

ExecuteScript(suffix: str, function: str = 'main')[source]#

DefaultsAvailable() → bool[source]#

RestoreDefaultScriptsAndLayout()[source]#

OnRmbOverItemInCustomMode(w: any)[source]#

CopyToolsetFromOtherRoom()[source]#

static Hide(ID: str)[source]#: Hiding management

static CheckHidden(ID: str, L: int = 0) → bool[source]#

static RemoveHidden(ID: str)[source]#

static HideSection(ID: str)[source]#

static UnHideSection(ID: str)[source]#

static HasSculptTools() → bool[source]#: Check for specific toolsets

static HasPaintTools() → bool[source]#

static HasRetopoTools() → bool[source]#

static HasModelingTools() → bool[source]#

static HasRender() → bool[source]#

static HasUVTools() → bool[source]#

GetPageID() → str[source]#

ToolsPriory: any#: Drag&dropped items

SortDragNDropped(List: any)[source]#

DragAndDropTool(Src: str, dst: str, before: int)[source]#

RaisePriory(Tool: str)[source]#

RestoreDefaultOrder()[source]#

AddCustomSectionAbove(SectionName: str, AbboveTool: str)[source]#

RenameSection(SectionName: str, NewName: str)[source]#

RemoveSection(SectionName: str)[source]#

static get_alias(str: cStr, alias: cStr)[source]#

static de_alias(id: cStr) → str[source]#

static pure_id(id: cStr) → str[source]#