blender::draw::overlay::Names Class Reference

#include <overlay_name.hh>

Inherits blender::draw::overlay::Overlay.

Public Member Functions
void	begin_sync (Resources &res, const State &state) final
void	object_sync (Manager &, const ObjectRef &ob_ref, Resources &res, const State &state) final

Detailed Description

Display object names next to their origin. The option can be found under (Object > Viewport Display > Show > Name).

Definition at line 21 of file overlay_name.hh.

Member Function Documentation

begin_sync()

void blender::draw::overlay::Names::begin_sync ( Resources & , const State &  )

inlinefinalvirtual

Synchronization creates and fill render passes based on context state and scene state.

It runs for every scene update, so keep computation overhead low. If it is triggered, everything in the scene is considered updated. Note that this only concerns the render passes, the mesh batch caches are updated on a per object-data basis.

IMPORTANT: Synchronization must be view agnostic. That is, not rely on view position, projection matrix or frame-buffer size to do conditional pass creation. This is because, by design, syncing can happen once and rendered multiple time (multi view rendering, stereo rendering, orbiting view ...). Conditional pass creation, must be done in the drawing callbacks, but they should remain the exception. Also there will be no access to object data at this point. Creates passes used for object sync and enabling / disabling internal overlay types (e.g. vertices, edges, faces in edit mode). Runs once at the start of the sync cycle. Should also contain passes setup for overlays that are not per object overlays (e.g. Grid).

This method must be implemented.

Implements blender::draw::overlay::Overlay.

Definition at line 23 of file overlay_name.hh.

References blender::draw::overlay::Overlay::enabled_, and state.

object_sync()

void blender::draw::overlay::Names::object_sync ( Manager & , const ObjectRef & , Resources & , const State &  )

inlinefinalvirtual

Fills passes or buffers for each object. Runs for each individual object state. IMPORTANT: Can run only once for instances using the same state (ObjectRef might contains instancing data).

Reimplemented from blender::draw::overlay::Overlay.

Definition at line 33 of file overlay_name.hh.

References DRW_text_cache_add(), DRW_TEXT_CACHE_GLOBALSPACE, DRW_TEXT_CACHE_STRING_PTR, Object::dtx, blender::draw::overlay::Overlay::enabled_, Object::id, blender::draw::overlay::is_from_dupli_or_set(), ID::name, OB_DRAWNAME, state, and UI_GetThemeColor4ubv().

Referenced by blender::draw::overlay::Instance::object_sync().

---

The documentation for this class was generated from the following file:

• overlay_name.hh