blender::draw::overlay::Relations Class Reference

#include <overlay_relation.hh>

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

Public Member Functions
	Relations (SelectionType selection_type)
void	begin_sync (Resources &res, const State &state) final
void	object_sync (Manager &, const ObjectRef &ob_ref, Resources &res, const State &state) final
void	end_sync (Resources &res, const State &state) final
void	draw_line (Framebuffer &framebuffer, Manager &manager, View &view) final

Detailed Description

Display object relations as dashed lines. Covers parenting relationships and constraints.

Definition at line 26 of file overlay_relation.hh.

Constructor & Destructor Documentation

Relations()

blender::draw::overlay::Relations::Relations ( SelectionType selection_type )

inline

Definition at line 35 of file overlay_relation.hh.

Member Function Documentation

begin_sync()

void blender::draw::overlay::Relations::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 41 of file overlay_relation.hh.

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

draw_line()

void blender::draw::overlay::Relations::draw_line ( Framebuffer & framebuffer, Manager & manager, View & view )

inlinefinalvirtual

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

Definition at line 219 of file overlay_relation.hh.

References blender::draw::overlay::Overlay::enabled_, GPU_framebuffer_bind(), and view.

end_sync()

void blender::draw::overlay::Relations::end_sync ( Resources & , const State &  )

inlinefinalvirtual

Finalize passes or buffers used for object sync. Runs once at the start of the sync cycle.

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

Definition at line 191 of file overlay_relation.hh.

References DRW_CLIPPING_UBO_SLOT, DRW_STATE_DEPTH_LESS_EQUAL, DRW_STATE_WRITE_COLOR, DRW_STATE_WRITE_DEPTH, blender::draw::overlay::Overlay::enabled_, OVERLAY_GLOBALS_SLOT, blender::draw::detail::PassBase< DrawCommandBufType >::shader_set(), state, and blender::draw::detail::PassBase< DrawCommandBufType >::state_set().

object_sync()

void blender::draw::overlay::Relations::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 51 of file overlay_relation.hh.

References BKE_constraint_custom_object_space_init(), BKE_constraint_targets_flush(), BKE_constraint_targets_get(), BKE_constraint_typeinfo_get(), BKE_constraints_make_evalob(), BLI_listbase_is_empty(), Scene::camera, HookGpencilModifierData::cent, HookModifierData::cent, CONSTRAINT_OBTYPE_OBJECT, CONSTRAINT_TAR_CUSTOM_SPACE, CONSTRAINT_TYPE_FOLLOWTRACK, CONSTRAINT_TYPE_OBJECTSOLVER, Object::constraints, data, DEG_get_ctime(), DRW_object_visibility_in_active_context(), eGpencilModifierType_Hook, ELEM, eModifierType_Hook, blender::draw::overlay::Overlay::enabled_, bConstraintTypeInfo::get_target_matrix, Object::greasepencil_modifiers, blender::draw::overlay::is_from_dupli_or_set(), MEM_freeN(), Object::modifiers, RigidBodyCon::ob1, RigidBodyCon::ob2, OB_VISIBLE_SELF, HookGpencilModifierData::object, HookModifierData::object, Object::parent, Object::rigidbody_constraint, Object::runtime, bConstraintOb::space_obj_world_matrix, state, and blender::math::transform_point().

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

---

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

• overlay_relation.hh