c4d.plugins.HierarchyHelp¶

class c4d.plugins.HierarchyHelp¶

Provides read-only context for virtual object hierarchy evaluation.

Instances are provided by Cinema 4D in callbacks such as ObjectData.GetVirtualObjects() and Python generator main().

Overview¶

Evaluation Context
`HierarchyHelp.GetDocument()`	Returns the document for the current hierarchy evaluation.
`HierarchyHelp.GetMg()`	Returns the cached global matrix for the current hierarchy evaluation.
`HierarchyHelp.GetThread()`	Returns the calling thread for the hierarchy evaluation.
Evaluation State
`HierarchyHelp.GetBuildFlags()`	Returns the build flags for the current hierarchy evaluation.
`HierarchyHelp.GetLOD()`	Returns the level of detail for the current hierarchy evaluation.
`HierarchyHelp.IsProfilingEnabled()`	Returns if hierarchy profiling is enabled.

Members¶

Evaluation Context¶

HierarchyHelp.GetDocument(self)¶

Returns the document for the current hierarchy evaluation.

Return type: Optional[c4d.documents.BaseDocument]
Returns: The document, or None.

HierarchyHelp.GetMg(self)¶

Returns the cached global matrix for the current hierarchy evaluation.

Return type: c4d.Matrix
Returns: The global matrix.

HierarchyHelp.GetThread(self)¶

Returns the calling thread for the hierarchy evaluation.

Return type: Optional[c4d.threading.BaseThread]
Returns: The thread, or None.

Evaluation State¶

HierarchyHelp.GetBuildFlags(self)¶

Returns the build flags for the current hierarchy evaluation.

Return type

int

Returns

Flags:

Symbol ID	Description
BUILDFLAGS_NONE	The object is being built with no special context. This flag being set as the only flag is extremely rare and the actual ‘default’ flag is BUILDFLAGS_INTERACTIVEEDITOR.
BUILDFLAGS_INTERNALRENDERER	The object is being built for the internal render event.
BUILDFLAGS_EXTERNALRENDERER	The object is being built for an external render event. This covers the vast majority of render events these days. It is also common practice to check both render flags in tandem and treat them as one context.
BUILDFLAGS_ISOPARM	The object is being built for its iso-parametric representation, you must return a `c4d.LineObject` that is the iso-parametric representation of your object.
BUILDFLAGS_EXPORTONLY	The object is being built for export by a scene exporter plugin such as Alembic, FBX, USD, etc.
BUILDFLAGS_INTERACTIVEEDITOR	The object is being built for the viewport. This is the default context for building and what plugins will implicitly use when they do not explicitly check for build flags.
BUILDFLAGS_PRIVATE_NO_CLEAR_PASS	Internal, do not use.
BUILDFLAGS_PREROLL	The object is being built for a pre-roll event, e.g., a caching or rendering mechanism that is meant to start from a certain frame in the document and is now advancing through the timeline to reach that frame.
BUILDFLAGS_MAKEEDITABLE	The object is being built for being made editable. This happens when the user presses the C key or invokes the Make Editable command from the context menu in the Object Manager to collapse the object to its cache.

HierarchyHelp.GetLOD(self)¶

Returns the level of detail for the current hierarchy evaluation.

Return type: float
Returns: The level of detail.

HierarchyHelp.IsProfilingEnabled(self)¶

Returns if hierarchy profiling is enabled.

Return type: bool
Returns: True when profiling is enabled.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.