Blender  V2.93
Classes
view3d_utils.c File Reference
Blender » Editors » 3D view
#include <float.h>
#include <math.h>
#include <stdio.h>
#include <string.h>
#include "DNA_camera_types.h"
#include "DNA_curve_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_world_types.h"
#include "MEM_guardedalloc.h"
#include "BLI_array_utils.h"
#include "BLI_bitmap_draw_2d.h"
#include "BLI_blenlib.h"
#include "BLI_math.h"
#include "BLI_utildefines.h"
#include "BKE_camera.h"
#include "BKE_context.h"
#include "BKE_object.h"
#include "BKE_scene.h"
#include "BKE_screen.h"
#include "DEG_depsgraph.h"
#include "DEG_depsgraph_query.h"
#include "BIF_glutil.h"
#include "GPU_matrix.h"
#include "WM_api.h"
#include "WM_types.h"
#include "ED_keyframing.h"
#include "ED_screen.h"
#include "ED_view3d.h"
#include "UI_resources.h"
#include "view3d_intern.h"

Go to the source code of this file.

Classes

struct  PointsInPlanesMinMax_UserData
 
struct  ReadData
 

Functions

View Data Access Utilities
void ED_view3d_background_color_get (const Scene *scene, const View3D *v3d, float r_color[3])
 
bool ED_view3d_has_workbench_in_texture_color (const Scene *scene, const Object *ob, const View3D *v3d)
 
Camera * ED_view3d_camera_data_get (View3D *v3d, RegionView3D *rv3d)
 
void ED_view3d_dist_range_get (const View3D *v3d, float r_dist_range[2])
 
bool ED_view3d_clip_range_get (Depsgraph *depsgraph, const View3D *v3d, const RegionView3D *rv3d, float *r_clipsta, float *r_clipend, const bool use_ortho_factor)
 
bool ED_view3d_viewplane_get (Depsgraph *depsgraph, const View3D *v3d, const RegionView3D *rv3d, int winx, int winy, rctf *r_viewplane, float *r_clip_start, float *r_clip_end, float *r_pixsize)
 
View State/Context Utilities
void view3d_operator_needs_opengl (const bContext *C)
 
void view3d_region_operator_needs_opengl (wmWindow *UNUSED(win), ARegion *region)
 
void ED_view3d_polygon_offset (const RegionView3D *rv3d, const float dist)
 
bool ED_view3d_context_activate (bContext *C)
 
View Clipping Utilities
void ED_view3d_clipping_calc_from_boundbox (float clip[4][4], const BoundBox *bb, const bool is_flip)
 
void ED_view3d_clipping_calc (BoundBox *bb, float planes[4][4], const ARegion *region, const Object *ob, const rcti *rect)
 
View Clipping Clamp Min/Max
static void points_in_planes_minmax_fn (const float co[3], int UNUSED(i), int UNUSED(j), int UNUSED(k), void *user_data_p)
 
bool ED_view3d_clipping_clamp_minmax (const RegionView3D *rv3d, float min[3], float max[3])
 
View Bound-Box Utilities
static bool view3d_boundbox_clip_m4 (const BoundBox *bb, const float persmatob[4][4])
 
bool ED_view3d_boundbox_clip_ex (const RegionView3D *rv3d, const BoundBox *bb, float obmat[4][4])
 
bool ED_view3d_boundbox_clip (RegionView3D *rv3d, const BoundBox *bb)
 
View Perspective & Mode Switching

Misc view utility functions.

bool ED_view3d_offset_lock_check (const View3D *v3d, const RegionView3D *rv3d)
 
void ED_view3d_lastview_store (RegionView3D *rv3d)
 
void ED_view3d_lock_clear (View3D *v3d)
 
void ED_view3d_persp_switch_from_camera (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d, const char persp)
 
bool ED_view3d_persp_ensure (const Depsgraph *depsgraph, View3D *v3d, ARegion *region)
 
Camera Lock API

Lock the camera to the 3D Viewport, allowing view manipulation to transform the camera.

bool ED_view3d_camera_lock_check (const View3D *v3d, const RegionView3D *rv3d)
 
void ED_view3d_camera_lock_init_ex (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d, const bool calc_dist)
 
void ED_view3d_camera_lock_init (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d)
 
bool ED_view3d_camera_lock_sync (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d)
 
bool ED_view3d_camera_autokey (const Scene *scene, ID *id_key, struct bContext *C, const bool do_rotate, const bool do_translate)
 
bool ED_view3d_camera_lock_autokey (View3D *v3d, RegionView3D *rv3d, struct bContext *C, const bool do_rotate, const bool do_translate)
 
Box View Support

Use with quad-split so each view is clipped by the bounds of each view axis.

static void view3d_boxview_clip (ScrArea *area)
 
static void view3d_boxview_sync_axis (RegionView3D *rv3d_dst, RegionView3D *rv3d_src)
 
void view3d_boxview_sync (ScrArea *area, ARegion *region)
 
void view3d_boxview_copy (ScrArea *area, ARegion *region)
 
void ED_view3d_quadview_update (ScrArea *area, ARegion *region, bool do_clip)
 
View Auto-Depth Utilities
static float view_autodist_depth_margin (ARegion *region, const int mval[2], int margin)
 
bool ED_view3d_autodist (Depsgraph *depsgraph, ARegion *region, View3D *v3d, const int mval[2], float mouse_worldloc[3], const bool UNUSED(alphaoverride), const float fallback_depth_pt[3])
 
bool ED_view3d_autodist_simple (ARegion *region, const int mval[2], float mouse_worldloc[3], int margin, const float *force_depth)
 
bool ED_view3d_autodist_depth (ARegion *region, const int mval[2], int margin, float *depth)
 
