3DCoat Python API
The 3DCoat Python API documentation.
Loading...
Searching...
No Matches
cCore.cExtension Class Reference

Public Member Functions

 __init__ (self)
 
 __init__ (self)
 
bool refresh_menu (self)
 
bool add_menu_item (self, str MenuPath, str MenuItem, str inRoom="", str inSection="", str Command="")
 
 onStop (self)
 
 onStart (self)
 
 onRestart (self)
 
bool menu_item (self, str item_name, any on_click)
 
 onMessage (self, str message)
 Call if another module sent message to this extension using cExtension.Message.
 
 onExtendMenu (self)
 insert some menu items to main menu
 
 onBuildMainMenu (self)
 on build the main menu
 
 onStartup (self)
 Call on startup, right before tools initialisation.
 
 afterInit (self)
 Call it after tools, graphics and shaders initialisation.
 
 preprocess (self)
 Call it once per frame, before tools processing.
 
 prerender (self)
 Call it once per frame, before the rendering stage.
 
 postprocess (self)
 Call it once per frame, after tools processing.
 
 postrender (self)
 Call it once per frame, after the rendering stage.
 
 afterUI (self)
 Call it once per frame, after the ui rendering, before the topmost elements.
 
 thumbnail (self)
 Call it once per frame to draw thumbnails.
 
 afterSettings (self)
 Call it once after settings loading.
 
 onNew (self)
 Call it as soon as user starts new scene.
 
 onKey (self)
 Call it as soon as user pressed the key, get the key value from Widgets.lastKey.
 
 onDropFile (self)
 Call if file dropped using drag&drop, filename is in Widgets.LastDroppedFile.
 
 onChangeTool (self)
 called when the current tool changes
 
 onChangeRoom (self)
 called when the current room changes
 
 onUndo (self)
 called when the undo triggered
 
 onRedo (self)
 called when the redo triggered
 
 onSaveScene (self)
 called before the saving the scene
 
 onExit (self)
 called before the exit
 

Static Public Member Functions

bool Message (str extension_name, str message)
 
int ProcessID ()
 
int DebugPort ()
 
any globalScope ()
 
int begin_work_in_bg ()
 
int end_work_in_bg ()
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

cCore.cExtension.__init__ ( self)

◆ __init__() [2/2]

cCore.cExtension.__init__ ( self)

Member Function Documentation

◆ add_menu_item()

bool cCore.cExtension.add_menu_item ( self,
str MenuPath,
str MenuItem,
str inRoom = "",
str inSection = "",
str Command = "" )

◆ afterInit()

cCore.cExtension.afterInit ( self)

Call it after tools, graphics and shaders initialisation.

◆ afterSettings()

cCore.cExtension.afterSettings ( self)

Call it once after settings loading.

◆ afterUI()

cCore.cExtension.afterUI ( self)

Call it once per frame, after the ui rendering, before the topmost elements.

◆ begin_work_in_bg()

int cCore.cExtension.begin_work_in_bg ( )
static

◆ DebugPort()

int cCore.cExtension.DebugPort ( )
static

◆ end_work_in_bg()

int cCore.cExtension.end_work_in_bg ( )
static

◆ globalScope()

any cCore.cExtension.globalScope ( )
static

◆ menu_item()

bool cCore.cExtension.menu_item ( self,
str item_name,
any on_click )

◆ Message()

bool cCore.cExtension.Message ( str extension_name,
str message )
static

◆ onBuildMainMenu()

cCore.cExtension.onBuildMainMenu ( self)

on build the main menu

◆ onChangeRoom()

cCore.cExtension.onChangeRoom ( self)

called when the current room changes

◆ onChangeTool()

cCore.cExtension.onChangeTool ( self)

called when the current tool changes

◆ onDropFile()

cCore.cExtension.onDropFile ( self)

Call if file dropped using drag&drop, filename is in Widgets.LastDroppedFile.

Set it empty if you acquired the file.

◆ onExit()

cCore.cExtension.onExit ( self)

called before the exit

◆ onExtendMenu()

cCore.cExtension.onExtendMenu ( self)

insert some menu items to main menu

◆ onKey()

cCore.cExtension.onKey ( self)

Call it as soon as user pressed the key, get the key value from Widgets.lastKey.

Set it to 0 if the key captured and des not need to be propagated anymore.

◆ onMessage()

cCore.cExtension.onMessage ( self,
str message )

Call if another module sent message to this extension using cExtension.Message.

◆ onNew()

cCore.cExtension.onNew ( self)

Call it as soon as user starts new scene.

◆ onRedo()

cCore.cExtension.onRedo ( self)

called when the redo triggered

◆ onRestart()

cCore.cExtension.onRestart ( self)

◆ onSaveScene()

cCore.cExtension.onSaveScene ( self)

called before the saving the scene

◆ onStart()

cCore.cExtension.onStart ( self)

◆ onStartup()

cCore.cExtension.onStartup ( self)

Call on startup, right before tools initialisation.

◆ onStop()

cCore.cExtension.onStop ( self)

◆ onUndo()

cCore.cExtension.onUndo ( self)

called when the undo triggered

◆ postprocess()

cCore.cExtension.postprocess ( self)

Call it once per frame, after tools processing.

◆ postrender()

cCore.cExtension.postrender ( self)

Call it once per frame, after the rendering stage.

◆ preprocess()

cCore.cExtension.preprocess ( self)

Call it once per frame, before tools processing.

◆ prerender()

cCore.cExtension.prerender ( self)

Call it once per frame, before the rendering stage.

◆ ProcessID()

int cCore.cExtension.ProcessID ( )
static

◆ refresh_menu()

bool cCore.cExtension.refresh_menu ( self)

◆ thumbnail()

cCore.cExtension.thumbnail ( self)

Call it once per frame to draw thumbnails.


The documentation for this class was generated from the following file: