Blender V5.3
ED_view3d.hh File Reference
#include <array>
#include "BLI_bounds_types.hh"
#include "BLI_enum_flags.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_math_vector_types.hh"
#include "DNA_scene_types.h"

Go to the source code of this file.

Classes

struct  blender::ViewContext
struct  blender::ViewDepths
struct  blender::V3DSnapCursorData
struct  blender::V3DSnapCursorState
class  blender::ViewportColorSampleSession

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::ed
namespace  blender::ed::transform
namespace  blender::gpu

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 VIEW3D_MARGIN   1.4f
#define VIEW3D_DIST_FALLBACK   1.0f
#define SHADING_XRAY_ALPHA(shading)
#define SHADING_XRAY_FLAG(shading)
#define SHADING_XRAY_FLAG_ENABLED(shading)
#define SHADING_XRAY_ENABLED(shading)
#define SHADING_XRAY_ACTIVE(shading)
#define XRAY_ALPHA(v3d)
#define XRAY_FLAG(v3d)
#define XRAY_FLAG_ENABLED(v3d)
#define XRAY_ENABLED(v3d)
#define XRAY_ACTIVE(v3d)
#define OVERLAY_RETOPOLOGY_ENABLED(overlay)
#define OVERLAY_RETOPOLOGY_MIN_OFFSET   FLT_EPSILON
#define OVERLAY_RETOPOLOGY_OFFSET(overlay)
#define RETOPOLOGY_ENABLED(v3d)
#define RETOPOLOGY_OFFSET(v3d)

Enumerations

enum  blender::eV3DCursorOrient { blender::V3D_CURSOR_ORIENT_NONE = 0 , blender::V3D_CURSOR_ORIENT_VIEW , blender::V3D_CURSOR_ORIENT_XFORM , blender::V3D_CURSOR_ORIENT_GEOM }
enum  blender::eV3DDepthOverrideMode {
  blender::V3D_DEPTH_ALL = 0 , blender::V3D_DEPTH_NO_GPENCIL , blender::V3D_DEPTH_GPENCIL_ONLY , blender::V3D_DEPTH_OBJECT_ONLY ,
  blender::V3D_DEPTH_SELECTED_ONLY
}
enum  blender::eV3DProjStatus {
  blender::V3D_PROJ_RET_OK = 0 , blender::V3D_PROJ_RET_CLIP_NEAR = 1 , blender::V3D_PROJ_RET_CLIP_FAR = 2 , blender::V3D_PROJ_RET_CLIP_ZERO = 3 ,
  blender::V3D_PROJ_RET_CLIP_BB = 4 , blender::V3D_PROJ_RET_CLIP_WIN = 5 , blender::V3D_PROJ_RET_OVERFLOW = 6
}
enum  blender::eV3DProjTest {
  blender::V3D_PROJ_TEST_NOP = 0 , blender::V3D_PROJ_TEST_CLIP_BB = (1 << 0) , blender::V3D_PROJ_TEST_CLIP_WIN = (1 << 1) , blender::V3D_PROJ_TEST_CLIP_NEAR = (1 << 2) ,
  blender::V3D_PROJ_TEST_CLIP_FAR = (1 << 3) , blender::V3D_PROJ_TEST_CLIP_ZERO = (1 << 4) , blender::V3D_PROJ_TEST_CLIP_CONTENT = (1 << 5)
}
enum  blender::eV3DSnapCursor {
  blender::V3D_SNAPCURSOR_TOGGLE_ALWAYS_TRUE = 1 << 0 , blender::V3D_SNAPCURSOR_OCCLUSION_ALWAYS_TRUE = 1 << 1 , blender::V3D_SNAPCURSOR_OCCLUSION_ALWAYS_FALSE = 1 << 2 , blender::V3D_SNAPCURSOR_SNAP_EDIT_GEOM_FINAL = 1 << 3 ,
  blender::V3D_SNAPCURSOR_SNAP_EDIT_GEOM_CAGE = 1 << 4
}
enum  blender::eV3DSelectMode { blender::VIEW3D_SELECT_ALL = 0 , blender::VIEW3D_SELECT_PICK_ALL = 1 , blender::VIEW3D_SELECT_PICK_NEAREST = 2 }
enum  blender::eV3DSelectObjectFilter { blender::VIEW3D_SELECT_FILTER_NOP = 0 , blender::VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK = 1 , blender::VIEW3D_SELECT_FILTER_OBJECT_MODE_LOCK_SAME_TYPE = 2 , blender::VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK = 3 }
enum class  blender::eV3DSelectShape { blender::BOX , blender::CIRCLE }
enum class  blender::eRegionView3D_ViewFlipRoll : int8_t {
  blender::Roll0 , blender::Roll90 , blender::Roll180 , blender::Roll270 ,
  blender::RollOther , blender::FlipX , blender::FlipY , blender::FlipOther
}

