CodeExchangeInterface Class Reference
#include <code_exchange.h>
Inheritance diagram for CodeExchangeInterface:
Detailed Description
Manages communication to exchange code from Cinema 4D to IDE.
Public Member Functions | |
| MAXON_METHOD Result< void > | Start () |
| MAXON_METHOD Result< void > | Stop () |
| MAXON_METHOD Result< void > | SendScriptToIDE (const PythonElementScriptRef &script) |
| MAXON_METHOD Result< void > | SendConsoleOutput (const String &content) |
| MAXON_METHOD InternedId | GetLanguage () const |
| MAXON_METHOD String | GetName () const |
Private Member Functions | |
| MAXON_INTERFACE (CodeExchangeInterface, MAXON_REFERENCE_NORMAL, "net.maxon.python.interface.codeexchange") | |
Member Function Documentation
◆ MAXON_INTERFACE()
|
private |
◆ Start()
| MAXON_METHOD Result<void> Start | ( | ) |
Called when the Code Exchange is enabled in the preference or during the startup of Cinema 4D.
◆ Stop()
| MAXON_METHOD Result<void> Stop | ( | ) |
Called when the Code Exchange is disabled in the preference or during the ending of Cinema 4D.
◆ SendScriptToIDE()
| MAXON_METHOD Result<void> SendScriptToIDE | ( | const PythonElementScriptRef & | script | ) |
Send the given Python Script to all IDE
- Parameters
-
[in] script The Python script to send
◆ SendConsoleOutput()
| MAXON_METHOD Result<void> SendConsoleOutput | ( | const String & | content | ) |
Send the Python Console to all IDE
- Parameters
-
[in] content The new line in the Python logger
◆ GetLanguage()
| MAXON_METHOD InternedId GetLanguage | ( | ) | const |
Defines which language the code exchange should be used
- Returns
- The ID representing the used language, see maxon::CodeExchangeLanguageId
◆ GetName()
| MAXON_METHOD String GetName | ( | ) | const |
Names of the Code Exchange, this will be used in the Cinema 4D preference under the extension entry.
- Returns
- The name of the current implementation