Blender  V3.3
Classes | Macros | Typedefs | Enumerations | Functions
ED_view3d.h File Reference
#include "BLI_utildefines.h"
#include "DNA_scene_types.h"

Go to the source code of this file.

Classes

struct  ViewContext
 
struct  ViewDepths
 
struct  V3DSnapCursorData
 
struct  V3DSnapCursorState
 

Macros

#define IS_CLIPPED   12000
 
#define V3D_PROJ_TEST_CLIP_DEFAULT    (V3D_PROJ_TEST_CLIP_BB | V3D_PROJ_TEST_CLIP_WIN | V3D_PROJ_TEST_CLIP_NEAR)
 
#define V3D_PROJ_TEST_ALL
 
#define V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT
 
#define USE_SNAP_DETECT_FROM_KEYMAP_HACK
 
#define MAXPICKELEMS   2500
 
#define ED_view3d_clear_mats_rv3d(rv3d)   (void)(rv3d)
 
#define ED_view3d_check_mats_rv3d(rv3d)   (void)(rv3d)
 
#define VIEW3D_MARGIN   1.4f
 
#define VIEW3D_DIST_FALLBACK   1.0f
 
#define XRAY_ALPHA(v3d)    (((v3d)->shading.type == OB_WIRE) ? (v3d)->shading.xray_alpha_wire : (v3d)->shading.xray_alpha)
 
#define XRAY_FLAG(v3d)    (((v3d)->shading.type == OB_WIRE) ? V3D_SHADING_XRAY_WIREFRAME : V3D_SHADING_XRAY)
 
#define XRAY_FLAG_ENABLED(v3d)   (((v3d)->shading.flag & XRAY_FLAG(v3d)) != 0)
 
#define XRAY_ENABLED(v3d)   (XRAY_FLAG_ENABLED(v3d) && (XRAY_ALPHA(v3d) < 1.0f))
 
#define XRAY_ACTIVE(v3d)   (XRAY_ENABLED(v3d) && ((v3d)->shading.type < OB_MATERIAL))
 

Typedefs

typedef struct ViewContext ViewContext
 
typedef struct ViewDepths ViewDepths
 
typedef struct V3DSnapCursorData V3DSnapCursorData
 
typedef struct V3DSnapCursorState V3DSnapCursorState
 

Enumerations

enum  eV3DCursorOrient { V3D_CURSOR_ORIENT_NONE = 0 , V3D_CURSOR_ORIENT_VIEW , V3D_CURSOR_ORIENT_XFORM , V3D_CURSOR_ORIENT_GEOM }
 
enum  eV3DDepthOverrideMode { V3D_DEPTH_NO_GPENCIL = 0 , V3D_DEPTH_GPENCIL_ONLY , V3D_DEPTH_OBJECT_ONLY }
 
enum  eV3DProjStatus {
  V3D_PROJ_RET_OK = 0 , V3D_PROJ_RET_CLIP_NEAR = 1 , V3D_PROJ_RET_CLIP_FAR = 2 , V3D_PROJ_RET_CLIP_ZERO = 3 ,
  V3D_PROJ_RET_CLIP_BB = 4 , V3D_PROJ_RET_CLIP_WIN = 5 , V3D_PROJ_RET_OVERFLOW = 6
}
 
enum  eV3DProjTest {
  V3D_PROJ_TEST_NOP = 0 , V3D_PROJ_TEST_CLIP_BB = (1 << 0) , V3D_PROJ_TEST_CLIP_WIN = (1 << 1) , V3D_PROJ_TEST_CLIP_NEAR = (1 << 2) ,
  V3D_PROJ_TEST_CLIP_FAR = (1 << 3) , V3D_PROJ_TEST_CLIP_ZERO = (1 << 4) , V3D_PROJ_TEST_CLIP_CONTENT = (1 << 5)
}
 
enum  eV3DSnapCursor {
  V3D_SNAPCURSOR_TOGGLE_ALWAYS_TRUE = 1 << 0 , V3D_SNAPCURSOR_OCCLUSION_ALWAYS_TRUE = 1 << 1 , V3D_SNAPCURSOR_OCCLUSION_ALWAYS_FALSE = 1 << 2 , V3D_SNAPCURSOR_SNAP_EDIT_GEOM_FINAL = 1 << 3 ,
  V3D_SNAPCURSOR_SNAP_EDIT_GEOM_CAGE = 1 << 4
}
 
enum  eV3DPlaceDepth { V3D_PLACE_DEPTH_SURFACE = 0 , V3D_PLACE_DEPTH_CURSOR_PLANE = 1 , V3D_PLACE_DEPTH_CURSOR_VIEW = 2 }
 
enum  eV3DPlaceOrient { V3D_PLACE_ORIENT_SURFACE = 0 , V3D_PLACE_ORIENT_DEFAULT = 1 }
 
enum  eV3DSelectMode { VIEW3D_SELECT_ALL = 0 , VIEW3D_SELECT_PICK_ALL = 1 , VIEW3D_SELECT_PICK_NEAREST = 2 }
 
enum  eV3DSelectObjectFilter { VIEW3D_SELECT_FILTER_NOP = 0 , VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK = 1 , VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK = 2 }
 

Functions

void ED_view3d_background_color_get (const struct Scene *scene, const struct View3D *v3d, float r_color[3])
 
bool ED_view3d_has_workbench_in_texture_color (const struct Scene *scene, const struct Object *ob, const struct View3D *v3d)
 
void ED_view3d_cursor3d_position (struct bContext *C, const int mval[2], bool use_depth, float r_cursor_co[3])
 
void ED_view3d_cursor3d_position_rotation (struct bContext *C, const int mval[2], bool use_depth, enum eV3DCursorOrient orientation, float r_cursor_co[3], float r_cursor_quat[4])
 
void ED_view3d_cursor3d_update (struct bContext *C, const int mval[2], bool use_depth, enum eV3DCursorOrient orientation)
 
struct CameraED_view3d_camera_data_get (struct View3D *v3d, struct RegionView3D *rv3d)
 
void ED_view3d_to_m4 (float mat[4][4], const float ofs[3], const float quat[4], float dist)
 
void ED_view3d_from_m4 (const float mat[4][4], float ofs[3], float quat[4], const float *dist)
 
void ED_view3d_from_object (const struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens)
 
void ED_view3d_to_object (const struct Depsgraph *depsgraph, struct Object *ob, const float ofs[3], const float quat[4], float dist)
 
bool ED_view3d_camera_to_view_selected (struct Main *bmain, struct Depsgraph *depsgraph, const struct Scene *scene, struct Object *camera_ob)
 
bool ED_view3d_camera_to_view_selected_with_set_clipping (struct Main *bmain, struct Depsgraph *depsgraph, const struct Scene *scene, struct Object *camera_ob)
 
void ED_view3d_lastview_store (struct RegionView3D *rv3d)
 
void ED_view3d_depth_override (struct Depsgraph *depsgraph, struct ARegion *region, struct View3D *v3d, struct Object *obact, eV3DDepthOverrideMode mode, struct ViewDepths **r_depths)
 
void ED_view3d_depths_free (ViewDepths *depths)
 
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 struct ARegion *region, const ViewDepths *depths, const int mval[2], float r_normal[3])
 
bool ED_view3d_depth_unproject_v3 (const struct ARegion *region, const int mval[2], double depth, float r_location_world[3])
 
 ENUM_OPERATORS (eV3DProjTest, V3D_PROJ_TEST_CLIP_CONTENT)
 
bool ED_view3d_snap_selected_to_location (struct bContext *C, const float snap_target_global[3], int pivot_point)
 
void ED_view3d_cursor_snap_state_default_set (V3DSnapCursorState *state)
 
V3DSnapCursorStateED_view3d_cursor_snap_state_get (void)
 
V3DSnapCursorStateED_view3d_cursor_snap_active (void)
 
void ED_view3d_cursor_snap_deactive (V3DSnapCursorState *state)
 
void ED_view3d_cursor_snap_prevpoint_set (V3DSnapCursorState *state, const float prev_point[3])
 
void ED_view3d_cursor_snap_data_update (V3DSnapCursorState *state, const struct bContext *C, int x, int y)
 
V3DSnapCursorDataED_view3d_cursor_snap_data_get (void)
 
struct SnapObjectContextED_view3d_cursor_snap_context_ensure (struct Scene *scene)
 
void ED_view3d_cursor_snap_draw_util (struct RegionView3D *rv3d, const float loc_prev[3], const float loc_curr[3], const float normal[3], const uchar color_line[4], const uchar color_point[4], eSnapMode snap_elem_type)
 
void meshobject_foreachScreenVert (struct ViewContext *vc, void(*func)(void *userData, struct MVert *eve, const float screen_co[2], int index), void *userData, eV3DProjTest clip_flag)
 
void mesh_foreachScreenVert (struct ViewContext *vc, void(*func)(void *userData, struct BMVert *eve, const float screen_co[2], int index), void *userData, eV3DProjTest clip_flag)
 
void mesh_foreachScreenEdge (struct ViewContext *vc, void(*func)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index), void *userData, eV3DProjTest clip_flag)
 
void mesh_foreachScreenEdge_clip_bb_segment (struct ViewContext *vc, void(*func)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index), void *userData, eV3DProjTest clip_flag)
 
void mesh_foreachScreenFace (struct ViewContext *vc, void(*func)(void *userData, struct BMFace *efa, const float screen_co[2], int index), void *userData, eV3DProjTest clip_flag)
 
void nurbs_foreachScreenVert (struct ViewContext *vc, void(*func)(void *userData, struct Nurb *nu, struct BPoint *bp, struct BezTriple *bezt, int beztindex, bool handle_visible, const float screen_co[2]), void *userData, eV3DProjTest clip_flag)
 
void mball_foreachScreenElem (struct ViewContext *vc, void(*func)(void *userData, struct MetaElem *ml, const float screen_co[2]), void *userData, eV3DProjTest clip_flag)
 
void lattice_foreachScreenVert (struct ViewContext *vc, void(*func)(void *userData, struct BPoint *bp, const float screen_co[2]), void *userData, eV3DProjTest clip_flag)
 
void armature_foreachScreenBone (struct ViewContext *vc, void(*func)(void *userData, struct EditBone *ebone, const float screen_co_a[2], const float screen_co_b[2]), void *userData, eV3DProjTest clip_flag)
 
void pose_foreachScreenBone (struct ViewContext *vc, void(*func)(void *userData, struct bPoseChannel *pchan, const float screen_co_a[2], const float screen_co_b[2]), void *userData, eV3DProjTest clip_flag)
 
void ED_view3d_project_float_v2_m4 (const struct ARegion *region, const float co[3], float r_co[2], const float mat[4][4])
 
void ED_view3d_project_float_v3_m4 (const struct ARegion *region, const float co[3], float r_co[3], const float mat[4][4])
 
eV3DProjStatus ED_view3d_project_base (const struct ARegion *region, struct Base *base)
 