static bool depth_segment_cb (int x, int y, void *userData)
 
bool ED_view3d_autodist_depth_seg (ARegion *region, const int mval_sta[2], const int mval_end[2], int margin, float *depth)
 
View Radius/Distance Utilities

Use to calculate a distance to a point based on its radius.

float ED_view3d_radius_to_dist_persp (const float angle, const float radius)
 
float ED_view3d_radius_to_dist_ortho (const float lens, const float radius)
 
float ED_view3d_radius_to_dist (const View3D *v3d, const ARegion *region, const struct Depsgraph *depsgraph, const char persp, const bool use_aspect, const float radius)
 
View Distance Utilities
float ED_view3d_offset_distance (const float mat[4][4], const float ofs[3], const float fallback_dist)
 
void ED_view3d_distance_set (RegionView3D *rv3d, const float dist)
 
bool ED_view3d_distance_set_from_location (RegionView3D *rv3d, const float dist_co[3], const float dist_min)
 
View Transform Utilities
void ED_view3d_from_m4 (const float mat[4][4], float ofs[3], float quat[4], const float *dist)
 
void ED_view3d_to_m4 (float mat[4][4], const float ofs[3], const float quat[4], const float dist)
 
void ED_view3d_from_object (const Object *ob, float ofs[3], float quat[4], float *dist, float *lens)
 
void ED_view3d_to_object (const Depsgraph *depsgraph, Object *ob, const float ofs[3], const float quat[4], const float dist)
 
bool ED_view3d_camera_to_view_selected (struct Main *bmain, Depsgraph *depsgraph, const Scene *scene, Object *camera_ob)
 
Depth Buffer Utilities
static bool depth_read_test_fn (const void *value, void *userdata)
 
bool ED_view3d_depth_read_cached (const ViewDepths *vd, const int mval[2], int margin, float *r_depth)
 
bool ED_view3d_depth_read_cached_normal (const ViewContext *vc, const int mval[2], float r_normal[3])
 
bool ED_view3d_depth_unproject (const ARegion *region, const int mval[2], const double depth, float r_location_world[3])
 
void ED_view3d_depth_tag_update (RegionView3D *rv3d)
 

View Axis Utilities

static float view3d_quat_axis [6][4][4]
 
bool ED_view3d_quat_from_axis_view (const char view, const char view_axis_roll, float r_quat[4])
 
bool ED_view3d_quat_to_axis_view (const float quat[4], const float epsilon, char *r_view, char *r_view_axis_roll)
 
char ED_view3d_lock_view_from_index (int index)
 
char ED_view3d_axis_view_opposite (char view)
 
bool ED_view3d_lock (RegionView3D *rv3d)
 

Detailed Description

3D View checks and manipulation (no operators).

Definition in file view3d_utils.c.

Function Documentation

◆ depth_read_test_fn()

static bool depth_read_test_fn ( const void *  value,
void *  userdata 
)
static

Definition at line 1639 of file view3d_utils.c.

References data, and ReadData::r_depth.

Referenced by ED_view3d_depth_read_cached().

◆ depth_segment_cb()

static bool depth_segment_cb ( int  x,
int  y,
void *  userData 
)
static

Definition at line 1104 of file view3d_utils.c.

References data, view_autodist_depth_margin(), x, and y.

Referenced by ED_view3d_autodist_depth_seg().

◆ ED_view3d_autodist()

bool ED_view3d_autodist ( Depsgraph *  depsgraph,
ARegion *  region,
View3D *  v3d,
const int  mval[2],
float  mouse_worldloc[3],
const bool   UNUSEDalphaoverride,
const float  fallback_depth_pt[3] 
)

Get the world-space 3d location from a screen-space 2d point. TODO: Implement #alphaoverride. We don't want to zoom into billboards.

Parameters
mvalInput screen-space pixel location.
mouse_worldlocOutput world-space location.
fallback_depth_ptUse this points depth when no depth can be found.

Definition at line 1034 of file view3d_utils.c.

References ARRAY_SIZE, depsgraph, ED_view3d_depth_override(), ED_view3d_unproject(), ED_view3d_win_to_3d_int(), float(), NULL, V3D_DEPTH_NO_GPENCIL, and view_autodist_depth_margin().

◆ ED_view3d_autodist_depth()

bool ED_view3d_autodist_depth ( ARegion *  region,
const int  mval[2],
int  margin,
float *  depth 
)

Definition at line 1097 of file view3d_utils.c.

References view_autodist_depth_margin().

Referenced by annotation_stroke_newfrombuffer(), gpencil_get_depth_array(), gpencil_primitive_update_strokes(), and gpencil_stroke_newfrombuffer().

◆ ED_view3d_autodist_depth_seg()

bool ED_view3d_autodist_depth_seg ( ARegion *  region,
const int  mval_sta[2],
const int  mval_end[2],
int  margin,
float *  depth 
)

Definition at line 1126 of file view3d_utils.c.

References BLI_bitmap_draw_2d_line_v2v2i(), copy_v2_v2_int(), data, depth_segment_cb(), and NULL.

Referenced by annotation_stroke_newfrombuffer(), gpencil_get_depth_array(), gpencil_primitive_update_strokes(), and gpencil_stroke_newfrombuffer().

◆ ED_view3d_autodist_simple()

bool ED_view3d_autodist_simple ( ARegion *  region,
const int  mval[2],
float  mouse_worldloc[3],
int  margin,
const float *  force_depth 
)

Definition at line 1073 of file view3d_utils.c.

References ED_view3d_unproject(), float(), and view_autodist_depth_margin().

Referenced by annotation_stroke_convertcoords(), annotation_stroke_eraser_is_occluded(), gpencil_stroke_convertcoords(), gpencil_stroke_convertcoords_tpoint(), gpencil_stroke_eraser_is_occluded(), and object_transfer_mode_reposition_view_pivot().

