c4d.threading¶
-
class
c4d.threading¶
c4d.threading.BaseThread and its implementable child class c4d.threading.C4DThread are a replacement for the builtin threading module threading of Python. They ensure the compatibility of Python code executed in parallel with the threading system of Cinema 4D implemented in C++ and should always be used in favor of the builtin threading module of Python.C4DThread, just as its native Python counterpart threading.Thread, is a mechanism to decouple the execution of code, but not to speed it up. Its intended use is to make computationally complex tasks non-blocking for the main-thread of Cinema 4D and by that ensure the responsiveness of the user interface. Parallelism in the sense of executing multiple parts of a larger task in parallel is currently not offered by the Python SDK. This also applies by extension to the multiprocessing module of Python which offers such functionality but it is not supported by Cinema 4D. Trying to use C4DThread to speed up the parallel execution of such multiple parts task will not only yield no execution speed improvements but will most likely even be slower than a single threaded execution of the same task. See also
The important Threading Manual.
Types
Functions Signatures
Deprecated
Gets the number of threads available. |
Uncategorized
Locks using a global semaphore.
|
|
Continues blocked threads after a call to |
|
Checks if the code is run from within the main thread of Cinema 4D. |
|
Checks if code is run from within the main thread of Cinema 4D and if the main thread does not execute any drawing code currently. |
|
Gets the number of threads available. |
|
Returns a unique ID for the current thread. |
|
Identifies a thread’s type. |
|
Returns the current thread. |
|
Returns a dummy thread. The thread’s |
|
Returns a dummy thread for escape key testing.
|
|
Checks if any of the threads matching typeclass is running. |
|
Stops all running background threads of the given typeclass. |
Functions Documentation
-
c4d.threading.GeGetCPUCount()¶ Gets the number of threads available.
Deprecated since version R16.
Use
threading.GeGetCurrentThreadCount()- Return type
int
- Returns
The number of current threads.
-
c4d.threading.GeThreadLock()¶ - Locks using a global semaphore.When locked, any other thread trying to acquire the lock will have to wait.Other threads will continue.
Note
As this blocks all threads it should only be used if and when necessary.A local semaphore is a more elegant and efficient solution to multiple thread data access.
-
c4d.threading.GeThreadUnlock()¶ Continues blocked threads after a call to
GeThreadLock().
-
c4d.threading.GeIsMainThread()¶ Checks if the code is run from within the main thread of Cinema 4D.
- Return type
bool
- Returns
True if called from the main thread, otherwise False.
-
c4d.threading.GeIsMainThreadAndNoDrawThread()¶ Checks if code is run from within the main thread of Cinema 4D and if the main thread does not execute any drawing code currently.
New in version R16.038.
Note
This routine can be used to make sure that no illegal code is called during a drawing operation.In Cinema 4D the drawing will be started threaded or non-threaded, depending on the situation.It is not allowed to add e.g. undo or delete objects or materials while the drawing is in progress (this would lead to immediate crashes).If code calls other routines that are not aware of their context (e.g. some code within a Message() that does not know whether it was called from a drawing thread or during a command call).GeIsMainThreadAndNoDrawThread()can be used to detect the correct situation.- Return type
bool
- Returns
True if called from the main thread and main thread does not execute a drawing operation, otherwise False.
-
c4d.threading.GeGetCurrentThreadCount()¶ Gets the number of threads available.
New in version R16.021.
- Return type
int
- Returns
The number of current threads.
-
c4d.threading.GeGetCurrentThreadId()¶ Returns a unique ID for the current thread.
Note
Usually do not care about this.
- Return type
int
- Returns
The unique ID for the current thread.
-
c4d.threading.IdentifyThread(bt)¶ Identifies a thread’s type.
- Parameters
bt (BaseThread) – The thread to identify.
- Return type
int
- Returns
The thread type:
THREADTYPE_NONE
None.
THREADTYPE_EDITORREDRAW
Editor redraw.
THREADTYPE_RENDEREDITOR
Editor render.
THREADTYPE_RENDEREXTERNAL
External render.
-
c4d.threading.GeGetCurrentThread()¶ Returns the current thread.
- Return type
- Returns
The current thread.
-
c4d.threading.GeGetDummyThread()¶ Returns a dummy thread. The thread’s
BaseThread.TestBreak()function always returns False.New in version R17.048.
- Return type
- Returns
A dummy thread .
-
c4d.threading.GeGetEscTestThread()¶ - Returns a dummy thread for escape key testing.The thread’s
BaseThread.TestBreak()function returns True when the user presses the escape key.New in version R17.048.
- Return type
- Returns
An escape key test thread.
-
c4d.threading.GeCheckBackgroundThreadsRunning(typeclass, all)¶ Checks if any of the threads matching typeclass is running.
- Parameters
typeclass (int) –
The type class of the background threads to check. If 0, all threads are checked. Pass BACKGROUNDHANDLER_TYPECLASS_C4D to check Cinema 4D background handlers.For example GeCheckBackgroundThreadsRunning(BACKGROUNDHANDLER_TYPECLASS_C4D, True) checks if Cinema 4D is doing anything right now.If False were passed it would not check for the external renderer (which are always running in a BodyPaint 3D selection).all (bool) – If True then background handler with negative priority are also checked.
- Return type
bool
- Returns
True if the specified threads are running, otherwise False.
-
c4d.threading.GeStopBackgroundThreads(typeclass, flags)¶ Stops all running background threads of the given typeclass.
- Parameters
typeclass (int) – The type class of the background threads to stop. If 0, all threads are stopped. Pass BACKGROUNDHANDLER_TYPECLASS_C4D to stop Cinema 4D background handlers.
flags (int) –
If typeclass is BACKGROUNDHANDLER_TYPECLASS_C4D then the following flags can be used:BACKGROUNDHANDLERFLAGS_NONE
None.
BACKGROUNDHANDLERFLAGS_VIEWREDRAW
View redraw.
BACKGROUNDHANDLERFLAGS_EDITORRENDDER
Editor render.
BACKGROUNDHANDLERFLAGS_MATERIALPREVIEW
Material preview.
BACKGROUNDHANDLERFLAGS_RENDEREXTERNAL
Render external.
BACKGROUNDHANDLERFLAGS_PRIVATE_VIEWREDRAW
Private.
BACKGROUNDHANDLERFLAGS_SHUTDOWN
Shutdown.
GeStopBackgroundThreads(BACKGROUNDHANDLER_TYPECLASS_C4D, BACKGROUNDHANDLER_FLAGS_EDITORRENDDER) only stops the editor renderer (if it was running).GeStopBackgroundThreads(0, BACKGROUNDHANDLERFLAGS_SHUTDOWN) kills anything running.Pass flags as needed for custom type classes, they will be routed to the background handler function.