c4d.plugins.BaseDrawHelp

Contains useful data for drawing objects into a BaseDraw view.

Definition

class c4d.plugins.BaseDrawHelp

• BaseDrawHelp.GetDocument()
• BaseDrawHelp.GetActiveTag()

• BaseDrawHelp.GetMg()
• BaseDrawHelp.SetMg()

• BaseDrawHelp.GetViewSchedulerFlags() NEW

Members

BaseDrawHelp.GetDocument()

Returns the relevant document for the current draw operation, i.e. the currently active document. Never returns None.

Return type: BaseDocument Returns: The relevant document.

BaseDrawHelp.GetActiveTag()

Returns the currently active tag, or None if no tag is active (similar to BaseDocument.GetActiveTag() but more efficient since the active tag is cached).

Return type: BaseTag Returns: The active tag.

BaseDrawHelp.GetMg()

Returns the global matrix of the object to be drawn (similar to BaseObject.GetMg() but more efficient since the matrix is cached).

Return type: Matrix Returns: The global matrix.

BaseDrawHelp.SetMg(mg)

Sets the matrix returned by GetMg().

Parameters: mg (Matrix) – New matrix.

BaseDrawHelp.GetViewSchedulerFlags()

New in version R13.029.

Returns the flags which have been passed to DrawViews().

Return type: int Returns: Flags:

DRAWFLAGS_0	No flags
DRAWFLAGS_NO_THREAD	Synchronous call
DRAWFLAGS_NO_REDUCTION	Ignore redraw limit
DRAWFLAGS_NO_ANIMATION	Ignore all animation
DRAWFLAGS_ONLY_ACTIVE_VIEW	Only redraw the active view
DRAWFLAGS_NO_EXPRESSIONS	Ignore expressions
DRAWFLAGS_INDRAG	In drag.
DRAWFLAGS_FORCEFULLREDRAW	Force full redraw
DRAWFLAGS_ONLY_CAMERAEXPRESSION	Camera expression
DRAWFLAGS_INMOVE	Private
DRAWFLAGS_ONLY_BASEDRAW	Draw specific basedraw only
DRAWFLAGS_ONLY_HIGHLIGHT	Only highlight
DRAWFLAGS_STATICBREAK	If the display is done in the main thread (CINEMA 4D only does this during animation playback) this allows that a special thread is used that polls the escape key. Note: Use only in combination with DRAWFLAGS_NO_THREAD.
DRAWFLAGS_PRIVATE_NO_WAIT_GL_FINISHED	Private
DRAWFLAGS_PRIVATE_ONLYBACKGROUND	Private
DRAWFLAGS_PRIVATE_NOBLIT	Private
DRAWFLAGS_PRIVATE_OPENGLHACK	Private
DRAWFLAGS_PRIVATE_ONLY_PREPARE	Private
DRAWFLAGS_PRIVATE_NO_DCLIPPING	Private