◆ ED_view3d_axis_view_opposite()

char ED_view3d_axis_view_opposite ( char  view)

Definition at line 1466 of file view3d_utils.c.

References RV3D_VIEW_BACK, RV3D_VIEW_BOTTOM, RV3D_VIEW_FRONT, RV3D_VIEW_LEFT, RV3D_VIEW_RIGHT, RV3D_VIEW_TOP, RV3D_VIEW_USER, and view.

Referenced by vieworbit_exec().

◆ ED_view3d_background_color_get()

void ED_view3d_background_color_get ( const Scene *  scene,
const View3D *  v3d,
float  r_color[3] 
)

Definition at line 73 of file view3d_utils.c.

References View3DShading::background_color, View3DShading::background_type, copy_v3_v3(), World::horr, scene, View3D::shading, TH_BACK, UI_GetThemeColor3fv(), V3D_SHADING_BACKGROUND_VIEWPORT, V3D_SHADING_BACKGROUND_WORLD, and Scene::world.

◆ ED_view3d_boundbox_clip()

bool ED_view3d_boundbox_clip ( RegionView3D *  rv3d,
const BoundBox *  bb 
)

Definition at line 459 of file view3d_utils.c.

References BOUNDBOX_DISABLED, BoundBox::flag, NULL, RegionView3D::persmatob, and view3d_boundbox_clip_m4().

◆ ED_view3d_boundbox_clip_ex()

bool ED_view3d_boundbox_clip_ex ( const RegionView3D *  rv3d,
const BoundBox *  bb,
float  obmat[4][4] 
)

Definition at line 441 of file view3d_utils.c.

References BOUNDBOX_DISABLED, BoundBox::flag, mul_m4_m4m4(), NULL, RegionView3D::persmat, and view3d_boundbox_clip_m4().

◆ ED_view3d_camera_autokey()

bool ED_view3d_camera_autokey ( const Scene *  scene,
ID *  id_key,
struct bContext *  C,
const bool  do_rotate,
const bool  do_translate 
)

Definition at line 669 of file view3d_utils.c.

References ANIM_apply_keyingset(), ANIM_get_keyingset_for_autokeying(), ANIM_KS_LOCATION_ID, ANIM_KS_ROTATION_ID, ANIM_relative_keyingset_add_source(), autokeyframe_cfra_can_key(), BLI_freelistN(), C, CFRA, float(), MODIFYKEY_MODE_INSERT, NULL, and scene.

Referenced by ED_view3d_camera_lock_autokey().

◆ ED_view3d_camera_data_get()

Camera* ED_view3d_camera_data_get ( View3D *  v3d,
RegionView3D *  rv3d 
)

Definition at line 109 of file view3d_utils.c.

References View3D::camera, Object::data, NULL, OB_CAMERA, RegionView3D::persp, RV3D_CAMOB, and Object::type.

Referenced by uv_from_view_exec(), and uv_from_view_invoke().

◆ ED_view3d_camera_lock_autokey()

bool ED_view3d_camera_lock_autokey ( View3D *  v3d,
RegionView3D *  rv3d,
struct bContext *  C,
const bool  do_rotate,
const bool  do_translate 
)

Call after modifying a locked view.

Note
Not every view edit currently auto-keys (num-pad for eg), this is complicated because of smooth-view.

Definition at line 710 of file view3d_utils.c.

References C, View3D::camera, CTX_data_scene(), ED_view3d_camera_autokey(), ED_view3d_camera_lock_check(), Object::id, OB_TRANSFORM_ADJUST_ROOT_PARENT_FOR_VIEW_LOCK, Object::parent, scene, and Object::transflag.

Referenced by view3d_smoothview_apply(), viewdolly_modal(), viewmove_modal(), viewroll_modal(), viewrotate_modal(), viewzoom_exec(), viewzoom_invoke(), and viewzoom_modal().

◆ ED_view3d_camera_lock_check()

bool ED_view3d_camera_lock_check ( const View3D *  v3d,
const RegionView3D *  rv3d 
)
Returns
true when the 3D Viewport is locked to its camera.

Definition at line 575 of file view3d_utils.c.

References View3D::camera, View3D::flag2, ID_IS_LINKED, RegionView3D::persp, RV3D_CAMOB, and V3D_LOCK_CAMERA.

Referenced by ED_view3d_camera_lock_autokey(), ED_view3d_camera_lock_init_ex(), ED_view3d_camera_lock_sync(), ED_view3d_persp_ensure(), and ED_view3d_persp_switch_from_camera().

◆ ED_view3d_camera_lock_init()

void ED_view3d_camera_lock_init ( const Depsgraph *  depsgraph,
View3D *  v3d,
RegionView3D *  rv3d 
)

Definition at line 601 of file view3d_utils.c.

References depsgraph, and ED_view3d_camera_lock_init_ex().

◆ ED_view3d_camera_lock_init_ex()

void ED_view3d_camera_lock_init_ex ( const Depsgraph *  depsgraph,
View3D *  v3d,
RegionView3D *  rv3d,
const bool  calc_dist 
)

Apply the camera object transformation to the 3D Viewport. (needed so we can use regular 3D Viewport manipulation operators, that sync back to the camera).

Definition at line 585 of file view3d_utils.c.

References View3D::camera, DEG_get_evaluated_object(), depsgraph, RegionView3D::dist, ED_view3d_camera_lock_check(), ED_view3d_from_object(), ED_view3d_offset_distance(), NULL, Object::obmat, RegionView3D::ofs, VIEW3D_DIST_FALLBACK, and RegionView3D::viewquat.

Referenced by ED_view3d_camera_lock_init().

