griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Overlay-Next: Document each overlay class

Browse Source
This commit is contained in:
Clément Foucault
2024-11-24 01:02:48 +01:00
parent 6e6711772f
commit 37bb1dedf5
33 changed files with 146 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/blender/draw/engines/overlay/overlay_next_armature.hh
View File

@@ -22,6 +22,10 @@ enum eArmatureDrawMode {
ARM_DRAW_MODE_EDIT,
};
/**
* Displays armature objects.
* This includes Object, Edit and Pose mode.
*/
class Armatures : Overlay {
using EmptyInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;
using BoneInstanceBuf = ShapeInstanceBuf<BoneInstanceData>;

4
source/blender/draw/engines/overlay/overlay_next_attribute_text.hh
View File

@@ -28,6 +28,10 @@
namespace blender::draw::overlay {
/**
* Displays geometry node viewer output.
* Values are displayed as text on top of the active object.
*/
class AttributeTexts : Overlay {
public:
void begin_sync(Resources &res, const State &state) final

5
source/blender/draw/engines/overlay/overlay_next_attribute_viewer.hh
View File

@@ -18,6 +18,11 @@
#include "overlay_next_base.hh"
namespace blender::draw::overlay {
/**
* Displays geometry node viewer output.
* Values are displayed as vertex or face colors on top of the active object.
*/
class AttributeViewer : Overlay {
private:
PassMain ps_ = {"attribute_viewer_ps_"};

4
source/blender/draw/engines/overlay/overlay_next_axes.hh
View File

@@ -14,6 +14,10 @@
namespace blender::draw::overlay {
/**
* Displays extra object axes.
* It is toggled by Object Panel > Viewport Display > Axes.
*/
class Axes : Overlay {
using EmptyInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

4
source/blender/draw/engines/overlay/overlay_next_background.hh
View File

@@ -12,6 +12,10 @@
namespace blender::draw::overlay {
/**
* Draw background color .
* It is toggled by Object Panel > Viewport Display > Axes.
*/
class Background : Overlay {
private:
PassSimple bg_ps_ = {"Background"};

12
source/blender/draw/engines/overlay/overlay_next_bounds.hh
View File

@@ -18,6 +18,18 @@
#include "overlay_next_base.hh"
namespace blender::draw::overlay {
/**
* Draw object bounds and texture space.
*
* The object bound can be drawn because of:
* - display option (Object > Viewport Display > Bounds)
* - display as (Object > Viewport Display > Bounds)
* - rigid body (Physics > Rigid Body > Collision > Shape)
*
* Texture space can be modified by (Data > Texture Space)
* and displayed by (Object > Viewport Display > Texture Space)
*/
class Bounds : Overlay {
using BoundsInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

6
source/blender/draw/engines/overlay/overlay_next_camera.hh
View File

@@ -46,6 +46,12 @@ struct CameraInstanceData : public ExtraInstanceData {
: ExtraInstanceData(p_matrix, color, 1.0f){};
};
/**
* Camera object display (including stereoscopy).
* Also camera reconstruction bundles.
* Also camera reference images (background).
*/
/* TODO(fclem): Split into multiple overlay classes. */
class Cameras : Overlay {
using CameraInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

3
source/blender/draw/engines/overlay/overlay_next_curve.hh
View File

@@ -21,6 +21,9 @@
namespace blender::draw::overlay {
/**
* Curve object display (including legacy curves) for both object and edit modes.
*/
class Curves : Overlay {
private:
PassSimple edit_curves_ps_ = {"Curve Edit"};

4
source/blender/draw/engines/overlay/overlay_next_edit_text.hh
View File

@@ -15,6 +15,10 @@
namespace blender::draw::overlay {
/**
* Text objects related overlays.
* Currently only display cursor and selection of text edit mode.
*/
class EditText : Overlay {
private:

3
source/blender/draw/engines/overlay/overlay_next_empty.hh
View File

@@ -13,6 +13,9 @@
namespace blender::draw::overlay {
/**
* Empty object type drawing, including image empties.
*/
class Empties : Overlay {
friend class Cameras;
using EmptyInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

4
source/blender/draw/engines/overlay/overlay_next_facing.hh
View File

@@ -14,6 +14,10 @@
namespace blender::draw::overlay {
/**
* Draw a specific color for front and back-faces on surfaces.
* Can be toggle in (Viewport Overlays > Geometry > Face Orientation)
*/
class Facing : Overlay {
private:

5
source/blender/draw/engines/overlay/overlay_next_fade.hh
View File

@@ -15,6 +15,11 @@
#include "overlay_next_base.hh"
namespace blender::draw::overlay {
/**
* Fades surfaces not currently in the active edit mode.
* Can be toggle in (Viewport Overlays > Geometry > Fade Inactive Geometry)
*/
class Fade : Overlay {
private:
PassMain ps_ = {"FadeGeometry"};

3
source/blender/draw/engines/overlay/overlay_next_fluid.hh
View File

@@ -17,6 +17,9 @@
namespace blender::draw::overlay {
/**
* Draw fluid simulation overlays (water, smoke).
*/
class Fluids : Overlay {
private:
const SelectionType selection_type_;

4
source/blender/draw/engines/overlay/overlay_next_force_field.hh
View File

@@ -18,6 +18,10 @@
namespace blender::draw::overlay {
/**
* Draw force fields.
* Controlled by (Physics > Force Field)
*/
class ForceFields : Overlay {
using ForceFieldsInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

4
source/blender/draw/engines/overlay/overlay_next_grease_pencil.hh
View File

@@ -23,6 +23,10 @@
namespace blender::draw::overlay {
/**
* Draw grease pencil overlays.
* Also contains grease pencil helper functions for other overlays.
*/
class GreasePencil : Overlay {
private:
PassSimple edit_grease_pencil_ps_ = {"GPencil Edit"};

3
source/blender/draw/engines/overlay/overlay_next_grid.hh
View File

@@ -23,6 +23,9 @@
namespace blender::draw::overlay {
/**
* Draw 2D or 3D grid as well at global X, Y and Z axes.
*/
class Grid : Overlay {
private:
UniformBuffer<OVERLAY_GridData> data_;

3
source/blender/draw/engines/overlay/overlay_next_lattice.hh
View File

@@ -16,6 +16,9 @@
namespace blender::draw::overlay {
/**
* Draw lattice objects in object and edit mode.
*/
class Lattices : Overlay {
private:
PassMain ps_ = {"Lattice"};

3
source/blender/draw/engines/overlay/overlay_next_lightprobe.hh
View File

@@ -14,6 +14,9 @@
namespace blender::draw::overlay {
/**
* Draw light probe objects.
*/
class LightProbes : Overlay {
using LightProbeInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;
using GroundLineInstanceBuf = ShapeInstanceBuf<float4>;

6
source/blender/draw/engines/overlay/overlay_next_mesh.hh
View File

@@ -34,6 +34,9 @@ constexpr int overlay_edit_text = V3D_OVERLAY_EDIT_EDGE_LEN | V3D_OVERLAY_EDIT_F
V3D_OVERLAY_EDIT_FACE_ANG | V3D_OVERLAY_EDIT_EDGE_ANG |
V3D_OVERLAY_EDIT_INDICES;
/**
* Draw edit mesh overlays.
*/
class Meshes : Overlay {
private:
PassSimple edit_mesh_normals_ps_ = {"Normals"};
@@ -447,6 +450,9 @@ class Meshes : Overlay {
}
};
/**
* Draw edit uv overlays.
*/
class MeshUVs : Overlay {
private:
PassSimple analysis_ps_ = {"Mesh Analysis"};

3
source/blender/draw/engines/overlay/overlay_next_metaball.hh
View File

@@ -15,6 +15,9 @@
namespace blender::draw::overlay {
/**
* Draw meta-balls radius overlays.
*/
class Metaballs : Overlay {
using SphereOutlineInstanceBuf = ShapeInstanceBuf<BoneInstanceData>;

4
source/blender/draw/engines/overlay/overlay_next_mode_transfer.hh
View File

@@ -14,6 +14,10 @@
namespace blender::draw::overlay {
/**
* Make newly active mesh flash for a brief period of time.
* This can be triggered using the "Transfer Mode" operator when in any edit mode.
*/
class ModeTransfer : Overlay {
private:
PassSimple ps_ = {"ModeTransfer"};

4
source/blender/draw/engines/overlay/overlay_next_motion_path.hh
View File

@@ -19,6 +19,10 @@
namespace blender::draw::overlay {
/**
* Display object and armature motion path.
* Motion paths can be found in (Object > Motion Paths) or (Data > Motion Paths) for armatures.
*/
class MotionPath : Overlay {
private:

4
source/blender/draw/engines/overlay/overlay_next_name.hh
View File

@@ -14,6 +14,10 @@
namespace blender::draw::overlay {
/**
* Display object names next to their origin.
* The option can be found under (Object > Viewport Display > Show > Name).
*/
class Names : Overlay {
public:
void begin_sync(Resources &res, const State &state) final

5
source/blender/draw/engines/overlay/overlay_next_origin.hh
View File

@@ -11,6 +11,11 @@
#include "overlay_next_base.hh"
namespace blender::draw::overlay {
/**
* Display object origins as dots.
* The option can be found under (Viewport Overlays > Objects > Origins).
*/
class Origins : Overlay {
private:
StorageVectorBuffer<VertexData> point_buf_;

4
source/blender/draw/engines/overlay/overlay_next_outline.hh
View File

@@ -15,6 +15,10 @@
namespace blender::draw::overlay {
/**
* Display selected object outline.
* The option can be found under (Viewport Overlays > Objects > Outline Selected).
*/
class Outline : Overlay {
private:
/* Simple render pass that renders an object ID pass. */

4
source/blender/draw/engines/overlay/overlay_next_paint.hh
View File

@@ -19,6 +19,10 @@
namespace blender::draw::overlay {
/**
* Display paint modes overlays.
* Covers weight paint, vertex paint and texture paint.
*/
class Paints : Overlay {
private:

4
source/blender/draw/engines/overlay/overlay_next_particle.hh
View File

@@ -18,6 +18,10 @@
namespace blender::draw::overlay {
/**
* Display particle system overlays.
* Covers particle edit and the legacy hair system.
*/
class Particles : Overlay {
private:
PassMain particle_ps_ = {"particle_ps_"};

7
source/blender/draw/engines/overlay/overlay_next_prepass.hh
View File

@@ -4,9 +4,6 @@
/** \file
* \ingroup overlay
*
* A depth pass that write surface depth when it is needed.
* It is also used for selecting non overlay-only objects.
*/
#pragma once
@@ -23,6 +20,10 @@
namespace blender::draw::overlay {
/**
* A depth pass that write surface depth when it is needed.
* It is also used for selecting non overlay-only objects.
*/
class Prepass : Overlay {
private:
PassMain ps_ = {"prepass"};

4
source/blender/draw/engines/overlay/overlay_next_relation.hh
View File

@@ -19,6 +19,10 @@
namespace blender::draw::overlay {
/**
* Display object relations as dashed lines.
* Covers parenting relationships and constraints.
*/
class Relations : Overlay {
private:

5
source/blender/draw/engines/overlay/overlay_next_sculpt.hh
View File

@@ -24,6 +24,11 @@
namespace blender::draw::overlay {
/**
* Display sculpt modes overlays.
* Covers face sets and mask for meshes.
* Draw curve cages (curve guides) for curve sculpting.
*/
class Sculpts : Overlay {
private:

3
source/blender/draw/engines/overlay/overlay_next_speaker.hh
View File

@@ -14,6 +14,9 @@
namespace blender::draw::overlay {
/**
* Display speaker objects.
*/
class Speakers : Overlay {
using SpeakerInstanceBuf = ShapeInstanceBuf<ExtraInstanceData>;

9
source/blender/draw/engines/overlay/overlay_next_wireframe.hh
View File

@@ -18,6 +18,15 @@
namespace blender::draw::overlay {
/**
* Draw wireframe of objects.
*
* The object wireframe can be drawn because of:
* - display option (Object > Viewport Display > Wireframe)
* - overlay option (Viewport Overlays > Geometry > Wireframe)
* - display as (Object > Viewport Display > Wire)
* - wireframe shading mode
*/
class Wireframe : Overlay {
private:
PassMain wireframe_ps_ = {"Wireframe"};

11
source/blender/draw/engines/overlay/overlay_next_xray_fade.hh
View File

@@ -4,12 +4,6 @@
/** \file
* \ingroup draw_engine
*
* Overlay X-ray Fade:
*
* Full-screen pass that dim overlays that are behind scene geometry.
* This allows to have a nice transition between opaque (or 100% X-ray) and wire-frame only mode.
* This is only available if X-ray mode is enabled or in wire-frame mode.
*/
#pragma once
@@ -18,6 +12,11 @@
namespace blender::draw::overlay {
/**
* Fade overlays that are behind scene geometry.
* This allows to have a nice transition between opaque (or 100% X-ray) and wire-frame only mode.
* This is only available if X-ray mode is enabled or in wire-frame mode.
*/
class XrayFade : Overlay {
private:
PassSimple xray_fade_ps_ = {"XrayFade"};