Blender V5.3
DNA_view3d_types.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_enum_flags.hh"
14
15#include "DNA_defs.h"
16#include "DNA_listBase.h"
17#include "DNA_object_types.h"
18#include "DNA_scene_enums.h"
19#include "DNA_space_enums.h"
20#include "DNA_view3d_enums.h"
22
23namespace blender {
24
25struct BoundBox;
26struct Object;
27struct ViewRender;
29struct SpaceLink;
30struct bGPdata;
31struct wmTimer;
32
34enum eHandleDisplay : int {
35 /* Display only selected points. */
37 /* Display all handles. */
39 /* No display handles. */
41};
42
50
51
52enum eView3D_Flag : short {
54 V3D_FLAG_UNUSED_1 = 1 << 1, /* cleared */
56 V3D_FLAG_UNUSED_2 = 1 << 3, /* cleared */
59
60 V3D_FLAG_UNUSED_10 = 1 << 10, /* cleared */
62 V3D_FLAG_UNUSED_12 = 1 << 12, /* cleared */
64 V3D_DRAW_CENTERS = short(1u << 15),
65};
67
68
80
81
87
107
108
125
126
127#define RV3D_LOCK_FLAGS(rv3d) ((rv3d)->viewlock | ((rv3d)->runtime_viewlock))
128
134
135
146
147#define RV3D_VIEW_IS_AXIS(view) (((view) >= RV3D_VIEW_FRONT) && ((view) <= RV3D_VIEW_BOTTOM))
148
160
180
181#define RV3D_CLIPPING_ENABLED(v3d, rv3d) \
182 ((rv3d) && (v3d) && ((rv3d)->rflag & RV3D_CLIPPING) && \
183 ELEM((v3d)->shading.type, OB_WIRE, OB_SOLID) && (rv3d)->clipbb)
184
186enum eView3D_Flag2 : int {
191 V3D_FLAG2_UNUSED_6 = 1 << 6, /* cleared */
195 V3D_FLAG2_UNUSED_10 = 1 << 10, /* cleared */
197 V3D_FLAG2_UNUSED_12 = 1 << 12, /* cleared */
198 V3D_FLAG2_UNUSED_13 = 1 << 13, /* cleared */
199 V3D_FLAG2_UNUSED_14 = 1 << 14, /* cleared */
200 V3D_FLAG2_UNUSED_15 = 1 << 15, /* cleared */
206};
208
209
235
236
255
256
257enum eView3D_DebugFlag : short {
259};
261
262#define V3D_USES_SCENE_LIGHTS(v3d) \
263 ((((v3d)->shading.type == OB_MATERIAL) && ((v3d)->shading.flag & V3D_SHADING_SCENE_LIGHTS)) || \
264 (((v3d)->shading.type == OB_RENDER) && \
265 ((v3d)->shading.flag & V3D_SHADING_SCENE_LIGHTS_RENDER)))
266
267#define V3D_USES_SCENE_WORLD(v3d) \
268 ((((v3d)->shading.type == OB_MATERIAL) && ((v3d)->shading.flag & V3D_SHADING_SCENE_WORLD)) || \
269 (((v3d)->shading.type == OB_RENDER) && \
270 ((v3d)->shading.flag & V3D_SHADING_SCENE_WORLD_RENDER)))
271
278
287
312
313
349
350
355
356
361
362
363enum eView3D_Around : int {
364 /* center of the bounding box */
366 /* center from the sum of all points divided by the total */
368 /* pivot around the 2D/3D cursor */
370 /* pivot around each items own origin */
372 /* pivot around the active items origin */
374};
375
377enum eView3D_GridFlag : char {
379 V3D_SHOW_X = 1 << 1,
380 V3D_SHOW_Y = 1 << 2,
381 V3D_SHOW_Z = 1 << 3,
383};
385
386
399
410
411
418
419
427
428
434
435
442
443
450
451
457
462
465
466
467 float winmat[4][4] = {};
469 float viewmat[4][4] = {};
471 float viewinv[4][4] = {};
473 float persmat[4][4] = {};
475 float persinv[4][4] = {};
477 float viewcamtexcofac[4] = {};
478
480 float viewmatob[4][4] = {};
481 float persmatob[4][4] = {};
482
484 float clip[6][4] = {};
489 float clip_local[6][4] = {};
490 struct BoundBox *clipbb = nullptr;
491
493 struct RegionView3D *localvd = nullptr;
494 struct ViewRender *view_render = nullptr;
495
497 struct SmoothView3DStore *sms = nullptr;
498 struct wmTimer *smooth_timer = nullptr;
499
501 float twmat[4][4] = {};
503 float tw_axis_min[3] = {}, tw_axis_max[3] = {};
504 float tw_axis_matrix[3][3] = {};
505
507
509 float viewquat[4] = {};
517 float dist = 0;
519 float camdx = 0, camdy = 0;
521 float pixsize = 0;
526 float ofs[3] = {};
528 float camzoom = 0;
530 float camroll = 0.0f;
531 char _pad9[4] = {};
536 char is_persp = 0;
540 eRegionView3D_ViewLock viewlock = {}; /* Should usually be accessed with RV3D_LOCK_FLAGS()! */
543 {}; /* Should usually be accessed with RV3D_LOCK_FLAGS()! */
544
546 char _pad[1] = {};
548 float ofs_lock[2] = {};
549
551 short twdrawflag = 0;
553
555 float lviewquat[4] = {};
560 char _pad8[4] = {};
561
568 float ndof_ofs[3] = {};
569
571 float ndof_rot_angle = 0;
572 float ndof_rot_axis[3] = {};
573};
574
576 float location[3] = {};
577
578 float rotation_quaternion[4] = {1, 0, 0, 0};
579 float rotation_euler[3] = {};
580 float rotation_axis[3] = {0, 1, 0}, rotation_angle = 0;
582
583 char _pad[6] = {};
584
585#ifdef __cplusplus
586 template<typename T> T matrix() const;
587 math::Quaternion rotation() const;
588
589 void set_rotation(const math::Quaternion &quat, bool use_compat);
590 void set_matrix(const float3x3 &mat, bool use_compat);
591 void set_matrix(const float4x4 &mat, bool use_compat);
592#endif
593};
594
601
605
610
613
614 char _pad = {};
615
616 char studio_light[/*FILE_MAXFILE*/ 256] = "";
617 char lookdev_light[/*FILE_MAXFILE*/ 256] = "";
618 char matcap[/*FILE_MAXFILE*/ 256] = "";
619
620 float shadow_intensity = 0.5f;
621 float single_color[3] = {0.8f, 0.8f, 0.8f};
622
627
628 float object_outline_color[3] = {};
629 float xray_alpha = 0.5f;
630 float xray_alpha_wire = 0.5f;
631
634
635 float background_color[3] = {0.05f, 0.05f, 0.05f};
636
639
640 /* Render pass displayed in the viewport. Is an `eScenePassType` where one bit is set */
642 char aov_name[64] = "";
643
644 struct IDProperty *prop = nullptr;
645 void *_pad2 = nullptr;
646};
647
652
658 float normals_length = 0.1f;
660
663
666
674
676 float xray_alpha_bone = 0.5f;
677 float bone_wire_alpha = 1.0f;
678
680 float fade_alpha = 0.40f;
681
684 float wireframe_opacity = 1.0f;
685 float retopology_offset = 0.01f;
686
691
692 /* Grease Pencil canvas settings. */
693 float gpencil_grid_color[3] = {0.5f, 0.5f, 0.5f};
694 float gpencil_grid_scale[2] = {1.0f, 1.0f};
695 float gpencil_grid_offset[2] = {0.0f, 0.0f};
697
702
705};
706
709 void *properties_storage = nullptr;
712 int flag = 0;
713
718 float ofs_last_center[3] = {};
719
720 /* Only used for overlay stats while in local-view. */
721 struct SceneStats *local_stats = nullptr;
722
723 /* Times recorded for performance overlay. */
724 float last_sync_time = 0;
726};
727
729struct View3D {
731
732 struct SpaceLink *next = nullptr, *prev = nullptr;
734 ListBaseT<ARegion> regionbase = {nullptr, nullptr};
736 char link_flag = 0;
737 char _pad0[6] = {};
738 /* End 'SpaceLink' header. */
739
742
744 float bundle_size = 0.2f;
747
749
750 char _pad3[1] = {};
751
754
757
760 char _pad8[2] = {};
761
762 struct Object *camera = nullptr, *ob_center = nullptr;
764
766 struct View3D *localvd = nullptr;
767
769 char ob_center_bone[/*MAXBONENAME*/ 64] = "";
770
771 unsigned short local_view_uid = 0;
772 char _pad6[2] = {};
774 unsigned short local_collections_uid = 0;
775 short _pad7[2] = {};
776
777 short debug_flag = 0;
778
781 short scenelock = true;
786
787 float lens = 50.0f, grid = 1.0f;
788 float clip_start = 0.01f, clip_end = 1000.0f;
790 DNA_DEPRECATED float ofs[2] = {};
791
792 char _pad[1] = {};
793
797
803
805
806 short gridlines = 16;
808 short gridsubdiv = 10;
809
811 float vertex_opacity = 1.0f;
812
813 /* XXX deprecated? */
815 DNA_DEPRECATED struct bGPdata *gpd = nullptr;
816
820 char _pad4 = {};
824
828
831
834};
835
836#define RV3D_CAMZOOM_MIN -30
837#define RV3D_CAMZOOM_MAX 600
838
840#define RV3D_CAMZOOM_MIN_FACTOR 0.1657359312880714853f
841#define RV3D_CAMZOOM_MAX_FACTOR 44.9852813742385702928f
842
843} // namespace blender
#define ENUM_OPERATORS(_enum_type)
#define DNA_DEFINE_CXX_METHODS(class_name)
Definition DNA_defs.h:104
#define DNA_DEPRECATED
Definition DNA_defs.h:21
These structs are the foundation for all linked lists in the library system.
Object is a sort of wrapper for general info.
#define T
QuaternionBase< float > Quaternion
BMesh Iterators.
@ V3D_OVERLAY_HIDE_OBJECT_ORIGINS
@ V3D_OVERLAY_SCULPT_SHOW_MASK
@ V3D_OVERLAY_FADE_INACTIVE
@ V3D_OVERLAY_VIEWER_ATTRIBUTE
@ V3D_OVERLAY_ONION_SKINS
@ V3D_OVERLAY_HIDE_MOTION_PATHS
@ V3D_OVERLAY_SCULPT_SHOW_FACE_SETS
@ V3D_OVERLAY_SCULPT_CURVES_CAGE
@ V3D_OVERLAY_VIEWER_ATTRIBUTE_TEXT
@ V3D_OVERLAY_PERFORMANCE
@ V3D_OVERLAY_HIDE_OBJECT_XTRAS
@ V3D_OVERLAY_SHOW_LIGHT_COLORS
@ V3D_OVERLAY_FACE_ORIENTATION
@ V3D_OVERLAY_BONE_SELECT
@ V3D_OVERLAY_HIDE_CURSOR
@ V3D_RUNTIME_LOCAL_MAYBE_EMPTY
@ V3D_RUNTIME_DEPTHBUF_OVERRIDDEN
@ V3D_RUNTIME_XR_SESSION_ROOT
@ V3D_RUNTIME_OFS_LAST_CENTER_IS_VALID
@ CURVE_HANDLE_SELECTED
@ V3D_SHADING_USE_COMPOSITOR_CAMERA
@ V3D_SHADING_USE_COMPOSITOR_ALWAYS
@ V3D_SHADING_USE_COMPOSITOR_DISABLED
@ V3D_ORIENT_CUSTOM_MATRIX
@ V3D_GIZMO_SHOW_OBJECT_TRANSLATE
@ V3D_GIZMO_SHOW_OBJECT_SCALE
@ V3D_GIZMO_SHOW_OBJECT_ROTATE
@ V3D_AROUND_CENTER_BOUNDS
@ V3D_AROUND_LOCAL_ORIGINS
@ V3D_AROUND_CENTER_MEDIAN
@ V3D_XR_SESSION_SURFACE
@ V3D_LOCAL_COLLECTIONS
@ V3D_XR_SESSION_MIRROR
MatBase< float, 4, 4 > float4x4
@ RV3D_LOCK_ZOOM_AND_DOLLY
@ RV3D_LOCK_ANY_TRANSFORM
@ V3D_SHADING_WORLD_ORIENTATION
@ V3D_SHADING_SCENE_WORLD
@ V3D_SHADING_BACKFACE_CULLING
@ V3D_SHADING_STUDIOLIGHT_VIEW_ROTATION
@ V3D_SHADING_XRAY_WIREFRAME
@ V3D_SHADING_SCENE_LIGHTS
@ V3D_SHADING_MATCAP_FLIP_X
@ V3D_SHADING_SCENE_LIGHTS_RENDER
@ V3D_SHADING_OBJECT_OUTLINE
@ V3D_SHADING_SPECULAR_HIGHLIGHT
@ V3D_SHADING_DEPTH_OF_FIELD
@ V3D_SHADING_SCENE_WORLD_RENDER
@ V3D_XR_SHOW_CONTROLLERS
@ V3D_XR_SHOW_CUSTOM_OVERLAYS
@ V3D_SHOW_RECONSTRUCTION
@ V3D_SHOW_CAMERA_PASSEPARTOUT
@ V3D_XR_SHOW_PASSTHROUGH
@ RV3D_ZOFFSET_DISABLED
@ RV3D_VIEW_AXIS_ROLL_270
@ RV3D_VIEW_AXIS_ROLL_180
@ V3D_SHADING_CAVITY_SSAO
@ V3D_SHADING_CAVITY_CURVATURE
@ V3D_SHADING_CAVITY_BOTH
@ V3D_GIZMO_SHOW_CAMERA_DOF_DIST
@ V3D_GIZMO_SHOW_CAMERA_LENS
@ V3D_GP_ONION_SKIN_ACTIVE_OBJECT
@ V3D_GP_SHOW_MATERIAL_NAME
@ V3D_GP_SHOW_STROKE_DIRECTION
@ V3D_GP_FADE_NOACTIVE_LAYERS
@ V3D_GP_FORCE_STROKE_ORDER_3D
@ V3D_GP_SHOW_MULTIEDIT_LINES
@ V3D_GP_FADE_NOACTIVE_GPENCIL
@ V3D_GIZMO_SHOW_LIGHT_LOOK_AT
@ V3D_GIZMO_SHOW_LIGHT_SIZE
@ V3D_OVERLAY_WPAINT_CONTOURS
@ V3D_GIZMO_SHOW_ARMATURE_BBONE
@ V3D_GIZMO_SHOW_ARMATURE_ROLL
@ V3D_GIZMO_SHOW_EMPTY_FORCE_FIELD
@ V3D_GIZMO_SHOW_EMPTY_IMAGE
@ V3D_SHADING_SINGLE_COLOR
@ V3D_SHADING_MATERIAL_COLOR
MatBase< float, 3, 3 > float3x3
@ V3D_PLACE_DEPTH_SURFACE
@ V3D_PLACE_DEPTH_CURSOR_VIEW
@ V3D_PLACE_DEPTH_CURSOR_PLANE
@ V3D_SHADING_BACKGROUND_THEME
@ V3D_DEBUG_FREEZE_CULLING
@ V3D_OVERLAY_EDIT_LOOP_NORMALS
@ V3D_OVERLAY_EDIT_WEIGHT
@ V3D_OVERLAY_EDIT_CONSTANT_SCREEN_SIZE_NORMALS
@ V3D_OVERLAY_EDIT_BWEIGHTS
@ V3D_OVERLAY_EDIT_FACE_AREA
@ V3D_OVERLAY_EDIT_STATVIS
@ V3D_OVERLAY_EDIT_CREASES
@ V3D_OVERLAY_EDIT_EDGE_ANG
@ V3D_OVERLAY_EDIT_EDGE_LEN
@ V3D_OVERLAY_EDIT_VERT_NORMALS
@ V3D_OVERLAY_EDIT_FACE_NORMALS
@ V3D_OVERLAY_EDIT_FREESTYLE_EDGE
@ V3D_OVERLAY_EDIT_FACE_ANG
@ V3D_OVERLAY_EDIT_CU_NORMALS
@ V3D_OVERLAY_EDIT_RETOPOLOGY
@ V3D_OVERLAY_EDIT_FREESTYLE_FACE
@ V3D_OVERLAY_EDIT_FACE_DOT
@ V3D_OVERLAY_EDIT_EDGES_DEPRECATED
@ V3D_OVERLAY_EDIT_INDICES
@ V3D_PLACE_ORIENT_DEFAULT
@ V3D_PLACE_ORIENT_SURFACE
@ V3D_GIZMO_HIDE_MODIFIER
@ V3D_GIZMO_HIDE_NAVIGATE
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
eRegionView3D_ViewLockQuad viewlock_quad
eRegionView3D_View lview
struct RegionView3D * localvd
eRegionView3D_Flag rflag
eRegionView3D_ViewAxisRoll view_axis_roll
eRegionView3D_ViewLock runtime_viewlock
DNA_DEPRECATED float gridview
struct ViewRender * view_render
eRegionView3D_ViewAxisRoll lview_axis_roll
struct BoundBox * clipbb
eRegionView3D_Persp lpersp
struct wmTimer * smooth_timer
eRegionView3D_Persp persp
struct SmoothView3DStore * sms
eRegionView3D_NDOFFlag ndof_flag
eRegionView3D_ViewLock viewlock
eRegionView3D_View view
eView3DOverlay_WPaintFlag wpaint_flag
eView3DOverlay_Flag flag
eView3DOverlay_PaintFlag paint_flag
eHandleDisplay handle_display
eView3DOverlay_EditFlag edit_flag
eV3DShadingColorType color_type
eView3DShading_Flag flag
struct IDProperty * prop
View3DShadingUseCompositor use_compositor
eV3DShadingColorType wire_color_type
eV3DShadingBackgroundType background_type
eV3DShadingLightingMode light
eView3DShading_CavityType cavity_type
struct SceneStats * local_stats
void(*) properties_storage_free(void *properties_storage)
eView3D_GridFlag gridflag
eView3D_GizmoShowObject gizmo_show_object
DNA_DEPRECATED eRegionView3D_Persp persp
eView3D_Flag2 flag2
eView3D_GizmoShowArmature gizmo_show_armature
eView3D_GizmoShowCamera gizmo_show_camera
eView3D_GPFlag gp_flag
struct Object * ob_center
eView3D_GizmoShowLight gizmo_show_light
eView3D_GizmoShowEmpty gizmo_show_empty
struct SpaceLink * prev
struct Object * camera
View3DShading shading
ListBaseT< ARegion > regionbase
DNA_DEPRECATED float ofs[2]
DNA_DEPRECATED float dist
unsigned short local_collections_uid
struct SpaceLink * next
struct View3D * localvd
eView3D_StereoFlag stereo3d_flag
unsigned short local_view_uid
DNA_DEPRECATED eRegionView3D_View view
View3D_Runtime runtime
DNA_DEPRECATED float viewquat[4]
float stereo3d_convergence_factor
eView3D_GizmoFlag gizmo_flag
DNA_DEPRECATED struct bGPdata * gpd
DNA_DEPRECATED int layact
DNA_DEPRECATED char drawtype