◆ ED_view3d_camera_lock_sync()

bool ED_view3d_camera_lock_sync ( const Depsgraph *  depsgraph,
View3D *  v3d,
RegionView3D *  rv3d 
)

Apply the 3D Viewport transformation back to the camera object.

Returns
true if the camera is moved.

Definition at line 611 of file view3d_utils.c.

References BKE_object_apply_mat4(), BKE_object_tfm_protected_backup(), BKE_object_tfm_protected_restore(), View3D::camera, DEG_get_evaluated_object(), DEG_id_tag_update(), depsgraph, RegionView3D::dist, ED_view3d_camera_lock_check(), ED_view3d_to_m4(), ED_view3d_to_object(), Object::id, ID_RECALC_TRANSFORM, invert_m4_m4(), mul_m4_m4m4(), NC_OBJECT, ND_TRANSFORM, normalize_m4_m4(), OB_LOCK_SCALEX, OB_LOCK_SCALEY, OB_LOCK_SCALEZ, OB_TRANSFORM_ADJUST_ROOT_PARENT_FOR_VIEW_LOCK, Object::obmat, RegionView3D::ofs, Object::parent, Object::protectflag, Object::transflag, RegionView3D::viewquat, and WM_main_add_notifier().

◆ ED_view3d_camera_to_view_selected()

bool ED_view3d_camera_to_view_selected ( struct Main *  bmain,
Depsgraph *  depsgraph,
const Scene *  scene,
Object *  camera_ob 
)

Definition at line 1592 of file view3d_utils.c.

References BKE_camera_view_frame_fit_to_scene(), BKE_object_apply_mat4(), BKE_object_tfm_protected_backup(), BKE_object_tfm_protected_restore(), CAM_ORTHO, copy_m4_m4(), copy_v3_v3(), Object::data, DEG_get_evaluated_object(), DEG_id_tag_update_ex(), depsgraph, Object::id, ID_RECALC_TRANSFORM, OB_CAMERA, OB_LOCK_ROT4D, OB_LOCK_SCALE, Object::obmat, scene, and Object::type.

◆ ED_view3d_clip_range_get()

bool ED_view3d_clip_range_get ( Depsgraph *  depsgraph,
const View3D *  v3d,
const RegionView3D *  rv3d,
float *  r_clipsta,
float *  r_clipend,
const bool  use_ortho_factor 
)
Note
copies logic of ED_view3d_viewplane_get(), keep in sync.

Definition at line 128 of file view3d_utils.c.

References BKE_camera_params_from_view3d(), BKE_camera_params_init(), depsgraph, and params.

◆ ED_view3d_clipping_calc()

void ED_view3d_clipping_calc ( BoundBox *  bb,
float  planes[4][4],
const ARegion *  region,
const Object *  ob,
const rcti *  rect 
)

Definition at line 290 of file view3d_utils.c.

References ED_view3d_clipping_calc_from_boundbox(), ED_view3d_unproject(), ELEM, invert_m4_m4(), is_negative_m4(), mul_m4_v3(), Object::obmat, BoundBox::vec, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ ED_view3d_clipping_calc_from_boundbox()

void ED_view3d_clipping_calc_from_boundbox ( float  clip[4][4],
const BoundBox *  bb,
const bool  is_flip 
)

Definition at line 276 of file view3d_utils.c.

References dot_v3v3(), negate_v3(), normal_tri_v3(), UNLIKELY, and BoundBox::vec.

Referenced by ED_view3d_clipping_calc().

◆ ED_view3d_clipping_clamp_minmax()

bool ED_view3d_clipping_clamp_minmax ( const RegionView3D *  rv3d,
float  min[3],
float  max[3] 
)

Clamp min/max by the viewport clipping.

Note
This is an approximation, with the limitation that the bounding box from the (mix, max) calculation might not have any geometry inside the clipped region. Performing a clipping test on each vertex would work well enough for most cases, although it's not perfect either as edges/faces may intersect the clipping without having any of their vertices inside it. A more accurate result would be quite involved.
Returns
True when the arguments were clamped.

Definition at line 354 of file view3d_utils.c.

References RegionView3D::clip, copy_v3_v3(), INIT_MINMAX, isect_planes_v3_fn(), max, min, negate_v4_v4(), points_in_planes_minmax_fn(), RV3D_BOXCLIP, RV3D_LOCK_FLAGS, user_data, and zero_v3().

◆ ED_view3d_context_activate()

bool ED_view3d_context_activate ( bContext *  C)

Definition at line 244 of file view3d_utils.c.

References blender::compositor::area(), BKE_area_find_region_active_win(), BKE_screen_find_big_area(), C, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region_set(), CTX_wm_screen(), NULL, and SPACE_VIEW3D.

Referenced by screen_opengl_render_init().

◆ ED_view3d_depth_read_cached()

bool ED_view3d_depth_read_cached ( const ViewDepths *  vd,
const int  mval[2],
int  margin,
float *  r_depth 
)

Definition at line 1654 of file view3d_utils.c.

References BLI_array_iter_spiral_square, BLI_assert, data, ViewDepths::depth_range, depth_read_test_fn(), ViewDepths::depths, ViewDepths::h, max_ii(), min_ii(), ReadData::r_depth, ViewDepths::w, x, and y.

Referenced by ED_view3d_depth_read_cached_normal(), object_transform_axis_target_modal(), and stroke_elem_project().

◆ ED_view3d_depth_read_cached_normal()

bool ED_view3d_depth_read_cached_normal ( const ViewContext *  vc,
const int  mval[2],
float  r_normal[3] 
)

Definition at line 1697 of file view3d_utils.c.

