#include "DNA_camera_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "MEM_guardedalloc.h"
#include "BLI_math_matrix.h"
#include "BLI_math_rotation.h"
#include "BLI_math_vector.h"
#include "BLI_utildefines.h"
#include "BKE_object.hh"
#include "DEG_depsgraph.hh"
#include "view3d_intern.hh"

Classes
struct	View3DCameraControl

Functions
BLI_INLINE Object *	view3d_cameracontrol_object (const View3DCameraControl *vctrl)

Object *	ED_view3d_cameracontrol_object_get (View3DCameraControl *vctrl)

View3DCameraControl *	ED_view3d_cameracontrol_acquire (Depsgraph depsgraph, Scene scene, View3D v3d, RegionView3D rv3d)

static bool	object_apply_mat4_with_protect (Object ob, const float obmat[4][4], const bool use_parent, RegionView3D rv3d, const float view_mat[4][4])

void	ED_view3d_cameracontrol_update (View3DCameraControl vctrl, const bool use_autokey, bContext C, const bool do_rotate, const bool do_translate)

void	ED_view3d_cameracontrol_release (View3DCameraControl *vctrl, const bool restore)

Detailed Description

The purpose of View3DCameraControl is to allow editing rv3d manipulation (mainly ofs and viewquat) for the purpose of view navigation without having to worry about positioning the camera, its parent... or other details. Typical view-control usage:

Acquire a view-control (ED_view3d_cameracontrol_acquire).
Modify rv3d->ofs, rv3d->viewquat.
Update the view data (ED_view3d_cameracontrol_acquire) - within a loop which draws the viewport.
Finish and release the view-control (ED_view3d_cameracontrol_release), either keeping the current view or restoring the initial view.

Notes:

when acquiring rv3d->dist is set to zero (so rv3d->ofs is always the view-point)
updating can optionally keyframe the camera object.

Definition in file view3d_camera_control.cc.

Function Documentation

◆ ED_view3d_cameracontrol_acquire()

View3DCameraControl * ED_view3d_cameracontrol_acquire	(	Depsgraph *	depsgraph,
		Scene *	scene,
		View3D *	v3d,
		RegionView3D *	rv3d )

Creates a View3DCameraControl handle and sets up the view for first-person style navigation.

Definition at line 112 of file view3d_camera_control.cc.

Referenced by initFlyInfo(), and initWalkInfo().

◆ ED_view3d_cameracontrol_object_get()

Object * ED_view3d_cameracontrol_object_get ( View3DCameraControl * vctrl )

Returns the object which is being manipulated or NULL.

Definition at line 101 of file view3d_camera_control.cc.

References View3DCameraControl::ctx_rv3d, RegionView3D::persp, RV3D_CAMOB, and view3d_cameracontrol_object().

Referenced by drawFlyPixel(), drawWalkPixel(), fly_modal(), initFlyInfo(), and walk_modal().

◆ ED_view3d_cameracontrol_release()

void ED_view3d_cameracontrol_release	(	View3DCameraControl *	vctrl,
		bool	restore )

Release view control.

Parameters

restore Sets the view state to the values that were set before #ED_view3d_control_acquire was called.

Definition at line 305 of file view3d_camera_control.cc.

Referenced by flyEnd(), and walkEnd().

◆ ED_view3d_cameracontrol_update()

void ED_view3d_cameracontrol_update	(	View3DCameraControl *	vctrl,
		bool	use_autokey,
		bContext *	C,
		bool	do_rotate,
		bool	do_translate )

Updates cameras from the rv3d values, optionally auto-keyframing.

Definition at line 235 of file view3d_camera_control.cc.

References View3D::camera, copy_m4_m4(), copy_v3_v3(), View3DCameraControl::ctx_rv3d, View3DCameraControl::ctx_scene, View3DCameraControl::ctx_v3d, DEG_id_tag_update(), RegionView3D::dist, ED_view3d_camera_autokey(), ED_view3d_to_m4(), Object::id, ID_RECALC_TRANSFORM, invert_m4_m4(), mul_m4_m4m4(), object_apply_mat4_with_protect(), RegionView3D::ofs, Object::parent, View3DCameraControl::root_parent, Object::scale, size_to_mat4(), View3DCameraControl::view_mat_prev, and RegionView3D::viewquat.

Referenced by flyMoveCamera(), and walkMoveCamera().

◆ object_apply_mat4_with_protect()

static bool object_apply_mat4_with_protect	(	Object *	ob,
		const float	obmat[4][4],
		const bool	use_parent,
		RegionView3D *	rv3d,
		const float	view_mat[4][4] )

static

A version of BKE_object_apply_mat4 that respects Object.protectflag, applying the locking back to the view to avoid the view. This is needed so the view doesn't get out of sync with the object, causing visible jittering when in fly/walk mode for e.g.

Note: This could be exposed as an API option, as we might not want the view to be constrained by the thing it's controlling.

Definition at line 194 of file view3d_camera_control.cc.

References BKE_object_apply_mat4(), BKE_object_tfm_protected_backup(), BKE_object_tfm_protected_restore(), BKE_object_to_mat4(), RegionView3D::dist, ED_view3d_from_m4(), equals_m4m4(), invert_m4_m4(), mul_m4_m4m4(), RegionView3D::ofs, Object::protectflag, and RegionView3D::viewquat.

Referenced by ED_view3d_cameracontrol_update().

◆ view3d_cameracontrol_object()

BLI_INLINE Object * view3d_cameracontrol_object ( const View3DCameraControl * vctrl )

Definition at line 96 of file view3d_camera_control.cc.

References View3D::camera, View3DCameraControl::ctx_v3d, and View3DCameraControl::root_parent.

Referenced by ED_view3d_cameracontrol_object_get(), and ED_view3d_cameracontrol_release().

Classes

Functions