Functions

 blender::ENUM_OPERATORS (eV3DProjTest)
void blender::ED_view3d_cursor_snap_state_default_set (V3DSnapCursorState *state)
V3DSnapCursorState * blender::ED_view3d_cursor_snap_state_active_get ()
void blender::ED_view3d_cursor_snap_state_active_set (V3DSnapCursorState *state)
V3DSnapCursorState * blender::ED_view3d_cursor_snap_state_create ()
void blender::ED_view3d_cursor_snap_state_free (V3DSnapCursorState *state)
void blender::ED_view3d_cursor_snap_state_prevpoint_set (V3DSnapCursorState *state, const float prev_point[3])
void blender::ED_view3d_cursor_snap_data_update (V3DSnapCursorState *state, const bContext *C, const ARegion *region, const int2 &mval)
V3DSnapCursorData * blender::ED_view3d_cursor_snap_data_get ()
ed::transform::SnapObjectContext * blender::ED_view3d_cursor_snap_context_ensure (Scene *scene)
float2 blender::ED_view3d_project_float_v2_m4 (const ARegion *region, const float co[3], const float4x4 &mat)
void blender::ED_view3d_project_float_v3_m4 (const ARegion *region, const float co[3], float r_co[3], const float mat[4][4])
eV3DProjStatus blender::ED_view3d_project_base (const ARegion *region, Base *base, float r_co[2])
eV3DProjStatus blender::ED_view3d_project_short_ex (const ARegion *region, float perspmat[4][4], bool is_local, const float co[3], short r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_short_global (const ARegion *region, const float co[3], short r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_short_object (const ARegion *region, const float co[3], short r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_int_ex (const ARegion *region, float perspmat[4][4], bool is_local, const float co[3], int r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_int_global (const ARegion *region, const float co[3], int r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_int_object (const ARegion *region, const float co[3], int r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_float_ex (const ARegion *region, float perspmat[4][4], bool is_local, const float co[3], float r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_float_global (const ARegion *region, const float co[3], float r_co[2], eV3DProjTest flag)
eV3DProjStatus blender::ED_view3d_project_float_object (const ARegion *region, const float co[3], float r_co[2], eV3DProjTest flag)
float blender::ED_view3d_pixel_size (const RegionView3D *rv3d, const float co[3])
float blender::ED_view3d_pixel_size_no_ui_scale (const RegionView3D *rv3d, const float co[3])
float blender::ED_view3d_calc_zfac_ex (const RegionView3D *rv3d, const float co[3], bool *r_flip)
float blender::ED_view3d_calc_zfac (const RegionView3D *rv3d, const float co[3])
float blender::ED_view3d_calc_depth_for_comparison (const RegionView3D *rv3d, const float co[3])
bool blender::ED_view3d_clip_segment (const RegionView3D *rv3d, float ray_start[3], float ray_end[3])
bool blender::ED_view3d_win_to_ray_clipped (Depsgraph *depsgraph, const ARegion *region, const View3D *v3d, const float mval[2], float r_ray_start[3], float r_ray_normal[3], bool do_clip_planes)
bool blender::ED_view3d_win_to_ray_clipped_ex (Depsgraph *depsgraph, const ARegion *region, const View3D *v3d, const float mval[2], const bool do_clip_planes, float r_ray_co[3], float r_ray_normal[3], float r_ray_start[3], float r_ray_end[3])
void blender::ED_view3d_win_to_ray (const ARegion *region, const float mval[2], float r_ray_start[3], float r_ray_normal[3])
void blender::ED_view3d_global_to_vector (const RegionView3D *rv3d, const float coord[3], float r_out[3])
void blender::ED_view3d_win_to_3d (const View3D *v3d, const ARegion *region, const float depth_pt[3], const float mval[2], float r_out[3])
void blender::ED_view3d_win_to_3d_int (const View3D *v3d, const ARegion *region, const float depth_pt[3], const int mval[2], float r_out[3])
void blender::ED_view3d_win_to_3d_with_shift (const View3D *v3d, const ARegion *region, const float depth_pt[3], const float mval[2], float r_out[3])
bool blender::ED_view3d_win_to_3d_on_plane (const ARegion *region, const float plane[4], const float mval[2], bool do_clip, float r_out[3])
bool blender::ED_view3d_win_to_3d_on_plane_with_fallback (const ARegion *region, const float plane[4], const float mval[2], bool do_clip, const float plane_fallback[4], float r_out[3])
bool blender::ED_view3d_win_to_3d_on_plane_int (const ARegion *region, const float plane[4], const int mval[2], bool do_clip, float r_out[3])
void blender::ED_view3d_win_to_delta (const ARegion *region, const float xy_delta[2], float zfac, float r_out[3], bool precise=false)
void blender::ED_view3d_win_to_origin (const ARegion *region, const float mval[2], float r_out[3])
void blender::ED_view3d_win_to_vector (const ARegion *region, const float mval[2], float r_out[3])
bool blender::ED_view3d_win_to_segment_clipped (const Depsgraph *depsgraph, const ARegion *region, const View3D *v3d, const float mval[2], float r_ray_start[3], float r_ray_end[3], bool do_clip_planes)
bool blender::ED_view3d_area_user_region (const ScrArea *area, const View3D *v3d, ARegion **r_region)
void blender::ED_view3d_init_mats_rv3d (const Object *ob, RegionView3D *rv3d)
void blender::ED_view3d_init_mats_rv3d_gl (const Object *ob, RegionView3D *rv3d)
void blender::ED_view3d_clear_mats_rv3d (RegionView3D *rv3d)
void blender::ED_view3d_check_mats_rv3d (RegionView3D *rv3d)
void blender::ED_view3d_grid_steps (const Scene *scene, const View3D *v3d, const RegionView3D *rv3d, float r_grid_steps[8])
void blender::ED_view3d_stop_render_preview (wmWindowManager *wm, ARegion *region)
void blender::ED_view3d_shade_update (Main *bmain, View3D *v3d, ScrArea *area)
void blender::ED_view3d_buttons_region_layout_ex (const bContext *C, ARegion *region, const char *category_override)
std::array< const char *, 4 > blender::ED_view3d_buttons_contexts (const bContext *C)
View Data Access Utilities
void blender::ED_view3d_background_color_get (const Scene *scene, const View3D *v3d, float r_color[3])
void blender::ED_view3d_text_colors_get (const Scene *scene, const View3D *v3d, float r_text_color[4], float r_shadow_color[4])
bool blender::ED_view3d_has_workbench_in_texture_color (const Scene *scene, const Object *ob, const View3D *v3d)
Camera * blender::ED_view3d_camera_data_get (View3D *v3d, RegionView3D *rv3d)
Bounds< float > blender::ED_view3d_dist_soft_range_get (const View3D *v3d, bool use_persp_range)
float blender::ED_view3d_dist_soft_min_get (const View3D *v3d, bool use_persp_range)
bool blender::ED_view3d_clip_range_get (const Depsgraph *depsgraph, const View3D *v3d, const RegionView3D *rv3d, bool use_ortho_factor, float *r_clip_start, float *r_clip_end)
bool blender::ED_view3d_viewplane_get (const 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)
Set Cursor Operator
void blender::ED_view3d_cursor3d_position (bContext *C, const int mval[2], bool use_depth, float r_cursor_co[3])
void blender::ED_view3d_cursor3d_position_rotation (bContext *C, const int mval[2], bool use_depth, enum eV3DCursorOrient orientation, float r_cursor_co[3], float r_cursor_quat[4])
void blender::ED_view3d_cursor3d_update (bContext *C, const int mval[2], bool use_depth, enum eV3DCursorOrient orientation)
View Transform Utilities
void blender::ED_view3d_to_m4 (float mat[4][4], const float ofs[3], const float quat[4], float dist, float roll)
void blender::ED_view3d_from_m4 (const float mat[4][4], float ofs[3], float quat[4], const float *dist, float roll)
void blender::ED_view3d_from_object (const Object *ob, float ofs[3], float quat[4], const float *dist, float roll, float *r_lens)
void blender::ED_view3d_to_object (const Depsgraph *depsgraph, Object *ob, const float ofs[3], const float quat[4], float dist, float roll)
bool blender::ED_view3d_camera_to_view_selected (Main *bmain, Depsgraph *depsgraph, const Scene *scene, Object *camera_ob)
bool blender::ED_view3d_camera_to_view_selected_with_set_clipping (Main *bmain, Depsgraph *depsgraph, const Scene *scene, Object *camera_ob)
View Perspective & Mode Switching

Misc view utility functions.

void blender::ED_view3d_lastview_store (RegionView3D *rv3d)
bool blender::ED_view3d_offset_lock_check (const View3D *v3d, const RegionView3D *rv3d)
void blender::ED_view3d_persp_switch_from_camera (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d, eRegionView3D_Persp persp)
bool blender::ED_view3d_persp_ensure (const Depsgraph *depsgraph, View3D *v3d, ARegion *region)
void blender::ED_view3d_lock_clear (View3D *v3d)
Z-Depth Utilities
void blender::ED_view3d_depth_override (Depsgraph *depsgraph, ARegion *region, View3D *v3d, Object *obact, eV3DDepthOverrideMode mode, bool use_overlay, ViewDepths **r_depths)
void blender::ED_view3d_depths_free (ViewDepths *depths)
bool blender::ED_view3d_has_depth_buffer_updated (const Depsgraph *depsgraph, const View3D *v3d)
Depth Buffer Utilities
bool blender::ED_view3d_depth_read_cached (const ViewDepths *vd, const int mval[2], int margin, float *r_depth)
bool blender::ED_view3d_depth_read_cached_normal (const ARegion *region, const ViewDepths *depths, const int mval[2], float r_normal[3])
bool blender::ED_view3d_depth_unproject_v3 (const ARegion *region, const int mval[2], double depth, float r_location_world[3])
Navigation Utilities
ViewOpsData * blender::ED_view3d_navigation_init (bContext *C, const wmKeyMapItem *kmi_merge)
bool blender::ED_view3d_navigation_do (bContext *C, ViewOpsData *vod, const wmEvent *event, const float depth_loc_override[3])
void blender::ED_view3d_navigation_free (bContext *C, ViewOpsData *vod)
Snap Selection to Location (Utility)
bool blender::ED_view3d_snap_selected_to_location (bContext *C, wmOperator *op, const float target_loc_global[3], int pivot_point)
Drawings
void blender::ED_view3d_cursor_snap_draw_util (RegionView3D *rv3d, const float source_loc[3], const float target_loc[3], const eSnapMode source_type, const eSnapMode target_type, const uchar source_color[4], const uchar target_color[4])
Edit-Mesh: For Each Screen Vertex
Note
foreach functions should be called while drawing or directly after if not, ED_view3d_init_mats_rv3d() can be used for selection tools but would not give correct results with dupli's for eg. which don't use the object matrix in the usual way.
void blender::meshobject_foreachScreenVert (const ViewContext *vc, void(*func)(void *user_data, const float screen_co[2], int index), void *user_data, eV3DProjTest clip_flag)
void blender::mesh_foreachScreenVert (const ViewContext *vc, void(*func)(void *user_data, BMVert *eve, const float screen_co[2], int index), void *user_data, eV3DProjTest clip_flag)
Edit-Mesh: For Each Screen Mesh Edge
void blender::mesh_foreachScreenEdge (const ViewContext *vc, void(*func)(void *user_data, BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index), void *user_data, eV3DProjTest clip_flag)
Edit-Mesh: For Each Screen Edge (Bounding Box Clipped)
void blender::mesh_foreachScreenEdge_clip_bb_segment (const ViewContext *vc, void(*func)(void *user_data, BMEdge *eed, const float screen_co_a[2], const float screen_co_b[2], int index), void *user_data, eV3DProjTest clip_flag)
Edit-Mesh: For Each Screen Face Center
void blender::mesh_foreachScreenFace (const ViewContext *vc, void(*func)(void *user_data, BMFace *efa, const float screen_co[2], int index), void *user_data, eV3DProjTest clip_flag)
Edit-Nurbs: For Each Screen Vertex
void blender::nurbs_foreachScreenVert (const ViewContext *vc, void(*func)(void *user_data, Nurb *nu, BPoint *bp, BezTriple *bezt, int beztindex, bool handle_visible, const float screen_co[2]), void *user_data, eV3DProjTest clip_flag)
Edit-Meta: For Each Screen Meta-Element
void blender::mball_foreachScreenElem (const ViewContext *vc, void(*func)(void *user_data, MetaElem *ml, const float screen_co[2]), void *user_data, eV3DProjTest clip_flag)
Edit-Lattice: For Each Screen Vertex
void blender::lattice_foreachScreenVert (const ViewContext *vc, void(*func)(void *user_data, BPoint *bp, const float screen_co[2]), void *user_data, eV3DProjTest clip_flag)
Edit-Armature: For Each Screen Bone
void blender::armature_foreachScreenBone (const ViewContext *vc, void(*func)(void *user_data, EditBone *ebone, const float screen_co_a[2], const float screen_co_b[2]), void *user_data, eV3DProjTest clip_flag)
Pose: For Each Screen Bone
void blender::pose_foreachScreenBone (const ViewContext *vc, void(*func)(void *user_data, bPoseChannel *pchan, const float screen_co_a[2], const float screen_co_b[2]), void *user_data, eV3DProjTest clip_flag)
Utility functions for projection
float4x4 blender::ED_view3d_ob_project_mat_get (const RegionView3D *rv3d, const Object *ob)
float4x4 blender::ED_view3d_ob_project_mat_get_from_obmat (const RegionView3D *rv3d, const float4x4 &obmat)
void blender::ED_view3d_project_v3 (const ARegion *region, const float world[3], float r_region_co[3])
void blender::ED_view3d_project_v2 (const ARegion *region, const float world[3], float r_region_co[2])
bool blender::ED_view3d_unproject_v3 (const ARegion *region, float regionx, float regiony, float regionz, float world[3])
View State/Context Utilities
void blender::ED_view3d_polygon_offset (const RegionView3D *rv3d, float dist)
void blender::view3d_operator_needs_gpu (const bContext *C)
void blender::view3d_region_operator_needs_gpu (ARegion *region)
bool blender::ED_view3d_context_activate (bContext *C)
Calculate Render Border
bool blender::ED_view3d_calc_render_border (const Scene *scene, Depsgraph *depsgraph, View3D *v3d, ARegion *region, rcti *r_rect)
View Clipping Utilities
void blender::ED_view3d_clipping_calc_from_boundbox (float clip[4][4], const BoundBox *bb, bool is_flip)
void blender::ED_view3d_clipping_calc (BoundBox *bb, float planes[4][4], const ARegion *region, const Object *ob, const rcti *rect)
View Clipping Clamp Min/Max
bool blender::ED_view3d_clipping_clamp_minmax (const RegionView3D *rv3d, float min[3], float max[3])
View Clipping Planes Operator

Draw border or toggle off.

void blender::ED_view3d_clipping_local (RegionView3D *rv3d, const float mat[4][4])
Viewport Clipping
bool blender::ED_view3d_clipping_test (const RegionView3D *rv3d, const float co[3], bool is_local)
View Radius/Distance Utilities

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

float blender::ED_view3d_radius_to_dist_persp (float angle, float radius)
float blender::ED_view3d_radius_to_dist_ortho (float lens, float radius)
float blender::ED_view3d_radius_to_dist (const View3D *v3d, const ARegion *region, const Depsgraph *depsgraph, eRegionView3D_Persp persp, bool use_aspect, float radius)
Back-Draw for Selection
int blender::ED_view3d_backbuf_sample_size_clamp (ARegion *region, float dist)
void blender::ED_view3d_select_id_validate (const ViewContext *vc)
View Auto-Depth Last State Access

Calling consecutive trackpad gestures reuses the previous offset to prevent each trackpad event using a different offset, see: #103263.

bool blender::ED_view3d_autodist_last_check (wmWindow *win, const wmEvent *event)
bool blender::ED_view3d_autodist_last_get (wmWindow *win, float r_ofs[3])
void blender::ED_view3d_autodist_last_set (wmWindow *win, const wmEvent *event, const float ofs[3], const bool has_depth)
void blender::ED_view3d_autodist_last_clear (wmWindow *win)
View Auto-Depth Utilities
bool blender::ED_view3d_autodist (ARegion *region, View3D *v3d, const int mval[2], float mouse_worldloc[3], const float fallback_depth_pt[3])
bool blender::ED_view3d_autodist_simple (ARegion *region, const int mval[2], float mouse_worldloc[3], int margin, const float *force_depth)
bool blender::ED_view3d_depth_read_cached_seg (const ViewDepths *vd, const int mval_sta[2], const int mval_end[2], int margin, float *r_depth)
GPU Select Utilities
eV3DSelectObjectFilter blender::ED_view3d_select_filter_from_mode (const Scene *scene, const View3D *v3d, const Object *obact)
void blender::view3d_gpu_select_cache_begin ()
void blender::view3d_gpu_select_cache_end ()
int blender::view3d_gpu_select_ex (const ViewContext *vc, GPUSelectBuffer *buffer, const rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter, eV3DSelectShape select_shape, bool do_material_slot_selection)
int blender::view3d_gpu_select (const ViewContext *vc, GPUSelectBuffer *buffer, const rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter, eV3DSelectShape select_shape)
int blender::view3d_gpu_select_with_id_filter (const ViewContext *vc, GPUSelectBuffer *buffer, const rcti *input, eV3DSelectMode select_mode, eV3DSelectObjectFilter select_filter, uint select_id)
Public Utilities
float blender::ED_view3d_select_dist_px ()
ViewContext blender::ED_view3d_viewcontext_init (bContext *C, Depsgraph *depsgraph)
void blender::ED_view3d_viewcontext_init_object (ViewContext *vc, Object *obact)
Box Select
bool blender::edge_inside_circle (const float cent[2], float radius, const float screen_co_a[2], const float screen_co_b[2])
View3D Context Queries
RegionView3D * blender::ED_view3d_context_rv3d (bContext *C)
bool blender::ED_view3d_context_user_region (bContext *C, View3D **r_v3d, ARegion **r_region)
Object as Camera Operator
bool blender::ED_operator_rv3d_user_region_poll (bContext *C)
Region View Matrix Backup/Restore
RV3DMatrixStore * blender::ED_view3d_mats_rv3d_backup (RegionView3D *rv3d)
void blender::ED_view3d_mats_rv3d_restore (RegionView3D *rv3d, RV3DMatrixStore *rv3dmat)
void blender::ED_view3D_mats_rv3d_free (RV3DMatrixStore *rv3d_mat)
Draw Viewport Contents
RenderEngineType * blender::ED_view3d_engine_type (const Scene *scene, int drawtype)
General Functions
void blender::ED_view3d_draw_setup_view (const wmWindowManager *wm, wmWindow *win, Depsgraph *depsgraph, Scene *scene, ARegion *region, View3D *v3d, const float viewmat[4][4], const float winmat[4][4], const rcti *rect)
void blender::ED_view3d_update_viewmat (const Depsgraph *depsgraph, const Scene *scene, View3D *v3d, ARegion *region, const float viewmat[4][4], const float winmat[4][4], const rcti *rect, bool offscreen)
Cursor Picking
Base * blender::ED_view3d_give_base_under_cursor (bContext *C, const int mval[2])
Object * blender::ED_view3d_give_object_under_cursor (bContext *C, const int mval[2])
Object * blender::ED_view3d_give_material_slot_under_cursor (bContext *C, const int mval[2], int *r_material_slot)
bool blender::ED_view3d_is_object_under_cursor (bContext *C, const int mval[2])
Box View Support

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

void blender::ED_view3d_quadview_update (ScrArea *area, ARegion *region, bool do_clip)
View Axis Utilities
bool blender::ED_view3d_quat_from_axis_view (eRegionView3D_View view, eRegionView3D_ViewAxisRoll view_axis_roll, float r_quat[4])
bool blender::ED_view3d_quat_to_axis_view (const float quat[4], float epsilon, eRegionView3D_View *r_view, eRegionView3D_ViewAxisRoll *r_view_axis_roll)
bool blender::ED_view3d_quat_to_axis_view_and_reset_quat (float quat[4], float epsilon, eRegionView3D_View *r_view, eRegionView3D_ViewAxisRoll *r_view_axis_roll)
eRegionView3D_View blender::ED_view3d_lock_view_from_index (int index)
eRegionView3D_View blender::ED_view3d_axis_view_opposite (eRegionView3D_View view)
bool blender::ED_view3d_lock (RegionView3D *rv3d)
eRegionView3D_ViewFlipRoll blender::ED_view3d_effective_flip_axis (const RegionView3D *rv3d)
Custom-data Utilities
void blender::ED_view3d_datamask (const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d, CustomData_MeshMasks *r_cddata_masks)
void blender::ED_view3d_screen_datamask (const Main &bmain, const Scene *scene, ViewLayer *view_layer, const bScreen *screen, CustomData_MeshMasks *r_cddata_masks)
Camera View Utilities

Utilities for manipulating the camera-view.

bool blender::ED_view3d_camera_view_zoom_scale (RegionView3D *rv3d, const float scale)
bool blender::ED_view3d_camera_view_pan (ARegion *region, const float event_ofs[2])
Camera Lock API

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

bool blender::ED_view3d_camera_lock_check (const View3D *v3d, const RegionView3D *rv3d)
void blender::ED_view3d_camera_lock_init_ex (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d, bool calc_dist)
void blender::ED_view3d_camera_lock_init (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d)
bool blender::ED_view3d_camera_lock_sync (const Depsgraph *depsgraph, View3D *v3d, RegionView3D *rv3d)
bool blender::ED_view3d_camera_autokey (const Scene *scene, ID *id_key, bContext *C, bool do_rotate, bool do_translate)
bool blender::ED_view3d_camera_lock_autokey (View3D *v3d, RegionView3D *rv3d, bContext *C, bool do_rotate, bool do_translate)
bool blender::ED_view3d_camera_lock_undo_test (const View3D *v3d, const RegionView3D *rv3d, bContext *C)
bool blender::ED_view3d_camera_lock_undo_push (const char *str, const View3D *v3d, const RegionView3D *rv3d, bContext *C)
bool blender::ED_view3d_camera_lock_undo_grouped_push (const char *str, const View3D *v3d, const RegionView3D *rv3d, bContext *C)
View Distance Utilities
float blender::ED_view3d_offset_distance (const float mat[4][4], const float ofs[3], float fallback_dist)
void blender::ED_view3d_distance_set (RegionView3D *rv3d, float dist)
bool blender::ED_view3d_distance_set_from_location (RegionView3D *rv3d, const float dist_co[3], float dist_min)
Other Elements
float blender::ED_scene_grid_scale (const Scene *scene, const char **r_grid_unit)
float blender::ED_view3d_grid_scale (const Scene *scene, const View3D *v3d, const char **r_grid_unit)
float blender::ED_view3d_grid_view_scale (const Scene *scene, const View3D *v3d, const ARegion *region, const char **r_grid_unit)
FPS Drawing
void blender::ED_scene_draw_fps (const Scene *scene, int xoffset, int *yoffset)
Gizmo Accessors

This avoids each user of the gizmo needing to write their own lookups to access the information from this gizmo.

void blender::ED_view3d_gizmo_mesh_preselect_get_active (const bContext *C, const wmGizmo *gz, Base **r_base, BMElem **r_ele)
void blender::ED_view3d_gizmo_mesh_preselect_clear (wmGizmo *gz)
Ruler/Grease Pencil Conversion
void blender::ED_view3d_gizmo_ruler_remove_by_gpencil_layer (struct bContext *C, bGPDlayer *gpl)
Local View Operators
bool blender::ED_localview_exit_if_empty (const Depsgraph *depsgraph, Scene *scene, ViewLayer *view_layer, wmWindowManager *wm, wmWindow *win, View3D *v3d, ScrArea *area, bool frame_selected=true, int smooth_viewtx=0)
Local Collections
bool blender::ED_view3d_local_collections_set (const Main *bmain, View3D *v3d)
void blender::ED_view3d_local_collections_reset (const bContext *C, bool reset_all)

Macro Definition Documentation

◆ IS_CLIPPED

◆ OVERLAY_RETOPOLOGY_ENABLED

#define OVERLAY_RETOPOLOGY_ENABLED ( overlay)
Value:
(((overlay).edit_flag & V3D_OVERLAY_EDIT_RETOPOLOGY) != 0)

Definition at line 1399 of file ED_view3d.hh.

◆ OVERLAY_RETOPOLOGY_MIN_OFFSET

#define OVERLAY_RETOPOLOGY_MIN_OFFSET   FLT_EPSILON

Definition at line 1405 of file ED_view3d.hh.

◆ OVERLAY_RETOPOLOGY_OFFSET

#define OVERLAY_RETOPOLOGY_OFFSET ( overlay)
Value:
max_ff((overlay).retopology_offset, OVERLAY_RETOPOLOGY_MIN_OFFSET) : \
0.0f)
#define OVERLAY_RETOPOLOGY_ENABLED(overlay)
#define OVERLAY_RETOPOLOGY_MIN_OFFSET

Definition at line 1408 of file ED_view3d.hh.

◆ RETOPOLOGY_ENABLED

◆ RETOPOLOGY_OFFSET

#define RETOPOLOGY_OFFSET ( v3d)
Value:
#define OVERLAY_RETOPOLOGY_OFFSET(overlay)

Definition at line 1414 of file ED_view3d.hh.

Referenced by blender::draw::edit_select::Instance::begin_sync(), and blender::draw::overlay::Meshes::begin_sync().

◆ SHADING_XRAY_ACTIVE

#define SHADING_XRAY_ACTIVE ( shading)
Value:
(SHADING_XRAY_ENABLED(shading) && ((shading).type < OB_MATERIAL))
#define SHADING_XRAY_ENABLED(shading)

Definition at line 1383 of file ED_view3d.hh.

◆ SHADING_XRAY_ALPHA

#define SHADING_XRAY_ALPHA ( shading)
Value:
(((shading).type == OB_WIRE) ? (shading).xray_alpha_wire : (shading).xray_alpha)

Definition at line 1376 of file ED_view3d.hh.

Referenced by blender::workbench::SceneState::init().

◆ SHADING_XRAY_ENABLED

#define SHADING_XRAY_ENABLED ( shading)
Value:
(SHADING_XRAY_FLAG_ENABLED(shading) && (SHADING_XRAY_ALPHA(shading) < 1.0f))
#define SHADING_XRAY_ALPHA(shading)
#define SHADING_XRAY_FLAG_ENABLED(shading)

Definition at line 1381 of file ED_view3d.hh.

Referenced by blender::workbench::SceneState::init().

◆ SHADING_XRAY_FLAG

#define SHADING_XRAY_FLAG ( shading)
Value:
(((shading).type == OB_WIRE) ? V3D_SHADING_XRAY_WIREFRAME : V3D_SHADING_XRAY)

Definition at line 1378 of file ED_view3d.hh.

◆ SHADING_XRAY_FLAG_ENABLED

#define SHADING_XRAY_FLAG_ENABLED ( shading)
Value:
(((shading).flag & SHADING_XRAY_FLAG(shading)) != 0)
#define SHADING_XRAY_FLAG(shading)

Definition at line 1380 of file ED_view3d.hh.

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

◆ USE_SNAP_DETECT_FROM_KEYMAP_HACK

#define USE_SNAP_DETECT_FROM_KEYMAP_HACK

Definition at line 344 of file ED_view3d.hh.

◆ V3D_PROJ_TEST_ALL

#define V3D_PROJ_TEST_ALL
Value:
(V3D_PROJ_TEST_CLIP_DEFAULT | V3D_PROJ_TEST_CLIP_FAR | V3D_PROJ_TEST_CLIP_ZERO | \
V3D_PROJ_TEST_CLIP_CONTENT)
#define V3D_PROJ_TEST_CLIP_DEFAULT
Definition ED_view3d.hh:325

Definition at line 327 of file ED_view3d.hh.

Referenced by blender::ed_view3d_project__internal().

◆ V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT

#define V3D_PROJ_TEST_CLIP_CONTENT_DEFAULT
Value:
(V3D_PROJ_TEST_CLIP_CONTENT | V3D_PROJ_TEST_CLIP_NEAR | V3D_PROJ_TEST_CLIP_FAR | \
V3D_PROJ_TEST_CLIP_WIN)

Definition at line 331 of file ED_view3d.hh.

Referenced by blender::armature_circle_select(), blender::do_lasso_select_armature(), blender::do_lasso_select_mesh(), blender::do_lasso_tag_pose(), blender::do_mesh_box_select(), blender::EDBM_edge_find_nearest_ex(), and blender::mesh_circle_select().

◆ V3D_PROJ_TEST_CLIP_DEFAULT

◆ VIEW3D_DIST_FALLBACK

#define VIEW3D_DIST_FALLBACK   1.0f

◆ VIEW3D_MARGIN

#define VIEW3D_MARGIN   1.4f

Definition at line 1313 of file ED_view3d.hh.

Referenced by blender::view3d_from_minmax(), and blender::view3d_localview_init().

◆ XRAY_ACTIVE

◆ XRAY_ALPHA

#define XRAY_ALPHA ( v3d)
Value:
SHADING_XRAY_ALPHA((v3d)->shading)

Definition at line 1386 of file ED_view3d.hh.

Referenced by blender::draw::gpencil::Instance::init(), and blender::draw::overlay::Instance::init().

◆ XRAY_ENABLED

◆ XRAY_FLAG

#define XRAY_FLAG ( v3d)
Value:
SHADING_XRAY_FLAG((v3d)->shading)

Definition at line 1387 of file ED_view3d.hh.

◆ XRAY_FLAG_ENABLED