References add_v3_v3(), cross(), cross_v3_v3v3(), ViewDepths::depth_range, RegionView3D::depths, double(), ED_view3d_depth_read_cached(), ED_view3d_depth_unproject(), normalize_v3(), ViewContext::region, ViewContext::rv3d, sub_v3_v3v3(), x, and y.

Referenced by curve_draw_event_add_first(), object_transform_axis_target_modal(), and stroke_elem_project().

◆ ED_view3d_depth_tag_update()

void ED_view3d_depth_tag_update ( RegionView3D *  rv3d)

Definition at line 1764 of file view3d_utils.c.

References ViewDepths::damaged, and RegionView3D::depths.

Referenced by viewdolly_exec(), viewdolly_invoke(), viewdolly_modal(), viewmove_invoke(), viewmove_modal(), viewpan_invoke(), viewroll_invoke(), viewroll_modal(), viewrotate_invoke(), viewrotate_modal(), viewzoom_exec(), viewzoom_invoke(), and viewzoom_modal().

◆ ED_view3d_depth_unproject()

bool ED_view3d_depth_unproject ( const ARegion *  region,
const int  mval[2],
const double  depth,
float  r_location_world[3] 
)

Definition at line 1754 of file view3d_utils.c.

References ED_view3d_unproject(), and float().

Referenced by ED_view3d_depth_read_cached_normal().

◆ ED_view3d_dist_range_get()

void ED_view3d_dist_range_get ( const View3D *  v3d,
float  r_dist_range[2] 
)

Definition at line 119 of file view3d_utils.c.

References View3D::clip_end, and View3D::grid.

◆ ED_view3d_distance_set()

void ED_view3d_distance_set ( RegionView3D *  rv3d,
const float  dist 
)

Set the dist without moving the view (compensate with RegionView3D.ofs)

Note
take care that viewinv is up to date, ED_view3d_update_viewmat first.

Definition at line 1312 of file view3d_utils.c.

References BLI_assert, copy_v3_fl3(), RegionView3D::dist, invert_qt_qt_normalized(), mul_mat3_m4_v3(), mul_qt_v3(), RegionView3D::ofs, sub_v3_v3(), RegionView3D::viewinv, and RegionView3D::viewquat.

Referenced by ED_view3d_cameracontrol_acquire(), and ED_view3d_cameracontrol_release().

◆ ED_view3d_distance_set_from_location()

bool ED_view3d_distance_set_from_location ( RegionView3D *  rv3d,
const float  dist_co[3],
const float  dist_min 
)

Change the distance & offset to match the depth of dist_co along the view axis.

Parameters
dist_coA world-space location to use for the new depth.
dist_minResulting distances below this will be ignored.
Returns
Success if the distance was set.

Definition at line 1339 of file view3d_utils.c.

References RegionView3D::dist, dot_v3v3(), invert_qt_qt_normalized(), madd_v3_v3fl(), mul_qt_v3(), negate_v3_v3(), RegionView3D::ofs, sub_v3_v3v3(), and RegionView3D::viewquat.

◆ ED_view3d_from_m4()

void ED_view3d_from_m4 ( const float  mat[4][4],
float  ofs[3],
float  quat[4],
const float *  dist 
)

Set the view transformation from a 4x4 matrix.

Parameters
matThe view 4x4 transformation matrix to assign.
ofsThe view offset, normally from RegionView3D.ofs.
quatThe view rotation, quaternion normally from RegionView3D.viewquat.
distThe view distance from ofs, normally from RegionView3D.dist.

Definition at line 1505 of file view3d_utils.c.

References BLI_assert, copy_m3_m4(), invert_qt_normalized(), madd_v3_v3fl(), mat3_normalized_to_quat(), negate_v3_v3(), normalize_m3(), and NULL.

Referenced by ED_view3d_from_object(), and object_apply_mat4_with_protect().

◆ ED_view3d_from_object()

void ED_view3d_from_object ( const Object *  ob,
float  ofs[3],
float  quat[4],
float *  dist,
float *  lens 
)

Set the RegionView3D members from an objects transformation and optionally lens.

Parameters
obThe object to set the view to.
ofsThe view offset to be set, normally from RegionView3D.ofs.
quatThe view rotation to be set, quaternion normally from RegionView3D.viewquat.
distThe view distance from ofs to be set, normally from RegionView3D.dist.
lensThe view lens angle set for cameras and lights, normally from View3D.lens.

Definition at line 1557 of file view3d_utils.c.

References BKE_camera_params_from_object(), BKE_camera_params_init(), ED_view3d_from_m4(), Object::obmat, and params.

Referenced by ED_view3d_camera_lock_init_ex(), and ED_view3d_persp_switch_from_camera().

◆ ED_view3d_has_workbench_in_texture_color()

bool ED_view3d_has_workbench_in_texture_color ( const Scene *  scene,
const Object *  ob,
const View3D *  v3d 
)

Definition at line 89 of file view3d_utils.c.

References View3DShading::color_type, Scene::display, RenderData::engine, Object::mode, OB_MODE_TEXTURE_PAINT, OB_RENDER, OB_SOLID, Scene::r, RE_engine_id_BLENDER_WORKBENCH, scene, SceneDisplay::shading, View3D::shading, STREQ, View3DShading::type, and V3D_SHADING_TEXTURE_COLOR.

◆ ED_view3d_lastview_store()

void ED_view3d_lastview_store ( RegionView3D *  rv3d)

Use to store the last view, before entering camera view.

Definition at line 487 of file view3d_utils.c.

References copy_qt_qt(), RegionView3D::lpersp, RegionView3D::lview, RegionView3D::lview_axis_roll, RegionView3D::lviewquat, RegionView3D::persp, RV3D_CAMOB, RegionView3D::view, RegionView3D::view_axis_roll, and RegionView3D::viewquat.