eV3DProjStatus ED_view3d_project_short_ex (const struct ARegion *region, float perspmat[4][4], bool is_local, const float co[3], short r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_short_global (const struct ARegion *region, const float co[3], short r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_short_object (const struct ARegion *region, const float co[3], short r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_int_ex (const struct ARegion *region, float perspmat[4][4], bool is_local, const float co[3], int r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_int_global (const struct ARegion *region, const float co[3], int r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_int_object (const struct ARegion *region, const float co[3], int r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_float_ex (const struct ARegion *region, float perspmat[4][4], bool is_local, const float co[3], float r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_float_global (const struct ARegion *region, const float co[3], float r_co[2], eV3DProjTest flag)
 
eV3DProjStatus ED_view3d_project_float_object (const struct ARegion *region, const float co[3], float r_co[2], eV3DProjTest flag)
 
float ED_view3d_pixel_size (const struct RegionView3D *rv3d, const float co[3])
 
float ED_view3d_pixel_size_no_ui_scale (const struct RegionView3D *rv3d, const float co[3])
 
float ED_view3d_calc_zfac_ex (const struct RegionView3D *rv3d, const float co[3], bool *r_flip)
 
float ED_view3d_calc_zfac (const struct RegionView3D *rv3d, const float co[3])
 
float ED_view3d_calc_depth_for_comparison (const struct RegionView3D *rv3d, const float co[3])
 
bool ED_view3d_clip_segment (const struct RegionView3D *rv3d, float ray_start[3], float ray_end[3])
 
bool ED_view3d_win_to_ray_clipped (struct Depsgraph *depsgraph, const struct ARegion *region, const struct View3D *v3d, const float mval[2], float r_ray_start[3], float r_ray_normal[3], bool do_clip_planes)
 
bool ED_view3d_win_to_ray_clipped_ex (struct Depsgraph *depsgraph, const struct ARegion *region, const struct View3D *v3d, const float mval[2], float r_ray_co[3], float r_ray_normal[3], float r_ray_start[3], bool do_clip_planes)
 
void ED_view3d_win_to_ray (const struct ARegion *region, const float mval[2], float r_ray_start[3], float r_ray_normal[3])
 
void ED_view3d_global_to_vector (const struct RegionView3D *rv3d, const float coord[3], float vec[3])
 
void ED_view3d_win_to_3d (const struct View3D *v3d, const struct ARegion *region, const float depth_pt[3], const float mval[2], float r_out[3])
 
void ED_view3d_win_to_3d_int (const struct View3D *v3d, const struct ARegion *region, const float depth_pt[3], const int mval[2], float r_out[3])
 
bool ED_view3d_win_to_3d_on_plane (const struct ARegion *region, const float plane[4], const float mval[2], bool do_clip, float r_out[3])
 
bool ED_view3d_win_to_3d_on_plane_with_fallback (const struct ARegion *region, const float plane[4], const float mval[2], bool do_clip, const float plane_fallback[4], float r_out[3])
 
bool ED_view3d_win_to_3d_on_plane_int (const struct ARegion *region, const float plane[4], const int mval[2], bool do_clip, float r_out[3])
 
void ED_view3d_win_to_delta (const struct ARegion *region, const float xy_delta[2], float zfac, float r_out[3])
 
void ED_view3d_win_to_origin (const struct ARegion *region, const float mval[2], float r_out[3])
 
void ED_view3d_win_to_vector (const struct ARegion *region, const float mval[2], float r_out[3])
 
bool ED_view3d_win_to_segment_clipped (const struct Depsgraph *depsgraph, const struct ARegion *region, const struct View3D *v3d, const float mval[2], float r_ray_start[3], float r_ray_end[3], bool do_clip_planes)
 
void ED_view3d_ob_project_mat_get (const struct RegionView3D *v3d, const struct Object *ob, float r_pmat[4][4])
 
void ED_view3d_ob_project_mat_get_from_obmat (const struct RegionView3D *rv3d, const float obmat[4][4], float r_pmat[4][4])
 
void ED_view3d_project_v3 (const struct ARegion *region, const float world[3], float r_region_co[3])
 
void ED_view3d_project_v2 (const struct ARegion *region, const float world[3], float r_region_co[2])
 
bool ED_view3d_unproject_v3 (const struct ARegion *region, float regionx, float regiony, float regionz, float world[3])
 
void ED_view3d_dist_range_get (const struct View3D *v3d, float r_dist_range[2])
 
bool ED_view3d_clip_range_get (const struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d, float *r_clipsta, float *r_clipend, bool use_ortho_factor)
 
bool ED_view3d_viewplane_get (struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d, int winxi, int winyi, struct rctf *r_viewplane, float *r_clipsta, float *r_clipend, float *r_pixsize)
 
void ED_view3d_polygon_offset (const struct RegionView3D *rv3d, float dist)
 
void ED_view3d_calc_camera_border (const struct Scene *scene, struct Depsgraph *depsgraph, const struct ARegion *region, const struct View3D *v3d, const struct RegionView3D *rv3d, struct rctf *r_viewborder, bool no_shift)
 
void ED_view3d_calc_camera_border_size (const struct Scene *scene, struct Depsgraph *depsgraph, const struct ARegion *region, const struct View3D *v3d, const struct RegionView3D *rv3d, float r_size[2])
 
bool ED_view3d_calc_render_border (const struct Scene *scene, struct Depsgraph *depsgraph, struct View3D *v3d, struct ARegion *region, struct rcti *rect)
 
void ED_view3d_clipping_calc_from_boundbox (float clip[4][4], const struct BoundBox *clipbb, bool is_flip)
 
void ED_view3d_clipping_calc (struct BoundBox *bb, float planes[4][4], const struct ARegion *region, const struct Object *ob, const struct rcti *rect)
 
bool ED_view3d_clipping_clamp_minmax (const struct RegionView3D *rv3d, float min[3], float max[3])
 
void ED_view3d_clipping_local (struct RegionView3D *rv3d, const float mat[4][4])
 
bool ED_view3d_clipping_test (const struct RegionView3D *rv3d, const float co[3], bool is_local)
 
float ED_view3d_radius_to_dist_persp (float angle, float radius)
 
float ED_view3d_radius_to_dist_ortho (float lens, float radius)
 
float ED_view3d_radius_to_dist (const struct View3D *v3d, const struct ARegion *region, const struct Depsgraph *depsgraph, char persp, bool use_aspect, float radius)
 
void ED_view3d_backbuf_depth_validate (struct ViewContext *vc)
 
int ED_view3d_backbuf_sample_size_clamp (struct ARegion *region, float dist)
 
void ED_view3d_select_id_validate (struct ViewContext *vc)
 
bool ED_view3d_autodist (struct Depsgraph *depsgraph, struct ARegion *region, struct View3D *v3d, const int mval[2], float mouse_worldloc[3], bool alphaoverride, const float fallback_depth_pt[3])
 
bool ED_view3d_autodist_simple (struct ARegion *region, const int mval[2], float mouse_worldloc[3], int margin, const float *force_depth)
 
bool ED_view3d_depth_read_cached_seg (const ViewDepths *vd, const int mval_sta[2], const int mval_end[2], int margin, float *depth)
 
eV3DSelectObjectFilter ED_view3d_select_filter_from_mode (const struct Scene *scene, const struct Object *obact)
 
void view3d_opengl_select_cache_begin (void)
 
void view3d_opengl_select_cache_end (void)
 
int view3d_opengl_select_ex (struct ViewContext *vc, struct GPUSelectResult *buffer, unsigned int buffer_len, const struct rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter, bool do_material_slot_selection)
 
int view3d_opengl_select (struct ViewContext *vc, struct GPUSelectResult *buffer, unsigned int buffer_len, const struct rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter)
 
int view3d_opengl_select_with_id_filter (struct ViewContext *vc, struct GPUSelectResult *buffer, unsigned int buffer_len, const struct rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter, uint select_id)
 
float ED_view3d_select_dist_px (void)
 
void ED_view3d_viewcontext_init (struct bContext *C, struct ViewContext *vc, struct Depsgraph *depsgraph)
 
void ED_view3d_viewcontext_init_object (struct ViewContext *vc, struct Object *obact)
 
void view3d_operator_needs_opengl (const struct bContext *C)
 
void view3d_region_operator_needs_opengl (struct wmWindow *win, struct ARegion *region)
 
bool edge_inside_circle (const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2])
 
struct RegionView3DED_view3d_context_rv3d (struct bContext *C)
 
bool ED_view3d_context_user_region (struct bContext *C, struct View3D **r_v3d, struct ARegion **r_region)
 
bool ED_view3d_area_user_region (const struct ScrArea *area, const struct View3D *v3d, struct ARegion **r_region)
 
bool ED_operator_rv3d_user_region_poll (struct bContext *C)
 
void ED_view3d_init_mats_rv3d (const struct Object *ob, struct RegionView3D *rv3d)
 
void ED_view3d_init_mats_rv3d_gl (const struct Object *ob, struct RegionView3D *rv3d)
 
struct RV3DMatrixStoreED_view3d_mats_rv3d_backup (struct RegionView3D *rv3d)
 
void ED_view3d_mats_rv3d_restore (struct RegionView3D *rv3d, struct RV3DMatrixStore *rv3dmat)
 
void ED_draw_object_facemap (struct Depsgraph *depsgraph, struct Object *ob, const float col[4], int facemap)
 
struct RenderEngineTypeED_view3d_engine_type (const struct Scene *scene, int drawtype)
 
bool ED_view3d_context_activate (struct bContext *C)
 
void ED_view3d_draw_setup_view (const struct wmWindowManager *wm, struct wmWindow *win, struct Depsgraph *depsgraph, struct Scene *scene, struct ARegion *region, struct View3D *v3d, const float viewmat[4][4], const float winmat[4][4], const struct rcti *rect)
 
struct BaseED_view3d_give_base_under_cursor (struct bContext *C, const int mval[2])
 
struct ObjectED_view3d_give_object_under_cursor (struct bContext *C, const int mval[2])
 
struct ObjectED_view3d_give_material_slot_under_cursor (struct bContext *C, const int mval[2], int *r_material_slot)
 
bool ED_view3d_is_object_under_cursor (struct bContext *C, const int mval[2])
 
void ED_view3d_quadview_update (struct ScrArea *area, struct ARegion *region, bool do_clip)
 
void ED_view3d_update_viewmat (struct Depsgraph *depsgraph, const struct Scene *scene, struct View3D *v3d, struct ARegion *region, const float viewmat[4][4], const float winmat[4][4], const struct rcti *rect, bool offscreen)
 
bool ED_view3d_quat_from_axis_view (char view, char view_axis_roll, float r_quat[4])
 
bool ED_view3d_quat_to_axis_view (const float viewquat[4], float epsilon, char *r_view, char *r_view_axis_rotation)
 
bool ED_view3d_quat_to_axis_view_and_reset_quat (float viewquat[4], float epsilon, char *r_view, char *r_view_axis_rotation)
 
char ED_view3d_lock_view_from_index (int index)
 
char ED_view3d_axis_view_opposite (char view)
 
bool ED_view3d_lock (struct RegionView3D *rv3d)
 
void ED_view3d_datamask (const struct bContext *C, const struct Scene *scene, const struct View3D *v3d, struct CustomData_MeshMasks *r_cddata_masks)
 
void ED_view3d_screen_datamask (const struct bContext *C, const struct Scene *scene, const struct bScreen *screen, struct CustomData_MeshMasks *r_cddata_masks)
 
bool ED_view3d_offset_lock_check (const struct View3D *v3d, const struct RegionView3D *rv3d)
 
void ED_view3d_persp_switch_from_camera (const struct Depsgraph *depsgraph, struct View3D *v3d, struct RegionView3D *rv3d, char persp)
 
bool ED_view3d_persp_ensure (const struct Depsgraph *depsgraph, struct View3D *v3d, struct ARegion *region)
 
bool ED_view3d_camera_view_zoom_scale (struct RegionView3D *rv3d, const float scale)
 
bool ED_view3d_camera_view_pan (struct ARegion *region, const float event_ofs[2])
 
bool ED_view3d_camera_lock_check (const struct View3D *v3d, const struct RegionView3D *rv3d)
 
void ED_view3d_camera_lock_init_ex (const struct Depsgraph *depsgraph, struct View3D *v3d, struct RegionView3D *rv3d, bool calc_dist)
 
void ED_view3d_camera_lock_init (const struct Depsgraph *depsgraph, struct View3D *v3d, struct RegionView3D *rv3d)
 
bool ED_view3d_camera_lock_sync (const struct Depsgraph *depsgraph, struct View3D *v3d, struct RegionView3D *rv3d)
 
bool ED_view3d_camera_autokey (const struct Scene *scene, struct ID *id_key, struct bContext *C, bool do_rotate, bool do_translate)
 
bool ED_view3d_camera_lock_autokey (struct View3D *v3d, struct RegionView3D *rv3d, struct bContext *C, bool do_rotate, bool do_translate)
 
void ED_view3d_lock_clear (struct View3D *v3d)
 
bool ED_view3d_camera_lock_undo_test (const View3D *v3d, const RegionView3D *rv3d, struct bContext *C)
 
bool ED_view3d_camera_lock_undo_push (const char *str, View3D *v3d, struct RegionView3D *rv3d, struct bContext *C)
 
bool ED_view3d_camera_lock_undo_grouped_push (const char *str, View3D *v3d, struct RegionView3D *rv3d, struct bContext *C)
 
float ED_view3d_offset_distance (const float mat[4][4], const float ofs[3], float fallback_dist)
 
void ED_view3d_distance_set (struct RegionView3D *rv3d, float dist)
 
bool ED_view3d_distance_set_from_location (struct RegionView3D *rv3d, const float dist_co[3], float dist_min)
 
float ED_scene_grid_scale (const struct Scene *scene, const char **r_grid_unit)
 
float ED_view3d_grid_scale (const struct Scene *scene, struct View3D *v3d, const char **r_grid_unit)
 
void ED_view3d_grid_steps (const struct Scene *scene, struct View3D *v3d, struct RegionView3D *rv3d, float r_grid_steps[8])
 
float ED_view3d_grid_view_scale (struct Scene *scene, struct View3D *v3d, struct ARegion *region, const char **r_grid_unit)
 
void ED_scene_draw_fps (const struct Scene *scene, int xoffset, int *yoffset)
 
void ED_view3d_stop_render_preview (struct wmWindowManager *wm, struct ARegion *region)
 
void ED_view3d_shade_update (struct Main *bmain, struct View3D *v3d, struct ScrArea *area)
 
void ED_view3d_draw_bgpic_test (const struct Scene *scene, struct Depsgraph *depsgraph, struct ARegion *region, struct View3D *v3d, bool do_foreground, bool do_camera_frame)
 
void ED_view3d_gizmo_mesh_preselect_get_active (struct bContext *C, struct wmGizmo *gz, struct Base **r_base, struct BMElem **r_ele)
 
void ED_view3d_gizmo_mesh_preselect_clear (struct wmGizmo *gz)
 
void ED_view3d_buttons_region_layout_ex (const struct bContext *C, struct ARegion *region, const char *category_override)
 
bool ED_view3d_local_collections_set (struct Main *bmain, struct View3D *v3d)
 
void ED_view3d_local_collections_reset (struct bContext *C, bool reset_all)
 

Macro Definition Documentation

◆ ED_view3d_check_mats_rv3d

#define ED_view3d_check_mats_rv3d (   rv3d)    (void)(rv3d)

Definition at line 1031 of file ED_view3d.h.

◆ ED_view3d_clear_mats_rv3d

#define ED_view3d_clear_mats_rv3d (   rv3d)    (void)(rv3d)

Definition at line 1030 of file ED_view3d.h.

◆ IS_CLIPPED

#define IS_CLIPPED   12000

Definition at line 213 of file ED_view3d.h.

◆ MAXPICKELEMS

#define MAXPICKELEMS   2500

The default value for the maximum number of elements that can be selected at once using view-port selection.

Note
in many cases this defines the size of fixed-size stack buffers, so take care increasing this value.

Definition at line 894 of file ED_view3d.h.

◆ USE_SNAP_DETECT_FROM_KEYMAP_HACK

#define USE_SNAP_DETECT_FROM_KEYMAP_HACK

Definition at line 282 of file ED_view3d.h.

◆ V3D_PROJ_TEST_ALL

#define V3D_PROJ_TEST_ALL
Value:
V3D_PROJ_TEST_CLIP_CONTENT)
@ V3D_PROJ_TEST_CLIP_FAR
Definition: ED_view3d.h:238
@ V3D_PROJ_TEST_CLIP_ZERO
Definition: ED_view3d.h:239
#define V3D_PROJ_TEST_CLIP_DEFAULT
Definition: ED_view3d.h:264

Definition at line 266 of file ED_view3d.h.

◆ V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT

#define V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT
Value:
V3D_PROJ_TEST_CLIP_WIN)
@ V3D_PROJ_TEST_CLIP_NEAR
Definition: ED_view3d.h:237
@ V3D_PROJ_TEST_CLIP_CONTENT
Definition: ED_view3d.h:260

Definition at line 270 of file ED_view3d.h.

◆ V3D_PROJ_TEST_CLIP_DEFAULT

Definition at line 264 of file ED_view3d.h.

◆ VIEW3D_DIST_FALLBACK

#define VIEW3D_DIST_FALLBACK   1.0f

Definition at line 1230 of file ED_view3d.h.

◆ VIEW3D_MARGIN

#define VIEW3D_MARGIN   1.4f

Definition at line 1229 of file ED_view3d.h.

◆ XRAY_ACTIVE

#define XRAY_ACTIVE (   v3d)    (XRAY_ENABLED(v3d) && ((v3d)->shading.type < OB_MATERIAL))

Definition at line 1300 of file ED_view3d.h.

◆ XRAY_ALPHA

#define XRAY_ALPHA (   v3d)     (((v3d)->shading.type == OB_WIRE) ? (v3d)->shading.xray_alpha_wire : (v3d)->shading.xray_alpha)

Definition at line 1294 of file ED_view3d.h.

◆ XRAY_ENABLED

#define XRAY_ENABLED (   v3d)    (XRAY_FLAG_ENABLED(v3d) && (XRAY_ALPHA(v3d) < 1.0f))

Definition at line 1299 of file ED_view3d.h.

◆ XRAY_FLAG

#define XRAY_FLAG (   v3d)     (((v3d)->shading.type == OB_WIRE) ? V3D_SHADING_XRAY_WIREFRAME : V3D_SHADING_XRAY)

Definition at line 1296 of file ED_view3d.h.

◆ XRAY_FLAG_ENABLED

#define XRAY_FLAG_ENABLED (   v3d)    (((v3d)->shading.flag & XRAY_FLAG(v3d)) != 0)

Definition at line 1298 of file ED_view3d.h.

Typedef Documentation

◆ V3DSnapCursorData

◆ V3DSnapCursorState

◆ ViewContext

typedef struct ViewContext ViewContext

◆ ViewDepths

typedef struct ViewDepths ViewDepths

Enumeration Type Documentation

◆ eV3DCursorOrient

Enumerator
V3D_CURSOR_ORIENT_NONE 
V3D_CURSOR_ORIENT_VIEW 
V3D_CURSOR_ORIENT_XFORM 
V3D_CURSOR_ORIENT_GEOM 

Definition at line 85 of file ED_view3d.h.

◆ eV3DDepthOverrideMode

Enumerator
V3D_DEPTH_NO_GPENCIL 

Redraw viewport without Grease Pencil and Annotations.

V3D_DEPTH_GPENCIL_ONLY 

Redraw viewport with Grease Pencil and Annotations only.

V3D_DEPTH_OBJECT_ONLY 

Redraw viewport with active object only.

Definition at line 180 of file ED_view3d.h.

◆ eV3DPlaceDepth

Enumerator
V3D_PLACE_DEPTH_SURFACE 
V3D_PLACE_DEPTH_CURSOR_PLANE 
V3D_PLACE_DEPTH_CURSOR_VIEW 

Definition at line 291 of file ED_view3d.h.

◆ eV3DPlaceOrient

Enumerator
V3D_PLACE_ORIENT_SURFACE 
V3D_PLACE_ORIENT_DEFAULT 

Definition at line 297 of file ED_view3d.h.

◆ eV3DProjStatus

Enumerator
V3D_PROJ_RET_OK 
V3D_PROJ_RET_CLIP_NEAR 

can't avoid this when in perspective mode, (can't avoid)

V3D_PROJ_RET_CLIP_FAR 

After clip_end.

V3D_PROJ_RET_CLIP_ZERO 

so close to zero we can't apply a perspective matrix usefully

V3D_PROJ_RET_CLIP_BB 

bounding box clip - RV3D_CLIPPING

V3D_PROJ_RET_CLIP_WIN 

outside window bounds

V3D_PROJ_RET_OVERFLOW 

outside range (mainly for short), (can't avoid)

Definition at line 216 of file ED_view3d.h.

◆ eV3DProjTest

Enumerator
V3D_PROJ_TEST_NOP 
V3D_PROJ_TEST_CLIP_BB 
V3D_PROJ_TEST_CLIP_WIN 
V3D_PROJ_TEST_CLIP_NEAR 
V3D_PROJ_TEST_CLIP_FAR 
V3D_PROJ_TEST_CLIP_ZERO 
V3D_PROJ_TEST_CLIP_CONTENT 

Clip the contents of the data being iterated over. Currently this is only used to edges when projecting into screen space.

Clamp the edge within the viewport limits defined by V3D_PROJ_TEST_CLIP_WIN, V3D_PROJ_TEST_CLIP_NEAR & V3D_PROJ_TEST_CLIP_FAR. This resolves the problem of a visible edge having one of it's vertices behind the viewport. See: T32214.

This is not default behavior as it may be important for the screen-space location of an edges vertex to represent that vertices location (instead of a location along the edge).

Note
Perspective views should enable V3D_PROJ_TEST_CLIP_WIN along with V3D_PROJ_TEST_CLIP_NEAR as the near-plane-clipped location of a point may become very large (even infinite) when projected into screen-space. Unless that point happens to coincide with the camera's point of view.

Use V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT instead of V3D_PROJ_TEST_CLIP_CONTENT, to avoid accidentally enabling near clipping without clipping by window bounds.

Definition at line 233 of file ED_view3d.h.

◆ eV3DSelectMode

Enumerator
VIEW3D_SELECT_ALL 
VIEW3D_SELECT_PICK_ALL 
VIEW3D_SELECT_PICK_NEAREST 

Definition at line 896 of file ED_view3d.h.

◆ eV3DSelectObjectFilter

Enumerator
VIEW3D_SELECT_FILTER_NOP 

Don't exclude anything.

VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK 

Don't select objects outside the current mode.

VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK 

A version of VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK that allows pose-bone selection.

Definition at line 905 of file ED_view3d.h.

◆ eV3DSnapCursor

Enumerator
V3D_SNAPCURSOR_TOGGLE_ALWAYS_TRUE 
V3D_SNAPCURSOR_OCCLUSION_ALWAYS_TRUE 
V3D_SNAPCURSOR_OCCLUSION_ALWAYS_FALSE 
V3D_SNAPCURSOR_SNAP_EDIT_GEOM_FINAL 
V3D_SNAPCURSOR_SNAP_EDIT_GEOM_CAGE 

Definition at line 283 of file ED_view3d.h.

Function Documentation

◆ armature_foreachScreenBone()

void armature_foreachScreenBone ( struct ViewContext vc,
void(*)(void *userData, struct EditBone *ebone, const float screen_co_a[2], const float screen_co_b[2])  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ ED_draw_object_facemap()

void ED_draw_object_facemap ( struct Depsgraph depsgraph,
struct Object ob,
const float  col[4],
int  facemap 
)

◆ ED_operator_rv3d_user_region_poll()

bool ED_operator_rv3d_user_region_poll ( struct bContext C)

◆ ED_scene_draw_fps()

void ED_scene_draw_fps ( const struct Scene scene,
int  xoffset,
int *  yoffset 
)
Note
The info that this uses is updated in ED_refresh_viewport_fps, which currently gets called during SCREEN_OT_animation_step.

Referenced by sequencer_preview_region_draw().

◆ ED_scene_grid_scale()

float ED_scene_grid_scale ( const struct Scene scene,
const char **  r_grid_unit 
)

◆ ED_view3d_area_user_region()

bool ED_view3d_area_user_region ( const struct ScrArea area,
const struct View3D v3d,
struct ARegion **  r_region 
)

Similar to ED_view3d_context_user_region() but does not use context. Always performs a lookup. Also works if v3d is not the active space.

◆ ED_view3d_autodist()

bool ED_view3d_autodist ( struct Depsgraph depsgraph,
struct ARegion region,
struct View3D v3d,
const int  mval[2],
float  mouse_worldloc[3],
bool  alphaoverride,
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.

Referenced by depthdropper_depth_sample_pt(), ED_view3d_cursor3d_position(), paint_proj_stroke(), viewcenter_pick_invoke(), and viewops_data_create().

◆ ED_view3d_autodist_simple()

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

◆ ED_view3d_axis_view_opposite()

char ED_view3d_axis_view_opposite ( char  view)

◆ ED_view3d_backbuf_depth_validate()

void ED_view3d_backbuf_depth_validate ( struct ViewContext vc)

Back-buffer select and draw support.

◆ ED_view3d_backbuf_sample_size_clamp()

int ED_view3d_backbuf_sample_size_clamp ( struct ARegion region,
float  dist 
)

allow for small values [0.5 - 2.5], and large values, FLT_MAX by clamping by the area size

Definition at line 2195 of file view3d_draw.c.

References ceilf, max_ii(), min_ff(), and ARegion::winx.

Referenced by EDBM_edge_find_nearest_ex(), EDBM_face_find_nearest_ex(), and EDBM_vert_find_nearest_ex().

◆ ED_view3d_background_color_get()

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

◆ ED_view3d_buttons_region_layout_ex()

void ED_view3d_buttons_region_layout_ex ( const struct bContext C,
struct ARegion region,
const char *  category_override 
)

◆ ED_view3d_calc_camera_border()

void ED_view3d_calc_camera_border ( const struct Scene scene,
struct Depsgraph depsgraph,
const struct ARegion region,
const struct View3D v3d,
const struct RegionView3D rv3d,
struct rctf r_viewborder,
bool  no_shift 
)

◆ ED_view3d_calc_camera_border_size()

void ED_view3d_calc_camera_border_size ( const struct Scene scene,
struct Depsgraph depsgraph,
const struct ARegion region,
const struct View3D v3d,
const struct RegionView3D rv3d,
float  r_size[2] 
)

◆ ED_view3d_calc_depth_for_comparison()

float ED_view3d_calc_depth_for_comparison ( const struct RegionView3D rv3d,
const float  co[3] 
)

Calculate a depth value from co (result should only be used for comparison).

Referenced by annotation_stroke_eraser_is_occluded(), and gpencil_stroke_eraser_is_occluded().

◆ ED_view3d_calc_render_border()

bool ED_view3d_calc_render_border ( const struct Scene scene,
struct Depsgraph depsgraph,
struct View3D v3d,
struct ARegion region,
struct rcti rect 
)

◆ ED_view3d_calc_zfac()

float ED_view3d_calc_zfac ( const struct RegionView3D rv3d,
const float  co[3] 
)

◆ ED_view3d_calc_zfac_ex()

float ED_view3d_calc_zfac_ex ( const struct RegionView3D rv3d,
const float  co[3],
bool r_flip 
)

Calculate a depth value from co, use with ED_view3d_win_to_delta.

Parameters
r_flipSet to zfac < 0.0 before the value is made signed. Since it's important in some cases to know if the value was flipped.
Returns
The unsigned depth component of co multiplied by rv3d->persmat matrix, with additional sanitation to ensure the result is never negative as this isn't useful for tool-code.

Referenced by ED_view3d_cursor3d_position(), and gpencil_brush_randomize_apply().

◆ ED_view3d_camera_autokey()

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

◆ ED_view3d_camera_data_get()

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

◆ ED_view3d_camera_lock_autokey()

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

Call after modifying a locked view.

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

Definition at line 665 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_ex(), 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 struct View3D v3d,
const struct RegionView3D rv3d 
)

◆ ED_view3d_camera_lock_init()

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

◆ ED_view3d_camera_lock_init_ex()

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

Copy the camera to the view before starting a view transformation.

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).

◆ ED_view3d_camera_lock_sync()

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

Copy the view to the camera, return true if.

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

Returns
true if the camera is moved.

Referenced by ED_view3d_smooth_view_ex(), view3d_smoothview_apply_ex(), viewdolly_apply(), viewdolly_exec(), viewmove_apply(), viewroll_apply(), viewroll_modal(), viewrotate_apply(), viewzoom_apply_3d(), and viewzoom_exec().

◆ ED_view3d_camera_lock_undo_grouped_push()

bool ED_view3d_camera_lock_undo_grouped_push ( const char *  str,
View3D v3d,
struct RegionView3D rv3d,
struct bContext C 
)

A version of ED_view3d_camera_lock_undo_push that performs a grouped undo push.

Note
use for actions that are likely to be repeated such as mouse wheel to zoom, where adding a separate undo step each time isn't desirable.

Definition at line 731 of file view3d_utils.c.

References C, str, and view3d_camera_lock_undo_ex().

Referenced by ED_view3d_smooth_view_undo_end(), and viewzoom_exec().

◆ ED_view3d_camera_lock_undo_push()

bool ED_view3d_camera_lock_undo_push ( const char *  str,
View3D v3d,
struct RegionView3D rv3d,
struct bContext C 
)

Create an undo step when the camera is locked to the view.

Parameters
strThe name of the undo step (typically wmOperatorType.name should be used).
Returns
true when the call to push an undo step was made.

Definition at line 726 of file view3d_utils.c.

References C, str, and view3d_camera_lock_undo_ex().

Referenced by ED_view3d_smooth_view_undo_end(), fly_modal(), viewdolly_modal(), viewmove_modal(), viewpan_invoke(), viewrotate_modal(), viewzoom_modal(), and walk_modal().

◆ ED_view3d_camera_lock_undo_test()

bool ED_view3d_camera_lock_undo_test ( const View3D v3d,
const RegionView3D rv3d,
struct bContext C 
)

Check if creating an undo step should be performed if the viewport moves.

Returns
true if ED_view3d_camera_lock_undo_push would do an undo push.

Definition at line 692 of file view3d_utils.c.

References C, ED_undo_is_memfile_compatible(), and ED_view3d_camera_lock_check().

Referenced by ED_view3d_smooth_view_undo_begin(), ED_view3d_smooth_view_undo_end(), and view3d_camera_lock_undo_ex().

◆ ED_view3d_camera_to_view_selected()

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

◆ ED_view3d_camera_to_view_selected_with_set_clipping()

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

◆ ED_view3d_camera_view_pan()

bool ED_view3d_camera_view_pan ( struct ARegion region,
const float  event_ofs[2] 
)

Utility to pan when in camera view.

Parameters
event_ofsThe offset the pan in screen (pixel) coordinates.
Returns
true when a change was made.

Definition at line 525 of file view3d_utils.c.

References BKE_screen_view3d_zoom_to_fac(), RegionView3D::camdx, RegionView3D::camdy, RegionView3D::camzoom, CLAMP, ARegion::regiondata, ARegion::winx, and ARegion::winy.

Referenced by viewmove_apply().

◆ ED_view3d_camera_view_zoom_scale()

bool ED_view3d_camera_view_zoom_scale ( struct RegionView3D rv3d,
const float  scale 
)

Utility to scale zoom level when in camera-view RegionView3D.camzoom and apply limits.

Returns
true a change was made.

Definition at line 512 of file view3d_utils.c.

References BKE_screen_view3d_zoom_from_fac(), BKE_screen_view3d_zoom_to_fac(), RegionView3D::camzoom, CLAMP, RV3D_CAMZOOM_MAX, RV3D_CAMZOOM_MAX_FACTOR, RV3D_CAMZOOM_MIN, and RV3D_CAMZOOM_MIN_FACTOR.

◆ ED_view3d_clip_range_get()

bool ED_view3d_clip_range_get ( const struct Depsgraph depsgraph,
const struct View3D v3d,
const struct RegionView3D rv3d,
float r_clipsta,
float r_clipend,
bool  use_ortho_factor 
)

◆ ED_view3d_clip_segment()

bool ED_view3d_clip_segment ( const struct RegionView3D rv3d,
float  ray_start[3],
float  ray_end[3] 
)

◆ ED_view3d_clipping_calc()

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

◆ ED_view3d_clipping_calc_from_boundbox()

void ED_view3d_clipping_calc_from_boundbox ( float  clip[4][4],
const struct BoundBox clipbb,
bool  is_flip 
)

Referenced by calc_local_clipping().

◆ ED_view3d_clipping_clamp_minmax()

bool ED_view3d_clipping_clamp_minmax ( const struct 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.

Referenced by view3d_all_exec(), and viewselected_exec().

◆ ED_view3d_clipping_local()

void ED_view3d_clipping_local ( struct RegionView3D rv3d,
const float  mat[4][4] 
)

◆ ED_view3d_clipping_test()

bool ED_view3d_clipping_test ( const struct RegionView3D rv3d,
const float  co[3],
bool  is_local 
)

Return true when co is hidden by the 3D views clipping planes.

Parameters
is_localWhen true use local (object-space) ED_view3d_clipping_local must run first, then all comparisons can be done in local-space.
Returns
True when co is outside all clipping planes.
Note
Callers should check RV3D_CLIPPING_ENABLED first.

Referenced by ed_view3d_project__internal(), find_nearest_edge__doClosest(), knife_bvh_raycast_cb(), knife_find_closest_edge_of_face(), knife_find_closest_vert_of_edge(), knife_sample_screen_density_from_closest_face(), point_is_visible(), project_paint_face_init(), project_paint_occlude_ptv_clip(), and sculpt_brush_test_clipping().

◆ ED_view3d_context_activate()

bool ED_view3d_context_activate ( struct bContext C)

◆ ED_view3d_context_rv3d()

struct RegionView3D* ED_view3d_context_rv3d ( struct bContext C)

◆ ED_view3d_context_user_region()

bool ED_view3d_context_user_region ( struct bContext C,
struct View3D **  r_v3d,
struct ARegion **  r_region 
)

◆ ED_view3d_cursor3d_position()

void ED_view3d_cursor3d_position ( struct bContext C,
const int  mval[2],
bool  use_depth,
float  r_cursor_co[3] 
)

◆ ED_view3d_cursor3d_position_rotation()

void ED_view3d_cursor3d_position_rotation ( struct bContext C,
const int  mval[2],
bool  use_depth,
enum eV3DCursorOrient  orientation,
float  r_cursor_co[3],
float  r_cursor_quat[4] 
)

◆ ED_view3d_cursor3d_update()

void ED_view3d_cursor3d_update ( struct bContext C,
const int  mval[2],
bool  use_depth,
enum eV3DCursorOrient  orientation 
)

◆ ED_view3d_cursor_snap_active()

V3DSnapCursorState* ED_view3d_cursor_snap_active ( void  )

◆ ED_view3d_cursor_snap_context_ensure()

struct SnapObjectContext* ED_view3d_cursor_snap_context_ensure ( struct Scene scene)

◆ ED_view3d_cursor_snap_data_get()

V3DSnapCursorData* ED_view3d_cursor_snap_data_get ( void  )

◆ ED_view3d_cursor_snap_data_update()

void ED_view3d_cursor_snap_data_update ( V3DSnapCursorState state,
const struct bContext C,
int  x,
int  y 
)

◆ ED_view3d_cursor_snap_deactive()

void ED_view3d_cursor_snap_deactive ( V3DSnapCursorState state)

◆ ED_view3d_cursor_snap_draw_util()

void ED_view3d_cursor_snap_draw_util ( struct RegionView3D rv3d,
const float  loc_prev[3],
const float  loc_curr[3],
const float  normal[3],
const uchar  color_line[4],
const uchar  color_point[4],
eSnapMode  snap_elem_type 
)

◆ ED_view3d_cursor_snap_prevpoint_set()

void ED_view3d_cursor_snap_prevpoint_set ( V3DSnapCursorState state,
const float  prev_point[3] 
)

◆ ED_view3d_cursor_snap_state_default_set()

void ED_view3d_cursor_snap_state_default_set ( V3DSnapCursorState state)

◆ ED_view3d_cursor_snap_state_get()

V3DSnapCursorState* ED_view3d_cursor_snap_state_get ( void  )

◆ ED_view3d_datamask()

void ED_view3d_datamask ( const struct bContext C,
const struct Scene scene,
const struct View3D v3d,
struct CustomData_MeshMasks r_cddata_masks 
)

◆ ED_view3d_depth_override()

void ED_view3d_depth_override ( struct Depsgraph depsgraph,
struct ARegion region,
struct View3D v3d,
struct Object obact,
eV3DDepthOverrideMode  mode,
struct ViewDepths **  r_depths 
)

◆ ED_view3d_depth_read_cached()

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

◆ ED_view3d_depth_read_cached_normal()

bool ED_view3d_depth_read_cached_normal ( const struct ARegion region,
const ViewDepths depths,
const int  mval[2],
float  r_normal[3] 
)

◆ ED_view3d_depth_read_cached_seg()

bool ED_view3d_depth_read_cached_seg ( const ViewDepths vd,
const int  mval_sta[2],
const int  mval_end[2],
int  margin,
float depth 
)

◆ ED_view3d_depth_unproject_v3()

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

◆ ED_view3d_depths_free()

void ED_view3d_depths_free ( ViewDepths depths)

◆ ED_view3d_dist_range_get()

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

◆ ED_view3d_distance_set()

void ED_view3d_distance_set ( struct RegionView3D rv3d,
float  dist 
)

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

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

Definition at line 1251 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 ( struct RegionView3D rv3d,
const float  dist_co[3],
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 1271 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_draw_bgpic_test()

void ED_view3d_draw_bgpic_test ( const struct Scene scene,
struct Depsgraph depsgraph,
struct ARegion region,
struct View3D v3d,
bool  do_foreground,
bool  do_camera_frame 
)

Try avoid using these more move out of legacy.

◆ ED_view3d_draw_setup_view()

void ED_view3d_draw_setup_view ( const struct wmWindowManager wm,
struct wmWindow win,
struct Depsgraph depsgraph,
struct Scene scene,
struct ARegion region,
struct View3D v3d,
const float  viewmat[4][4],
const float  winmat[4][4],
const struct rcti rect 
)

◆ ED_view3d_engine_type()

struct RenderEngineType* ED_view3d_engine_type ( const struct Scene scene,
int  drawtype 
)

◆ 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 1466 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 struct 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 ofsto be set, normally from RegionView3D.dist.
lensThe view lens angle set for cameras and lights, normally from View3D.lens.

Referenced by axis_set_view(), and ED_view3d_smooth_view_ex().

◆ ED_view3d_give_base_under_cursor()

struct Base* ED_view3d_give_base_under_cursor ( struct bContext C,
const int  mval[2] 
)

mval comes from event->mval, only use within region handlers.

Definition at line 2282 of file view3d_select.c.

References C, ed_view3d_give_base_under_cursor_ex(), and NULL.

Referenced by datadropper_id_sample_pt(), ED_view3d_give_object_under_cursor(), and object_transfer_mode_invoke().

◆ ED_view3d_give_material_slot_under_cursor()

struct Object* ED_view3d_give_material_slot_under_cursor ( struct bContext C,
const int  mval[2],
int *  r_material_slot 
)

◆ ED_view3d_give_object_under_cursor()

struct Object* ED_view3d_give_object_under_cursor ( struct bContext C,
const int  mval[2] 
)

◆ ED_view3d_gizmo_mesh_preselect_clear()

void ED_view3d_gizmo_mesh_preselect_clear ( struct wmGizmo gz)

◆ ED_view3d_gizmo_mesh_preselect_get_active()

void ED_view3d_gizmo_mesh_preselect_get_active ( struct bContext C,
struct wmGizmo gz,
struct Base **  r_base,
struct BMElem **  r_ele 
)

◆ ED_view3d_global_to_vector()

void ED_view3d_global_to_vector ( const struct RegionView3D rv3d,
const float  coord[3],
float  vec[3] 
)

Calculate a normalized 3d direction vector from the viewpoint towards a global location. In orthographic view the resulting vector will match the view vector.

Parameters
rv3dThe region (used for the window width and height).
coordThe world-space location.
vecThe resulting normalized vector.

Referenced by add_vertex_invoke(), dial_ghostarc_get_angles(), ED_gpencil_project_point_to_plane(), ED_gpencil_project_stroke_to_plane(), gizmo_get_idot(), project_brush_radius(), update_location_for_2d_curve(), and v3d_cursor_plane_draw().

◆ ED_view3d_grid_scale()

float ED_view3d_grid_scale ( const struct Scene scene,
struct View3D v3d,
const char **  r_grid_unit 
)

◆ ED_view3d_grid_steps()

void ED_view3d_grid_steps ( const struct Scene scene,
struct View3D v3d,
struct RegionView3D rv3d,
float  r_grid_steps[8] 
)

Referenced by OVERLAY_grid_init().

◆ ED_view3d_grid_view_scale()

float ED_view3d_grid_view_scale ( struct Scene scene,
struct View3D v3d,
struct ARegion region,
const char **  r_grid_unit 
)

◆ ED_view3d_has_workbench_in_texture_color()

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

◆ ED_view3d_init_mats_rv3d()

void ED_view3d_init_mats_rv3d ( const struct Object ob,
struct RegionView3D rv3d 
)

Most of the time this isn't needed since you could assume the view matrix was set while drawing, however when functions like mesh_foreachScreenVert are called by selection tools, we can't be sure this object was the last.

for example, transparent objects are drawn after edit-mode and will cause the rv3d mat's to change and break selection.

'ED_view3d_init_mats_rv3d' should be called before view3d_project_short_clip and view3d_project_short_noclip in cases where these functions are not used during draw_object

Definition at line 166 of file space_view3d.c.

References ED_view3d_clipping_local(), mul_m4_m4m4(), Object::obmat, RegionView3D::persmat, RegionView3D::persmatob, RegionView3D::viewmat, and RegionView3D::viewmatob.

Referenced by armature_circle_select(), do_lasso_select_armature(), do_lasso_select_curve(), do_lasso_select_lattice(), do_lasso_select_mesh(), do_lasso_select_meta(), do_lasso_select_paintvert(), do_lasso_tag_pose(), do_lattice_box_select(), do_mesh_box_select(), do_nurbs_box_select(), do_paintvert_box_select(), drw_manager_init(), ED_curve_editfont_select_pick(), ED_curve_pick_vert_ex(), ED_mesh_pick_vert(), ED_view3d_init_mats_rv3d_gl(), edbm_dupli_extrude_cursor_invoke(), EDBM_edge_find_nearest_ex(), EDBM_face_find_nearest_ex(), edbm_knife_cut_exec(), edbm_polybuild_delete_at_cursor_invoke(), edbm_polybuild_face_at_cursor_invoke(), edbm_polybuild_split_at_cursor_invoke(), edbm_polybuild_transform_at_cursor_invoke(), EDBM_project_snap_verts(), EDBM_vert_find_nearest_ex(), findnearestLattvert(), knifetool_modal(), lattice_circle_select(), mball_circle_select(), mesh_circle_select(), mouse_mesh_loop(), nurbscurve_circle_select(), paint_vertsel_circle_select(), paint_weight_gradient_exec(), pose_circle_select(), sculpt_stroke_test_start(), vpaint_stroke_update_step_intern(), weight_paint_sample_enum_itemf(), weight_sample_invoke(), and wpaint_stroke_update_step().

◆ ED_view3d_init_mats_rv3d_gl()

void ED_view3d_init_mats_rv3d_gl ( const struct Object ob,
struct RegionView3D rv3d 
)

Definition at line 176 of file space_view3d.c.

References ED_view3d_init_mats_rv3d(), GPU_matrix_mul, and Object::obmat.

◆ ED_view3d_is_object_under_cursor()

bool ED_view3d_is_object_under_cursor ( struct bContext C,
const int  mval[2] 
)

Definition at line 2307 of file view3d_select.c.

References C, ED_view3d_give_object_under_cursor(), and NULL.

Referenced by view3d_ima_bg_drop_poll().

◆ ED_view3d_lastview_store()

void ED_view3d_lastview_store ( struct RegionView3D rv3d)

◆ ED_view3d_local_collections_reset()

void ED_view3d_local_collections_reset ( struct bContext C,
bool  reset_all 
)

◆ ED_view3d_local_collections_set()

bool ED_view3d_local_collections_set ( struct Main bmain,
struct View3D v3d 
)

See if current UUID is valid, otherwise set a valid UUID to v3d, Try to keep the same UUID previously used to allow users to quickly toggle back and forth.

Definition at line 1215 of file view3d_view.c.

References View3D::flag, free_localcollection_bit(), View3D::local_collections_uuid, reset, V3D_LOCAL_COLLECTIONS, and view3d_local_collections_reset().

◆ ED_view3d_lock()

bool ED_view3d_lock ( struct RegionView3D rv3d)

◆ ED_view3d_lock_clear()

void ED_view3d_lock_clear ( struct View3D v3d)

◆ ED_view3d_lock_view_from_index()

char ED_view3d_lock_view_from_index ( int  index)

◆ ED_view3d_mats_rv3d_backup()

struct RV3DMatrixStore* ED_view3d_mats_rv3d_backup ( struct RegionView3D rv3d)

◆ ED_view3d_mats_rv3d_restore()

void ED_view3d_mats_rv3d_restore ( struct RegionView3D rv3d,
struct RV3DMatrixStore rv3dmat 
)

◆ ED_view3d_ob_project_mat_get()

void ED_view3d_ob_project_mat_get ( const struct RegionView3D v3d,
const struct Object ob,
float  r_pmat[4][4] 
)

Referenced by blender::ed::sculpt_paint::CombOperationExecutor::comb_projected(), blender::ed::sculpt_paint::CombOperationExecutor::comb_spherical_with_symmetry(), content_planes_from_clip_flag(), createVertSlideVerts(), blender::ed::sculpt_paint::DeleteOperationExecutor::delete_projected(), blender::ed::sculpt_paint::DeleteOperationExecutor::delete_spherical_with_symmetry(), edbm_rip_edge_invoke(), edbm_rip_invoke__edge(), edbm_rip_invoke__vert(), edge_slide_projmat_get(), blender::ed::sculpt_paint::PuffOperationExecutor::find_curve_weights_projected(), blender::ed::sculpt_paint::find_curves_brush_position(), blender::ed::sculpt_paint::PuffOperationExecutor::find_curves_weights_spherical_with_symmetry(), blender::ed::sculpt_paint::SmoothOperationExecutor::find_projected_smooth_factors(), blender::ed::sculpt_paint::SmoothOperationExecutor::find_spherical_smooth_factors_with_symmetry(), blender::ed::sculpt_paint::CurvesEffectOperationExecutor::gather_influences_projected(), knifeproject_poly_from_object(), paint_convert_bb_to_rect(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_curve_selection_projected(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_curve_selection_spherical_with_symmetry(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_point_selection_projected(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_point_selection_spherical_with_symmetry(), blender::ed::sculpt_paint::PinchOperationExecutor::pinch_projected(), blender::ed::sculpt_paint::SnakeHookOperatorExecutor::projected_snake_hook(), blender::ed::sculpt_paint::DensitySubtractOperationExecutor::reduce_density_projected(), blender::ed::sculpt_paint::DensityAddOperationExecutor::sample_projected_with_symmetry(), sculpt_gesture_init_from_lasso(), sculpt_update_cache_invariants(), blender::ed::sculpt_paint::SlideOperationExecutor::slide(), blender::ed::sculpt_paint::SnakeHookOperatorExecutor::spherical_snake_hook_with_symmetry(), transform_mode_vert_slide_reproject_input(), and vwpaint_update_cache_invariants().

◆ ED_view3d_ob_project_mat_get_from_obmat()

void ED_view3d_ob_project_mat_get_from_obmat ( const struct RegionView3D rv3d,
const float  obmat[4][4],
float  r_pmat[4][4] 
)

◆ ED_view3d_offset_distance()

float ED_view3d_offset_distance ( const float  mat[4][4],
const float  ofs[3],
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 1230 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 struct View3D v3d,
const struct RegionView3D rv3d 
)

◆ ED_view3d_persp_ensure()

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

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

shared with NDOF.

Referenced by viewops_data_create(), and vieworbit_exec().

◆ ED_view3d_persp_switch_from_camera()

void ED_view3d_persp_switch_from_camera ( const struct Depsgraph depsgraph,
struct View3D v3d,
struct RegionView3D rv3d,
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.

Referenced by view3d_zoom_border_exec(), and viewdolly_invoke().

◆ ED_view3d_pixel_size()

float ED_view3d_pixel_size ( const struct RegionView3D rv3d,
const float  co[3] 
)

◆ ED_view3d_pixel_size_no_ui_scale()

float ED_view3d_pixel_size_no_ui_scale ( const struct RegionView3D rv3d,
const float  co[3] 
)

◆ ED_view3d_polygon_offset()

void ED_view3d_polygon_offset ( const struct RegionView3D rv3d,
float  dist 
)

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

◆ ED_view3d_project_base()

eV3DProjStatus ED_view3d_project_base ( const struct ARegion region,
struct Base base 
)

◆ ED_view3d_project_float_ex()

eV3DProjStatus ED_view3d_project_float_ex ( const struct ARegion region,
float  perspmat[4][4],
bool  is_local,
const float  co[3],
float  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_float_global()

eV3DProjStatus ED_view3d_project_float_global ( const struct ARegion region,
const float  co[3],
float  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_float_object()

eV3DProjStatus ED_view3d_project_float_object ( const struct ARegion region,
const float  co[3],
float  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_float_v2_m4()

void ED_view3d_project_float_v2_m4 ( const struct ARegion region,
const float  co[3],
float  r_co[2],
const float  mat[4][4] 
)

◆ ED_view3d_project_float_v3_m4()

void ED_view3d_project_float_v3_m4 ( const struct ARegion region,
const float  co[3],
float  r_co[3],
const float  mat[4][4] 
)
Note
use ED_view3d_ob_project_mat_get to get projecting mat

Referenced by edge_slide_pair_project().

◆ ED_view3d_project_int_ex()

eV3DProjStatus ED_view3d_project_int_ex ( const struct ARegion region,
float  perspmat[4][4],
bool  is_local,
const float  co[3],
int  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_int_global()

eV3DProjStatus ED_view3d_project_int_global ( const struct ARegion region,
const float  co[3],
int  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_int_object()

eV3DProjStatus ED_view3d_project_int_object ( const struct ARegion region,
const float  co[3],
int  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_short_ex()

eV3DProjStatus ED_view3d_project_short_ex ( const struct ARegion region,
float  perspmat[4][4],
bool  is_local,
const float  co[3],
short  r_co[2],
eV3DProjTest  flag 
)

Referenced by DRW_text_cache_draw().

◆ ED_view3d_project_short_global()

eV3DProjStatus ED_view3d_project_short_global ( const struct ARegion region,
const float  co[3],
short  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_short_object()

eV3DProjStatus ED_view3d_project_short_object ( const struct ARegion region,
const float  co[3],
short  r_co[2],
eV3DProjTest  flag 
)

◆ ED_view3d_project_v2()

void ED_view3d_project_v2 ( const struct ARegion region,
const float  world[3],
float  r_region_co[2] 
)

◆ ED_view3d_project_v3()

void ED_view3d_project_v3 ( const struct ARegion region,
const float  world[3],
float  r_region_co[3] 
)

Convert between region relative coordinates (x,y) and depth component z and a point in world space.

Definition at line 700 of file view3d_project.c.

References GPU_matrix_project_3fv(), ARegion::regiondata, RegionView3D::viewmat, RegionView3D::winmat, ARegion::winx, ARegion::winy, and world.

Referenced by cursor_draw_point_screen_space(), key_test_depth(), and object_transform_axis_target_calc_depth_init().

◆ ED_view3d_quadview_update()

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

◆ ED_view3d_quat_from_axis_view()

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

◆ ED_view3d_quat_to_axis_view()

bool ED_view3d_quat_to_axis_view ( const float  viewquat[4],
float  epsilon,
char *  r_view,
char *  r_view_axis_rotation 
)

◆ ED_view3d_quat_to_axis_view_and_reset_quat()

bool ED_view3d_quat_to_axis_view_and_reset_quat ( float  viewquat[4],
float  epsilon,
char *  r_view,
char *  r_view_axis_rotation 
)

A version of ED_view3d_quat_to_axis_view that updates viewquat if it's within epsilon to an axis-view.

Note
Include the special case function since most callers need to perform these operations.

Definition at line 1407 of file view3d_utils.c.

References BLI_assert, ED_view3d_quat_from_axis_view(), ED_view3d_quat_to_axis_view(), blender::robust_pred::epsilon, and RV3D_VIEW_USER.

Referenced by view_roll_angle(), and viewrotate_apply_snap().

◆ ED_view3d_radius_to_dist()

float ED_view3d_radius_to_dist ( const struct View3D v3d,
const struct ARegion region,
const struct Depsgraph depsgraph,
char  persp,
bool  use_aspect,
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).

Referenced by view3d_from_minmax(), and view3d_localview_init().

◆ ED_view3d_radius_to_dist_ortho()

float ED_view3d_radius_to_dist_ortho ( float  lens,
float  radius 
)

Definition at line 1145 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 ( float  angle,
float  radius 
)

Definition at line 1140 of file view3d_utils.c.

References angle(), and tanf.

Referenced by ED_view3d_radius_to_dist().

◆ ED_view3d_screen_datamask()

void ED_view3d_screen_datamask ( const struct bContext C,
const struct Scene scene,
const struct bScreen screen,
struct CustomData_MeshMasks r_cddata_masks 
)

Goes over all modes and view3d settings.

Referenced by wm_event_do_depsgraph().

◆ ED_view3d_select_dist_px()

float ED_view3d_select_dist_px ( void  )

◆ ED_view3d_select_filter_from_mode()

eV3DSelectObjectFilter ED_view3d_select_filter_from_mode ( const struct Scene scene,
const struct Object obact 
)

◆ ED_view3d_select_id_validate()

void ED_view3d_select_id_validate ( struct ViewContext vc)

◆ ED_view3d_shade_update()

void ED_view3d_shade_update ( struct Main bmain,
struct View3D v3d,
struct ScrArea area 
)

◆ ED_view3d_snap_selected_to_location()

bool ED_view3d_snap_selected_to_location ( struct bContext C,
const float  snap_target_global[3],
int  pivot_point 
)

Definition at line 573 of file view3d_snap.c.

References C, and snap_selected_to_location().

Referenced by object_transform_to_mouse_exec().

◆ ED_view3d_stop_render_preview()

void ED_view3d_stop_render_preview ( struct wmWindowManager wm,
struct ARegion region 
)

◆ ED_view3d_to_m4()

void ED_view3d_to_m4 ( float  mat[4][4],
const float  ofs[3],
const float  quat[4],
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 1492 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 struct Depsgraph depsgraph,
struct Object ob,
const float  ofs[3],
const float  quat[4],
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.

Referenced by view3d_camera_to_view_exec().

◆ ED_view3d_unproject_v3()

bool ED_view3d_unproject_v3 ( const struct ARegion region,
float  regionx,
float  regiony,
float  regionz,
float  world[3] 
)

◆ ED_view3d_update_viewmat()

void ED_view3d_update_viewmat ( struct Depsgraph depsgraph,
const struct Scene scene,
struct View3D v3d,
struct ARegion region,
const float  viewmat[4][4],
const float  winmat[4][4],
const struct rcti rect,
bool  offscreen 
)

◆ ED_view3d_viewcontext_init()

void ED_view3d_viewcontext_init ( struct bContext C,
struct ViewContext vc,
struct Depsgraph depsgraph 
)

Definition at line 106 of file view3d_select.c.

References ViewContext::bmain, ViewContext::C, C, CTX_data_active_object(), CTX_data_edit_object(), CTX_data_main(), CTX_data_scene(), CTX_data_view_layer(), CTX_wm_region(), CTX_wm_region_view3d(), CTX_wm_view3d(), CTX_wm_window(), depsgraph, ViewContext::depsgraph, ViewContext::obact, ViewContext::obedit, ViewContext::region, ViewContext::rv3d, ViewContext::scene, ViewContext::v3d, ViewContext::view_layer, and ViewContext::win.

Referenced by add_vertex_invoke(), clip_planes_from_rect(), curve_draw_init(), curve_pen_invoke(), curve_pen_modal(), ED_armature_edit_deselect_all_visible_multi(), ED_armature_edit_select_pick(), ed_armature_pick_bone_impl(), ED_curve_deselect_all_multi(), ED_curve_editfont_select_pick(), ED_curve_editnurb_select_pick(), ED_lattice_deselect_all_multi(), ED_lattice_select_pick(), ED_mball_deselect_all_multi(), ed_mball_findnearest_metaelem(), ED_mesh_pick_face(), ED_mesh_pick_vert(), ed_object_select_pick(), ED_pose_deselect_all_multi(), ED_sculpt_update_modal_transform(), ed_view3d_give_base_under_cursor_ex(), EDBM_mesh_deselect_all_multi(), EDBM_selectmode_disable_multi(), edcu_shortest_path_pick_invoke(), em_setup_viewcontext(), object_transform_axis_target_invoke(), paint_cursor_context_init(), paint_sample_color(), paint_stroke_new(), PE_set_view3d_data(), sample_detail(), SCULPT_cursor_geometry_info_update(), SCULPT_filter_cache_init(), sculpt_gesture_context_init_common(), SCULPT_stroke_get_location(), select_linked_pick_invoke(), blender::ed::sculpt_paint::image::ops::paint::texture_paint_init(), view3d_box_select_exec(), view3d_circle_select_exec(), view3d_circle_select_recalc(), view3d_lasso_select_exec(), view3d_select_exec(), vpaint_init_vpaint(), weight_paint_sample_enum_itemf(), weight_sample_group_exec(), weight_sample_invoke(), and wpaint_stroke_test_start().

◆ ED_view3d_viewcontext_init_object()

void ED_view3d_viewcontext_init_object ( struct ViewContext vc,
struct Object obact 
)

Re-initialize vc with obact as if it's active object (with some differences).

This is often used when operating on multiple objects in modes (edit, pose mode etc) where the vc is passed in as an argument which then references it's object data.

Note
members ViewContext.obedit & ViewContext.em are only initialized if they're already set, by ED_view3d_viewcontext_init in most cases. This is necessary because the active object defines the current object-mode. When iterating over objects in object-mode it doesn't make sense to perform an edit-mode action on an object that happens to contain edit-mode data. In some cases these values are cleared allowing the owner of vc to explicitly disable edit-mode operation (to force object selection in edit-mode for e.g.). So object-mode specific values should remain cleared when initialized with another object.

Definition at line 124 of file view3d_select.c.

References BKE_editmesh_from_object(), BKE_object_is_in_editmode(), BLI_assert, ViewContext::em, ViewContext::obact, and ViewContext::obedit.

Referenced by ED_curve_pick_vert_ex(), ED_lattice_select_pick(), edbm_dupli_extrude_cursor_invoke(), EDBM_edge_find_nearest_ex(), EDBM_face_find_nearest_ex(), edbm_preselect_or_active_init_viewcontext(), edbm_select_linked_pick_invoke(), EDBM_select_pick(), edbm_shortest_path_pick_invoke(), EDBM_unified_findnearest_from_raycast(), EDBM_vert_find_nearest_ex(), edcu_shortest_path_pick_invoke(), findnearestLattvert(), knifeproject_exec(), loopcut_init(), loopcut_mouse_move(), mouse_mesh_loop(), view3d_box_select_exec(), view3d_circle_select_exec(), view3d_circle_select_recalc(), and view3d_lasso_select().

◆ ED_view3d_viewplane_get()

bool ED_view3d_viewplane_get ( struct Depsgraph depsgraph,
const struct View3D v3d,
const struct RegionView3D rv3d,
int  winxi,
int  winyi,
struct rctf r_viewplane,
float r_clipsta,
float r_clipend,
float r_pixsize 
)

◆ ED_view3d_win_to_3d()

void ED_view3d_win_to_3d ( const struct View3D v3d,
const struct ARegion region,
const float  depth_pt[3],
const float  mval[2],
float  r_out[3] 
)

Calculate a 3d location from 2d window coordinates.

Parameters
regionThe region (used for the window width and height).
depth_ptThe reference location used to calculate the Z depth.
mvalThe area relative location (such as event->mval converted to floats).
r_outThe resulting world-space location.

Referenced by armature_click_extrude_invoke(), blender::ed::sculpt_paint::CombOperationExecutor::comb_spherical_with_symmetry(), curve_draw_invoke(), blender::ed::sculpt_paint::DeleteOperationExecutor::delete_spherical_with_symmetry(), depthdropper_depth_sample_pt(), blender::ed::sculpt_paint::PuffOperationExecutor::find_curves_weights_spherical_with_symmetry(), blender::ed::sculpt_paint::SmoothOperationExecutor::find_spherical_smooth_factors_with_symmetry(), blender::ed::sculpt_paint::CurvesEffectOperationExecutor::gather_influences_spherical(), gizmo_window_project_3d(), gpencil_strokepoint_convertcoords(), initBend(), knife_constrain_axis(), knifetool_raycast_planes(), mesh_bisect_interactive_calc(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_curve_selection_spherical_with_symmetry(), blender::ed::sculpt_paint::SelectionPaintOperationExecutor::paint_point_selection_spherical_with_symmetry(), blender::ed::sculpt_paint::PinchOperationExecutor::pinch_spherical_with_symmetry(), screenspace_to_worldspace(), sculpt_gesture_line_calculate_plane_points(), sculpt_gesture_trim_geometry_generate(), sculpt_update_brush_delta(), blender::ed::sculpt_paint::SnakeHookOperatorExecutor::spherical_snake_hook_with_symmetry(), stroke_elem_project_fallback(), v3d_cursor_snap_update(), and viewops_data_create().

◆ ED_view3d_win_to_3d_int()

void ED_view3d_win_to_3d_int ( const struct View3D v3d,
const struct ARegion region,
const float  depth_pt[3],
const int  mval[2],
float  r_out[3] 
)

◆ ED_view3d_win_to_3d_on_plane()

bool ED_view3d_win_to_3d_on_plane ( const struct ARegion region,
const float  plane[4],
const float  mval[2],
bool  do_clip,
float  r_out[3] 
)

◆ ED_view3d_win_to_3d_on_plane_int()

bool ED_view3d_win_to_3d_on_plane_int ( const struct ARegion region,
const float  plane[4],
const int  mval[2],
bool  do_clip,
float  r_out[3] 
)

◆ ED_view3d_win_to_3d_on_plane_with_fallback()

bool ED_view3d_win_to_3d_on_plane_with_fallback ( const struct ARegion region,
const float  plane[4],
const float  mval[2],
bool  do_clip,
const float  plane_fallback[4],
float  r_out[3] 
)

A wrapper for ED_view3d_win_to_3d_on_plane that projects onto plane_fallback then maps this back to plane.

This is intended to be used when plane is orthogonal to the views Z axis where projecting the mval doesn't work well (or fail completely when exactly aligned).

Referenced by view3d_win_to_3d_on_plane_maybe_fallback().

◆ ED_view3d_win_to_delta()

void ED_view3d_win_to_delta ( const struct ARegion region,
const float  xy_delta[2],
float  zfac,
float  r_out[3] 
)

Calculate a 3d difference vector from 2d window offset.

Note
that ED_view3d_calc_zfac() must be called first to determine the depth used to calculate the delta.

When the zfac is calculated based on a world-space location directly under the cursor, the value of r_out can be subtracted from RegionView3D.ofs to pan the view with the contents following the cursor perfectly (without sliding).

Parameters
regionThe region (used for the window width and height).
xy_delta2D difference (in pixels) such as event->mval[0] - other_x.
zfacThe depth result typically calculated by ED_view3d_calc_zfac (see it's doc-string for details).
r_outThe resulting world-space delta.

Referenced by annotation_stroke_convertcoords(), brush_edit_apply(), calc_local_y(), calcVertSlideMouseActiveEdges(), convertViewVec(), drawVertSlide(), gpencil_brush_calc_midpoint(), gpencil_brush_grab_calc_dvec(), gpencil_brush_randomize_apply(), gpencil_point_xy_to_3d(), gpencil_stroke_convertcoords(), gpencil_stroke_convertcoords_tpoint(), initMouseInput(), mesh_bisect_interactive_calc(), move3d_get_translate(), paint_calc_object_space_radius(), view3d_zoom_border_exec(), view_zoom_to_window_xy_3d(), and viewmove_apply().

◆ ED_view3d_win_to_origin()

void ED_view3d_win_to_origin ( const struct ARegion region,
const float  mval[2],
float  r_out[3] 
)

Calculate a 3d origin from 2d window coordinates.

Note
Orthographic views have a less obvious origin, Since far clip can be a very large value resulting in numeric precision issues, the origin in this case is close to zero coordinate.
Parameters
regionThe region (used for the window width and height).
mvalThe area relative 2d location (such as event->mval converted to float).
r_outThe resulting normalized world-space direction vector.

◆ ED_view3d_win_to_ray()

void ED_view3d_win_to_ray ( const struct ARegion region,
const float  mval[2],
float  r_ray_start[3],
float  r_ray_normal[3] 
)

Calculate a 3d viewpoint and direction vector from 2d window coordinates. This ray_start is located at the viewpoint, ray_normal is the direction towards mval.

Parameters
regionThe region (used for the window width and height).
mvalThe area relative 2d location (such as event->mval, converted into float[2]).
r_ray_startThe world-space point where the ray intersects the window plane.
r_ray_normalThe normalized world-space direction of towards mval.
Note
Ignores view near/far clipping, to take this into account use ED_view3d_win_to_ray_clipped.

Referenced by gizmo_arrow_modal(), and object_transform_axis_target_calc_depth_init().

◆ ED_view3d_win_to_ray_clipped()

bool ED_view3d_win_to_ray_clipped ( struct Depsgraph depsgraph,
const struct ARegion region,
const struct View3D v3d,
const float  mval[2],
float  r_ray_start[3],
float  r_ray_normal[3],
bool  do_clip_planes 
)

Calculate a 3d viewpoint and direction vector from 2d window coordinates. This ray_start is located at the viewpoint, ray_normal is the direction towards mval. ray_start is clipped by the view near limit so points in front of it are always in view. In orthographic view the resulting ray_normal will match the view vector.

Parameters
regionThe region (used for the window width and height).
v3dThe 3d viewport (used for near clipping value).
mvalThe area relative 2d location (such as event->mval, converted into float[2]).
r_ray_startThe world-space point where the ray intersects the window plane.
r_ray_normalThe normalized world-space direction of towards mval.
do_clip_planesOptionally clip the start of the ray by the view clipping planes.
Returns
success, false if the ray is totally clipped.

Referenced by ED_gpencil_stroke_reproject(), and EDBM_unified_findnearest_from_raycast().

◆ ED_view3d_win_to_ray_clipped_ex()

bool ED_view3d_win_to_ray_clipped_ex ( struct Depsgraph depsgraph,
const struct ARegion region,
const struct View3D v3d,
const float  mval[2],
float  r_ray_co[3],
float  r_ray_normal[3],
float  r_ray_start[3],
bool  do_clip_planes 
)

Calculate a 3d viewpoint and direction vector from 2d window coordinates. This ray_start is located at the viewpoint, ray_normal is the direction towards mval. ray_start is clipped by the view near limit so points in front of it are always in view. In orthographic view the resulting ray_normal will match the view vector. This version also returns the ray_co point of the ray on window plane, useful to fix precision issues especially with orthographic view, where default ray_start is set rather far away.

Parameters
regionThe region (used for the window width and height).
v3dThe 3d viewport (used for near clipping value).
mvalThe area relative 2d location (such as event->mval, converted into float[2]).
r_ray_coThe world-space point where the ray intersects the window plane.
r_ray_normalThe normalized world-space direction of towards mval.
r_ray_startThe world-space starting point of the ray.
do_clip_planesOptionally clip the start of the ray by the view clipping planes.
Returns
success, false if the ray is totally clipped.

Referenced by ED_transform_snap_object_project_all_view3d_ex(), and transform_snap_context_project_view3d_mixed_impl().

◆ ED_view3d_win_to_segment_clipped()

bool ED_view3d_win_to_segment_clipped ( const struct Depsgraph depsgraph,
const struct ARegion region,
const struct View3D v3d,
const float  mval[2],
float  r_ray_start[3],
float  r_ray_end[3],
bool  do_clip_planes 
)

Calculate a 3d segment from 2d window coordinates. This ray_start is located at the viewpoint, ray_end is a far point. ray_start and ray_end are clipped by the view near and far limits so points along this line are always in view. In orthographic view all resulting segments will be parallel.

Parameters
regionThe region (used for the window width and height).
v3dThe 3d viewport (used for near and far clipping range).
mvalThe area relative 2d location (such as event->mval, converted into float[2]).
r_ray_startThe world-space starting point of the segment.
r_ray_endThe world-space end point of the segment.
do_clip_planesOptionally clip the ray by the view clipping planes.
Returns
success, false if the segment is totally clipped.

Referenced by BMBVH_EdgeVisible(), brush_add_count_iter(), knife_find_line_hits(), blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_invoke(), blender::ed::sculpt_paint::sample_curves_3d_brush(), blender::ed::sculpt_paint::sample_curves_surface_3d_brush(), blender::ed::sculpt_paint::AddOperationExecutor::sample_in_center_with_symmetry(), blender::ed::sculpt_paint::AddOperationExecutor::sample_projected(), blender::ed::sculpt_paint::DensityAddOperationExecutor::sample_projected_with_symmetry(), blender::ed::sculpt_paint::AddOperationExecutor::sample_spherical_with_symmetry(), and SCULPT_raycast_init().

◆ ED_view3d_win_to_vector()

void ED_view3d_win_to_vector ( const struct ARegion region,
const float  mval[2],
float  r_out[3] 
)

Calculate a 3d direction vector from 2d window coordinates. This direction vector starts and the view in the direction of the 2d window coordinates. In orthographic view all window coordinates yield the same vector.

Note
doesn't rely on ED_view3d_calc_zfac for perspective view, get the vector direction to the mouse cursor as a normalized vector.
Parameters
regionThe region (used for the window width and height).
mvalThe area relative 2d location (such as event->mval converted to float).
r_outThe resulting normalized world-space direction vector.

Referenced by gizmo_find_intersected_3d_intern(), mesh_bisect_interactive_calc(), and viewops_data_create().

◆ edge_inside_circle()

bool edge_inside_circle ( const float  cent[2],
float  radius,
const float  screen_co_a[2],
const float  screen_co_b[2] 
)

◆ ENUM_OPERATORS()

ENUM_OPERATORS ( eV3DProjTest  ,
V3D_PROJ_TEST_CLIP_CONTENT   
)

◆ lattice_foreachScreenVert()

void lattice_foreachScreenVert ( struct ViewContext vc,
void(*)(void *userData, struct BPoint *bp, const float screen_co[2])  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ mball_foreachScreenElem()

void mball_foreachScreenElem ( struct ViewContext vc,
void(*)(void *userData, struct MetaElem *ml, const float screen_co[2])  func,
void userData,
eV3DProjTest  clip_flag 
)

ED_view3d_init_mats_rv3d must be called first.

Referenced by do_lasso_select_meta(), and mball_circle_select().

◆ mesh_foreachScreenEdge()

void mesh_foreachScreenEdge ( struct ViewContext vc,
void(*)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index)  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ mesh_foreachScreenEdge_clip_bb_segment()

void mesh_foreachScreenEdge_clip_bb_segment ( struct ViewContext vc,
void(*)(void *userData, struct BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index)  func,
void userData,
eV3DProjTest  clip_flag 
)

A version of mesh_foreachScreenEdge that clips the segment when there is a clipping bounding box.

Referenced by do_lasso_select_mesh(), do_mesh_box_select(), and mesh_circle_select().

◆ mesh_foreachScreenFace()

void mesh_foreachScreenFace ( struct ViewContext vc,
void(*)(void *userData, struct BMFace *efa, const float screen_co[2], int index)  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ mesh_foreachScreenVert()

void mesh_foreachScreenVert ( struct ViewContext vc,
void(*)(void *userData, struct BMVert *eve, const float screen_co[2], int index)  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ meshobject_foreachScreenVert()

void meshobject_foreachScreenVert ( struct ViewContext vc,
void(*)(void *userData, struct MVert *eve, const float screen_co[2], int index)  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ nurbs_foreachScreenVert()

void nurbs_foreachScreenVert ( struct ViewContext vc,
void(*)(void *userData, struct Nurb *nu, struct BPoint *bp, struct BezTriple *bezt, int beztindex, bool handle_visible, const float screen_co[2])  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ pose_foreachScreenBone()

void pose_foreachScreenBone ( struct ViewContext vc,
void(*)(void *userData, struct bPoseChannel *pchan, const float screen_co_a[2], const float screen_co_b[2])  func,
void userData,
eV3DProjTest  clip_flag 
)

◆ view3d_opengl_select()

int view3d_opengl_select ( struct ViewContext vc,
struct GPUSelectResult buffer,
unsigned int  buffer_len,
const struct rcti input,
eV3DSelectMode  select_mode,
eV3DSelectObjectFilter  select_filter 
)

◆ view3d_opengl_select_cache_begin()

void view3d_opengl_select_cache_begin ( void  )

Optionally cache data for multiple calls to view3d_opengl_select

just avoid GPU_select headers outside this file

Definition at line 465 of file view3d_view.c.

References GPU_select_cache_begin().

Referenced by get_nearest_editbonepoint(), and mixed_bones_object_selectbuffer().

◆ view3d_opengl_select_cache_end()

void view3d_opengl_select_cache_end ( void  )

Definition at line 470 of file view3d_view.c.

References GPU_select_cache_end().

Referenced by get_nearest_editbonepoint(), and mixed_bones_object_selectbuffer().

◆ view3d_opengl_select_ex()

int view3d_opengl_select_ex ( struct ViewContext vc,
struct GPUSelectResult buffer,
unsigned int  buffer_len,
const struct rcti input,
eV3DSelectMode  select_mode,
eV3DSelectObjectFilter  select_filter,
bool  do_material_slot_selection 
)
Warning
be sure to account for a negative return value This is an error, "Too many objects in select buffer" and no action should be taken (can crash blender) if this happens
Note
(vc->obedit == NULL) can be set to explicitly skip edit-object selection.

Referenced by mixed_bones_object_selectbuffer().

◆ view3d_opengl_select_with_id_filter()

int view3d_opengl_select_with_id_filter ( struct ViewContext vc,
struct GPUSelectResult buffer,
unsigned int  buffer_len,
const struct rcti input,
eV3DSelectMode  select_mode,
eV3DSelectObjectFilter  select_filter,
uint  select_id 
)

◆ view3d_operator_needs_opengl()

void view3d_operator_needs_opengl ( const struct bContext C)

◆ view3d_region_operator_needs_opengl()

void view3d_region_operator_needs_opengl ( struct wmWindow win,
struct ARegion region 
)