Detailed Description

Handles communication of codes from Cinema 4D to IDE and vice versa.

Public Member Functions
MAXON_METHOD Result< void >	Start ()

MAXON_METHOD Result< void >	Stop ()

MAXON_METHOD Bool	IsRunning ()

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

MAXON_METHOD SubDialog *	GetSubDialogSetting () const

Private Member Functions
	MAXON_INTERFACE (CodeExchangerInterface, MAXON_REFERENCE_NORMAL, "net.maxon.python.interface.codeexchanger")

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE	(	CodeExchangerInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.python.interface.codeexchanger"
	)

private

◆ Start()

MAXON_METHOD Result<void> Start ( )

Starts the service that send and receive code in Cinema 4D.

◆ Stop()

MAXON_METHOD Result<void> Stop ( )

Stops the service that send and receive code in Cinema 4D.

◆ IsRunning()

MAXON_METHOD Bool IsRunning ( )

Returns the Code Exchanger running state.

Returns: true if the Code Exchanger is in a state that can send or receive code otherwise, false.

◆ SendScriptToIDE()

MAXON_METHOD Result<void> SendScriptToIDE ( const PythonElementScriptRef & script )

Send the given Python Script to the IDE.

Parameters

[in] script The Python script to send.

◆ SendConsoleOutput()

MAXON_METHOD Result<void> SendConsoleOutput ( const String & content )

Send a string to be displayed in the IDE console.

Parameters

[in] content The string to send in the IDE console.

◆ GetLanguage()

MAXON_METHOD InternedId GetLanguage ( ) const

Defines which language the code exchanger should be used.

Returns: The ID representing the used language, see maxon::CodeExchangerLanguageId

◆ GetName()

MAXON_METHOD String GetName ( ) const

Returns the names of the Code Exchanger.

Note: It is used in the Code Exchanger Settings.

Returns: The name of the current implementation

◆ GetSubDialogSetting()

MAXON_METHOD SubDialog* GetSubDialogSetting ( ) const

Returns the dialog to be displayed in the Code Exchanger Settings.

Returns: The sub dialog that will handle settings for this code exchanger.