Referenced by region_quadview_init_rv3d(), sync_viewport_camera_smoothview(), view3d_camera_to_view_exec(), view3d_setobjectascamera_exec(), and view_camera_exec().

◆ ED_view3d_lock()

bool ED_view3d_lock ( RegionView3D *  rv3d)

Definition at line 1486 of file view3d_utils.c.

References ED_view3d_quat_from_axis_view(), RegionView3D::view, RegionView3D::view_axis_roll, and RegionView3D::viewquat.

Referenced by ED_view3d_quadview_update(), region_quadview_init_rv3d(), and view3d_viewmatrix_set().

◆ ED_view3d_lock_clear()

void ED_view3d_lock_clear ( View3D *  v3d)

Definition at line 497 of file view3d_utils.c.

References View3D::flag2, NULL, View3D::ob_center, View3D::ob_center_bone, View3D::ob_center_cursor, and V3D_LOCK_CAMERA.

Referenced by view_lock_clear_exec(), and view_lock_to_active_exec().

◆ ED_view3d_lock_view_from_index()

char ED_view3d_lock_view_from_index ( int  index)

Definition at line 1452 of file view3d_utils.c.

References RV3D_VIEW_FRONT, RV3D_VIEW_RIGHT, RV3D_VIEW_TOP, and RV3D_VIEW_USER.

Referenced by ED_view3d_quadview_update(), and region_quadview_exec().

◆ ED_view3d_offset_distance()

float ED_view3d_offset_distance ( const float  mat[4][4],
const float  ofs[3],
const float  fallback_dist 
)

This function solves the problem of having to switch between camera and non-camera views.

When viewing from the perspective of mat, and having the view center ofs, this calculates a distance from ofs to the matrix mat. Using fallback_dist when the distance would be too small.

Parameters
matA matrix use for the view-point (typically the camera objects matrix).
ofsOrbit center (negated), matching RegionView3D.ofs, which is typically passed in.
fallback_distThe distance to use if the object is too near or in front of ofs.
Returns
A newly calculated distance or the fallback.

Definition at line 1286 of file view3d_utils.c.

References add_v3_v3(), dot_v3v3(), mul_m4_v4(), normalize_v3(), and pos.

Referenced by ED_view3d_camera_lock_init_ex(), ED_view3d_persp_switch_from_camera(), and ED_view3d_smooth_view_ex().

◆ ED_view3d_offset_lock_check()

bool ED_view3d_offset_lock_check ( const View3D *  v3d,
const RegionView3D *  rv3d 
)

Definition at line 479 of file view3d_utils.c.

References View3D::ob_center, View3D::ob_center_cursor, RegionView3D::persp, and RV3D_CAMOB.

◆ ED_view3d_persp_ensure()

bool ED_view3d_persp_ensure ( const Depsgraph *  depsgraph,
View3D *  v3d,
ARegion *  region 
)

Action to take when rotating the view, handle auto-persp and logic for switching out of views.

shared with NDOF.

Definition at line 537 of file view3d_utils.c.

References BLI_assert, depsgraph, ED_view3d_camera_lock_check(), ED_view3d_persp_switch_from_camera(), RegionView3D::lpersp, RegionView3D::lview, RegionView3D::persp, ARegion::regiondata, RV3D_CAMOB, RV3D_LOCK_ANY_TRANSFORM, RV3D_LOCK_FLAGS, RV3D_PERSP, RV3D_VIEW_IS_AXIS, USER_AUTOPERSP, and RegionView3D::view.

◆ ED_view3d_persp_switch_from_camera()

void ED_view3d_persp_switch_from_camera ( const Depsgraph *  depsgraph,
View3D *  v3d,
RegionView3D *  rv3d,
const char  persp 
)

For viewport operators that exit camera perspective.

Note
This differs from simply setting rv3d->persp = persp because it sets the ofs and dist values of the viewport so it matches the camera, otherwise switching out of camera view may jump to a different part of the scene.

Definition at line 513 of file view3d_utils.c.

References BLI_assert, View3D::camera, DEG_get_evaluated_object(), depsgraph, RegionView3D::dist, ED_view3d_camera_lock_check(), ED_view3d_from_object(), ED_view3d_offset_distance(), NULL, Object::obmat, RegionView3D::ofs, RegionView3D::persp, RV3D_CAMOB, VIEW3D_DIST_FALLBACK, and RegionView3D::viewquat.

Referenced by ED_view3d_persp_ensure().

◆ ED_view3d_polygon_offset()

void ED_view3d_polygon_offset ( const RegionView3D *  rv3d,
const float  dist 
)

Use instead of: GPU_polygon_offset(rv3d->dist, ...) see bug T37727.

Definition at line 224 of file view3d_utils.c.

References RegionView3D::dist, fabsf, GPU_polygon_offset(), RegionView3D::is_persp, max_ff(), RegionView3D::persp, RegionView3D::rflag, RV3D_CAMOB, RV3D_ZOFFSET_DISABLED, and RegionView3D::winmat.

◆ ED_view3d_quadview_update()

void ED_view3d_quadview_update ( ScrArea *  area,
ARegion *  region,
bool  do_clip 
)

Definition at line 939 of file view3d_utils.c.

References ARegion::alignment, blender::compositor::area(), ED_area_tag_redraw(), ED_view3d_lock(), ED_view3d_lock_view_from_index(), ARegion::next, NULL, RegionView3D::persp, ARegion::prev, ARegion::regiondata, RegionView3D::rflag, RGN_ALIGN_QSPLIT, RV3D_BOXCLIP, RV3D_BOXVIEW, RV3D_LOCK_FLAGS, RV3D_LOCK_ROTATION, RV3D_ORTHO, RV3D_VIEW_AXIS_ROLL_0, RV3D_VIEW_IS_AXIS, RegionView3D::view, view3d_boxview_sync(), RegionView3D::view_axis_roll, and RegionView3D::viewlock.

