c4d.plugins.BaseDrawHelp

Contains useful data for drawing objects into a BaseDraw view.

Members

BaseDrawHelp.__init__(bd, doc)

Create a new help object for base draw bd.

Parameters:
Return type:

c4d.plugins.BaseDrawHelp

Returns:

The new base draw help object.

BaseDrawHelp.GetDocument()

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

Return type:c4d.documents.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:c4d.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:c4d.Matrix
Returns:The global matrix.
BaseDrawHelp.SetMg(mg)

Sets the matrix returned by GetMg().

Parameters:mg (c4d.Matrix) – New matrix.
BaseDrawHelp.GetDisplay()

Retrieves a container with the display mode for the object to be drawn. See Tdisplay.h for values.

Return type:c4d.BaseContainer
Returns:The display mode container.
BaseDrawHelp.SetDisplay(bc)

New in version R19.

Sets the display mode for the object to be drawn. See Tdisplay.h for values.

Parameters:bc (c4d.BaseContainer) – The new display mode container.
BaseDrawHelp.GetViewSchedulerFlags()

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

Return type:int
Returns:Flags:
DRAWFLAGS_NONE None.
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_NO_HIGHLIGHT_PLANE The entire view is drawn, not just the highlight plane.
DRAWFLAGS_FORCEFULLREDRAW Force full redraw.
DRAWFLAGS_ONLY_CAMERAEXPRESSION Camera expression.
DRAWFLAGS_INMOVE In move.
DRAWFLAGS_ONLY_BASEDRAW Draw specific base draw only.
DRAWFLAGS_ONLY_HIGHLIGHT Only highlights.
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.
BaseDrawHelp.IsActive()

New in version R14.014.

Checks if the current object is active.

Return type:bool
Returns:True if the current object is active.
BaseDrawHelp.IsHighlight()

New in version R14.014.

Checks if the current object is highlighted (i.e. when the user has moved the mouse over it).

Return type:bool
Returns:True if the current object is highlighted.