Referenced by region_quadview_init_rv3d().

◆ ED_view3d_quat_from_axis_view()

bool ED_view3d_quat_from_axis_view ( const char  view,
const char  view_axis_roll,
float  r_quat[4] 
)

Definition at line 1418 of file view3d_utils.c.

References BLI_assert, copy_qt_qt(), RV3D_VIEW_AXIS_ROLL_270, RV3D_VIEW_FRONT, RV3D_VIEW_IS_AXIS, view, and view3d_quat_axis.

Referenced by ED_view3d_lock(), view3d_boxview_sync_axis(), view_axis_exec(), vieworbit_exec(), and viewrotate_apply_snap().

◆ ED_view3d_quat_to_axis_view()

bool ED_view3d_quat_to_axis_view ( const float  quat[4],
const float  epsilon,
char *  r_view,
char *  r_view_axis_roll 
)

Definition at line 1428 of file view3d_utils.c.

References angle_signed_qtqt(), blender::robust_pred::epsilon, fabsf, RV3D_VIEW_AXIS_ROLL_0, RV3D_VIEW_AXIS_ROLL_270, RV3D_VIEW_BOTTOM, RV3D_VIEW_FRONT, RV3D_VIEW_USER, view, and view3d_quat_axis.

Referenced by viewrotate_apply_snap().

◆ ED_view3d_radius_to_dist()

float ED_view3d_radius_to_dist ( const View3D *  v3d,
const ARegion *  region,
const struct Depsgraph *  depsgraph,
const char  persp,
const bool  use_aspect,
const float  radius 
)

Return a new RegionView3D.dist value to fit the radius.

Note
Depth isn't taken into account, this will fit a flat plane exactly, but points towards the view (with a perspective projection), may be within the radius but outside the view. eg:
          +
pt --> + /^ radius
        / |
       /  |
view  +   +
       \  |
        \ |
         |
          +
Parameters
regionCan be NULL if use_aspect is false.
perspAllow the caller to tell what kind of perspective to use (ortho/view/camera)
use_aspectIncrease the distance to account for non 1:1 view aspect.
radiusThe radius will be fitted exactly, typically pre-scaled by a margin (VIEW3D_MARGIN).

Definition at line 1194 of file view3d_utils.c.

References angle(), atanf, BKE_camera_params_from_object(), BKE_camera_params_init(), BKE_camera_sensor_size(), BLI_assert, View3D::camera, CAMERA_PARAM_ZOOM_INIT_CAMOB, CAMERA_PARAM_ZOOM_INIT_PERSP, View3D::clip_end, View3D::clip_start, DEFAULT_SENSOR_WIDTH, DEG_get_evaluated_object(), depsgraph, ED_view3d_radius_to_dist_ortho(), ED_view3d_radius_to_dist_persp(), ELEM, focallength_to_fov(), View3D::lens, params, ARegion::regiondata, RV3D_CAMOB, RV3D_ORTHO, RV3D_PERSP, tanf, RegionView3D::viewcamtexcofac, ARegion::winx, and ARegion::winy.

◆ ED_view3d_radius_to_dist_ortho()

float ED_view3d_radius_to_dist_ortho ( const float  lens,
const float  radius 
)

Definition at line 1164 of file view3d_utils.c.

References DEFAULT_SENSOR_WIDTH.

Referenced by ED_view3d_radius_to_dist().

◆ ED_view3d_radius_to_dist_persp()

float ED_view3d_radius_to_dist_persp ( const float  angle,
const float  radius 
)

Definition at line 1159 of file view3d_utils.c.

References angle(), and tanf.

Referenced by ED_view3d_radius_to_dist().

◆ ED_view3d_to_m4()

void ED_view3d_to_m4 ( float  mat[4][4],
const float  ofs[3],
const float  quat[4],
const float  dist 
)

Calculate the view transformation matrix from RegionView3D input. The resulting matrix is equivalent to RegionView3D.viewinv

Parameters
matThe view 4x4 transformation matrix to calculate.
ofsThe view offset, normally from RegionView3D.ofs.
quatThe view rotation, quaternion normally from RegionView3D.viewquat.
distThe view distance from ofs, normally from RegionView3D.dist.

Definition at line 1539 of file view3d_utils.c.

References mul_mat3_m4_v3(), quat_to_mat4(), and sub_v3_v3v3().

Referenced by ED_view3d_camera_lock_sync(), ED_view3d_cameracontrol_acquire(), ED_view3d_cameracontrol_update(), and ED_view3d_to_object().

◆ ED_view3d_to_object()

void ED_view3d_to_object ( const Depsgraph *  depsgraph,
Object *  ob,
const float  ofs[3],
const float  quat[4],
const float  dist 
)

Set the object transformation from RegionView3D members.

Parameters
depsgraphThe depsgraph to get the evaluated object parent for the transformation calculation.
obThe object which has the transformation assigned.
ofsThe view offset, normally from RegionView3D.ofs.
quatThe view rotation, quaternion normally from RegionView3D.viewquat.
distThe view distance from ofs, normally from RegionView3D.dist.

Definition at line 1579 of file view3d_utils.c.

References BKE_object_apply_mat4_ex(), DEG_get_evaluated_object(), depsgraph, ED_view3d_to_m4(), Object::parent, and Object::parentinv.

Referenced by ED_view3d_camera_lock_sync().

◆ ED_view3d_viewplane_get()

bool ED_view3d_viewplane_get ( Depsgraph *  depsgraph,
const View3D *  v3d,
const RegionView3D *  rv3d,
int  winx,
int  winy,
rctf *  r_viewplane,
float *  r_clip_start,
float *  r_clip_end,
float *  r_pixsize 
)

Definition at line 156 of file view3d_utils.c.

References BKE_camera_params_compute_viewplane(), BKE_camera_params_from_view3d(), BKE_camera_params_init(), depsgraph, and params.

◆ points_in_planes_minmax_fn()

static void points_in_planes_minmax_fn ( const float  co[3],
int   UNUSEDi,
int   UNUSEDj,
int   UNUSEDk,
void *  user_data_p 
)
static

Definition at line 335 of file view3d_utils.c.

References minmax_v3v3_v3(), and user_data.

Referenced by ED_view3d_clipping_clamp_minmax().

◆ view3d_boundbox_clip_m4()

static bool view3d_boundbox_clip_m4 ( const BoundBox *  bb,
const float  persmatob[4][4] 
)
static

Definition at line 400 of file view3d_utils.c.

References Freestyle::a, copy_v3_v3(), max, min, mul_m4_v4(), and BoundBox::vec.

Referenced by ED_view3d_boundbox_clip(), and ED_view3d_boundbox_clip_ex().

◆ view3d_boxview_clip()

static void view3d_boxview_clip ( ScrArea *  area)
static

Definition at line 745 of file view3d_utils.c.

References blender::compositor::area(), RegionView3D::clip, RegionView3D::clipbb, copy_v2_v2(), RegionView3D::dist, dot_v3v3(), ELEM, LISTBASE_FOREACH, MEM_callocN, MEM_dupallocN, MEM_freeN, normal_tri_v3(), RegionView3D::ofs, RegionView3D::rflag, RGN_TYPE_WINDOW, RV3D_BOXCLIP, RV3D_CLIPPING, RV3D_LOCK_FLAGS, RV3D_VIEW_BACK, RV3D_VIEW_BOTTOM, RV3D_VIEW_FRONT, RV3D_VIEW_TOP, BoundBox::vec, RegionView3D::view, and y1.

Referenced by view3d_boxview_copy(), and view3d_boxview_sync().

◆ view3d_boxview_copy()

void view3d_boxview_copy ( ScrArea *  area,
ARegion *  region 
)

Definition at line 914 of file view3d_utils.c.

References blender::compositor::area(), copy_v3_v3(), RegionView3D::dist, ED_region_tag_redraw(), LISTBASE_FOREACH, RegionView3D::ofs, ARegion::regiondata, ARegion::regiontype, RGN_TYPE_WINDOW, RV3D_BOXCLIP, RV3D_LOCK_FLAGS, and view3d_boxview_clip().

Referenced by ED_view3d_smooth_view_ex(), and view3d_smoothview_apply().

◆ view3d_boxview_sync()

void view3d_boxview_sync ( ScrArea *  area,
ARegion *  region 
)

Definition at line 889 of file view3d_utils.c.

References blender::compositor::area(), RegionView3D::dist, ED_region_tag_redraw(), LISTBASE_FOREACH, ARegion::regiondata, ARegion::regiontype, RGN_TYPE_WINDOW, RV3D_BOXCLIP, RV3D_LOCK_FLAGS, RV3D_LOCK_ROTATION, view3d_boxview_clip(), and view3d_boxview_sync_axis().

Referenced by ED_view3d_quadview_update(), view3d_zoom_border_exec(), viewdolly_apply(), viewdolly_exec(), viewmove_apply(), viewroll_apply(), viewzoom_apply_3d(), and viewzoom_exec().

◆ view3d_boxview_sync_axis()

static void view3d_boxview_sync_axis ( RegionView3D *  rv3d_dst,
RegionView3D *  rv3d_src 
)
static

Find which axis values are shared between both views and copy to rv3d_dst taking axis flipping into account.

Definition at line 845 of file view3d_utils.c.

References ED_view3d_quat_from_axis_view(), fabsf, invert_qt_normalized(), mul_qt_v3(), RegionView3D::ofs, UNLIKELY, RegionView3D::view, and RegionView3D::view_axis_roll.

Referenced by view3d_boxview_sync().

◆ view3d_operator_needs_opengl()

void view3d_operator_needs_opengl ( const bContext *  C)

Use this call when executing an operator, event system doesn't set for each event the OpenGL drawing context.

Definition at line 198 of file view3d_utils.c.

References C, CTX_wm_region(), CTX_wm_window(), and view3d_region_operator_needs_opengl().

◆ view3d_region_operator_needs_opengl()

void view3d_region_operator_needs_opengl ( wmWindow *  UNUSEDwin,
ARegion *  region 
)

Definition at line 206 of file view3d_utils.c.

References GPU_matrix_projection_set, GPU_matrix_set, NULL, ARegion::regiondata, ARegion::regiontype, RGN_TYPE_WINDOW, RegionView3D::viewmat, RegionView3D::winmat, ARegion::winrct, and wmViewport().

Referenced by view3d_operator_needs_opengl().

◆ view_autodist_depth_margin()

static float view_autodist_depth_margin ( ARegion *  region,
const int  mval[2],
int  margin 
)
static

Definition at line 1005 of file view3d_utils.c.

References BLI_rcti_init_pt_radius(), ViewDepths::depths, MEM_SAFE_FREE, view3d_depth_near(), view3d_update_depths_rect(), rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by depth_segment_cb(), ED_view3d_autodist(), ED_view3d_autodist_depth(), and ED_view3d_autodist_simple().

Variable Documentation

◆ view3d_quat_axis

float view3d_quat_axis[6][4][4]
static

Lookup by axis-view, axis-roll.

Definition at line 1371 of file view3d_utils.c.

Referenced by ED_view3d_quat_from_axis_view(), and ED_view3d_quat_to_axis_view().

Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1