blender::draw::overlay Namespace Reference

Classes
class	AntiAliasing
class	Armatures
class	AttributeTexts
class	AttributeViewer
class	Axes
class	Background
struct	Overlay
class	Bounds
struct	CameraInstanceData
class	Cameras
class	Cursor
class	Curves
class	Empties
struct	Engine
class	Facing
class	Fade
class	Fluids
class	ForceFields
class	GreasePencil
class	Grid
class	Images
class	Instance
class	Lattices
class	Lights
class	LightProbes
class	Meshes
class	MeshUVs
class	Metaballs
class	ModeTransfer
class	MotionPath
class	Names
class	Origins
class	Outline
class	Paints
class	Particles
class	PointClouds
class	ImagePrepass
class	Prepass
struct	BoneInstanceData
struct	State
struct	Vertex
struct	VertexBone
struct	VertexWithColor
struct	VertShaded
struct	VertexTriple
class	ShapeCache
class	ShaderModule
struct	GreasePencilDepthPlane
struct	Resources
struct	FlatObjectRef
struct	ShapeInstanceBuf
struct	VertexPrimitiveBuf
struct	PointPrimitiveBuf
struct	LinePrimitiveBuf
class	Relations
class	Sculpts
class	Speakers
class	Text
class	Wireframe
class	XrayFade
class	Framebuffer
class	StorageVectorBuffer
class	Texture
class	TextureFromPool
class	TextureRef

Typedefs
using	SelectionType = select::SelectionType
using	StaticShader = gpu::StaticShader

Enumerations
enum	eArmatureDrawMode { ARM_DRAW_MODE_OBJECT , ARM_DRAW_MODE_POSE , ARM_DRAW_MODE_EDIT }

Functions
static bool	is_from_dupli_or_set (const Object *ob)
static bool	is_from_dupli_or_set (const ObjectRef &ob_ref)
static void	append_line_loop (Vector< Vertex > &dest, Span< float2 > verts, float z, VertexClass flag, bool dashed=false)
static float	light_distance_z_get (char axis, const bool start)
static Vector< float2 >	ring_vertices (const float radius, const int segments, const bool half=false)
static Vector< Vertex >	sphere_axes_circles (const float radius, const VertexClass vclass, const int segments)
static void	light_append_direction_line (const char axis, Span< float2 > diamond, Vector< Vertex > &verts)
static void	light_append_direction_line (Vector< Vertex > &verts)
static VertShaded	sphere_lat_lon_vert (const float2 &lat_pt, const float2 &lon_pt)
static void	append_sphere (Vector< VertShaded > &dest, const eDRWLevelOfDetail level_of_detail)

Variables
constexpr int	overlay_edit_text
static constexpr int	diamond_nsegments = 4
static constexpr int	inner_nsegments = 8
static constexpr int	outer_nsegments = 10
static constexpr int	circle_nsegments = 32
static constexpr float	bone_box_verts [8][3]
static constexpr std::array< uint, 24 >	bone_box_wire_lines
static const std::array< uint3, 12 >	bone_box_solid_tris
static const std::array< uint4, 12 >	bone_box_wire_lines_adjacency
static const std::array< float3, 12 >	bone_box_solid_normals
static const std::array< float3, 6 >	bone_octahedral_verts
static const std::array< float3, 6 >	bone_octahedral_smooth_normals
static const std::array< uint2, 12 >	bone_octahedral_wire_lines
static const std::array< uint3, 8 >	bone_octahedral_solid_tris
static const std::array< uint4, 12 >	bone_octahedral_wire_lines_adjacency
static const float	bone_octahedral_solid_normals [8][3]

Typedef Documentation

SelectionType

using blender::draw::overlay::SelectionType = select::SelectionType

Definition at line 117 of file overlay_private.hh.

StaticShader

using blender::draw::overlay::StaticShader = gpu::StaticShader

Definition at line 423 of file overlay_private.hh.

Enumeration Type Documentation

eArmatureDrawMode

enum blender::draw::overlay::eArmatureDrawMode

Enumerator
ARM_DRAW_MODE_OBJECT
ARM_DRAW_MODE_POSE
ARM_DRAW_MODE_EDIT

Definition at line 23 of file overlay_armature.hh.

Function Documentation

append_line_loop()

void blender::draw::overlay::append_line_loop ( Vector< Vertex > & dest, Span< float2 > verts, float z, VertexClass flag, bool dashed = false )

static

Definition at line 186 of file overlay_shape.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), flag, i, blender::math::step(), verts, and z().

Referenced by light_append_direction_line(), and blender::draw::overlay::ShapeCache::ShapeCache().

append_sphere()

void blender::draw::overlay::append_sphere ( Vector< VertShaded > & dest, const eDRWLevelOfDetail level_of_detail )

static

Definition at line 284 of file overlay_shape.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::draw::DRW_LOD_LOW, blender::draw::DRW_LOD_MAX, i, blender::Vector< T, InlineBufferCapacity, Allocator >::index_range(), blender::IndexRange::last(), ring_vertices(), blender::Vector< T, InlineBufferCapacity, Allocator >::size(), and sphere_lat_lon_vert().

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

is_from_dupli_or_set() [1/2]

bool blender::draw::overlay::is_from_dupli_or_set ( const Object * ob )

inlinestatic

Definition at line 1187 of file overlay_private.hh.

References Object::base_flag, BASE_FROM_DUPLI, and BASE_FROM_SET.

Referenced by blender::draw::overlay::Armatures::draw_armature_pose(), is_from_dupli_or_set(), blender::draw::overlay::Axes::object_sync(), blender::draw::overlay::Bounds::object_sync(), blender::draw::overlay::Fluids::object_sync(), blender::draw::overlay::Names::object_sync(), blender::draw::overlay::Origins::object_sync(), and blender::draw::overlay::Relations::object_sync().

is_from_dupli_or_set() [2/2]

bool blender::draw::overlay::is_from_dupli_or_set ( const ObjectRef & ob_ref )

inlinestatic

Definition at line 1194 of file overlay_private.hh.

References is_from_dupli_or_set(), and blender::draw::ObjectRef::object.

light_append_direction_line() [1/2]

void blender::draw::overlay::light_append_direction_line ( const char axis, Span< float2 > diamond, Vector< Vertex > & verts )

static

Definition at line 258 of file overlay_shape.cc.

References append_line_loop(), light_distance_z_get(), VCLASS_LIGHT_DIST, VCLASS_SCREENSPACE, and verts.

Referenced by light_append_direction_line(), and blender::draw::overlay::ShapeCache::ShapeCache().

light_append_direction_line() [2/2]

void blender::draw::overlay::light_append_direction_line ( Vector< Vertex > & verts )

static

Definition at line 270 of file overlay_shape.cc.

References diamond_nsegments, light_append_direction_line(), ring_vertices(), and verts.

light_distance_z_get()

float blender::draw::overlay::light_distance_z_get ( char axis, const bool start )

static

Definition at line 198 of file overlay_shape.cc.

Referenced by light_append_direction_line().

ring_vertices()

Vector< float2 > blender::draw::overlay::ring_vertices ( const float radius, const int segments, const bool half = false )

static

Definition at line 218 of file overlay_shape.cc.

References angle(), blender::math::cos(), blender::math::numbers::pi, blender::math::sin(), and verts.

Referenced by append_sphere(), light_append_direction_line(), blender::draw::overlay::ShapeCache::ShapeCache(), and sphere_axes_circles().

sphere_axes_circles()

Vector< Vertex > blender::draw::overlay::sphere_axes_circles ( const float radius, const VertexClass vclass, const int segments )

static

Definition at line 232 of file overlay_shape.cc.

References i, ring_vertices(), and verts.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

sphere_lat_lon_vert()

VertShaded blender::draw::overlay::sphere_lat_lon_vert ( const float2 & lat_pt, const float2 & lon_pt )

static

Definition at line 276 of file overlay_shape.cc.

References VCLASS_EMPTY_SCALED, x, y, and z().

Referenced by append_sphere().

Variable Documentation

bone_box_solid_normals

const std::array<float3, 12> blender::draw::overlay::bone_box_solid_normals

static

Initial value:

                                               = {
    float3{0.0f, -1.0f, 0.0f},
    {0.0f, -1.0f, 0.0f},
 
    {1.0f, 0.0f, 0.0f},
    {1.0f, 0.0f, 0.0f},
 
    {0.0f, 0.0f, -1.0f},
    {0.0f, 0.0f, -1.0f},
 
    {-1.0f, 0.0f, 0.0f},
    {-1.0f, 0.0f, 0.0f},
 
    {0.0f, 0.0f, 1.0f},
    {0.0f, 0.0f, 1.0f},
 
    {0.0f, 1.0f, 0.0f},
    {0.0f, 1.0f, 0.0f},
}

Definition at line 76 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_box_solid_tris

const std::array<uint3, 12> blender::draw::overlay::bone_box_solid_tris

static

Initial value:

{
    uint3{0, 2, 1}, 
    {0, 3, 2},
 
    {0, 1, 5}, 
    {0, 5, 4},
 
    {1, 2, 6},
    {1, 6, 5},
 
    {2, 3, 7},
    {2, 7, 6},
 
    {3, 0, 4},
    {3, 4, 7},
 
    {4, 5, 6}, 
    {4, 6, 7},
}

Definition at line 36 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_box_verts

float blender::draw::overlay::bone_box_verts[8][3]

staticconstexpr

Initial value:

                                      = {
    {1.0f, 0.0f, 1.0f},
    {1.0f, 0.0f, -1.0f},
    {-1.0f, 0.0f, -1.0f},
    {-1.0f, 0.0f, 1.0f},
    {1.0f, 1.0f, 1.0f},
    {1.0f, 1.0f, -1.0f},
    {-1.0f, 1.0f, -1.0f},
    {-1.0f, 1.0f, 1.0f},
}

Definition at line 21 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_box_wire_lines

std::array<uint, 24> blender::draw::overlay::bone_box_wire_lines

staticconstexpr

Initial value:

                                                = {
    0, 1, 1, 2, 2, 3, 3, 0, 4, 5, 5, 6, 6, 7, 7, 4, 0, 4, 1, 5, 2, 6, 3, 7,
}

Definition at line 32 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_box_wire_lines_adjacency

const std::array<uint4, 12> blender::draw::overlay::bone_box_wire_lines_adjacency

static

Initial value:

                                                      = {
    uint4{4, 2, 0, 11},
    {0, 1, 2, 8},
    {2, 4, 1, 14},
    {1, 0, 4, 20}, 
    {0, 8, 11, 14},
    {2, 14, 8, 20},
    {1, 20, 14, 11},
    {4, 11, 20, 8}, 
    {20, 0, 11, 2},
    {11, 2, 8, 1},
    {8, 1, 14, 4},
    {14, 4, 20, 0}, 
}

Store indices of generated verts from bone_box_solid_tris to define adjacency information. See bone_octahedral_solid_tris for more information.

Definition at line 60 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_octahedral_smooth_normals

const std::array<float3, 6> blender::draw::overlay::bone_octahedral_smooth_normals

static

Initial value:

{
    float3{0.0f, -1.0f, 0.0f},
    {float(M_SQRT1_2), 0.0f, float(M_SQRT1_2)},
    {float(M_SQRT1_2), 0.0f, -float(M_SQRT1_2)},
    {-float(M_SQRT1_2), 0.0f, -float(M_SQRT1_2)},
    {-float(M_SQRT1_2), 0.0f, float(M_SQRT1_2)},
    {0.0f, 1.0f, 0.0f},
}

NOTE: This is not the correct normals. The correct smooth normals for the equator vertices should be {+-0.943608f * M_SQRT1_2, -0.331048f, +-0.943608f * M_SQRT1_2} but it creates problems for outlines when bones are scaled.

Definition at line 111 of file overlay_shape.cc.

bone_octahedral_solid_normals

const float blender::draw::overlay::bone_octahedral_solid_normals[8][3]

static

Initial value:

                                                 = {
    {M_SQRT1_2, -M_SQRT1_2, 0.00000000f},
    {-0.00000000f, -M_SQRT1_2, -M_SQRT1_2},
    {-M_SQRT1_2, -M_SQRT1_2, 0.00000000f},
    {0.00000000f, -M_SQRT1_2, M_SQRT1_2},
    {0.99388373f, 0.11043154f, -0.00000000f},
    {0.00000000f, 0.11043154f, -0.99388373f},
    {-0.99388373f, 0.11043154f, 0.00000000f},
    {0.00000000f, 0.11043154f, 0.99388373f},
}

Definition at line 175 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_octahedral_solid_tris

const std::array<uint3, 8> blender::draw::overlay::bone_octahedral_solid_tris

static

Initial value:

                                                   = {
    uint3{2, 1, 0}, 
    {3, 2, 0},
    {4, 3, 0},
    {1, 4, 0},
 
    {5, 1, 2}, 
    {5, 2, 3},
    {5, 3, 4},
    {5, 4, 1},
}

Definition at line 135 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_octahedral_verts

const std::array<float3, 6> blender::draw::overlay::bone_octahedral_verts

static

Initial value:

{
    float3{0.0f, 0.0f, 0.0f},
    {0.1f, 0.1f, 0.1f},
    {0.1f, 0.1f, -0.1f},
    {-0.1f, 0.1f, -0.1f},
    {-0.1f, 0.1f, 0.1f},
    {0.0f, 1.0f, 0.0f},
}

Definition at line 96 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_octahedral_wire_lines

const std::array<uint2, 12> blender::draw::overlay::bone_octahedral_wire_lines

static

Initial value:

                                                   = {
    uint2{0, 1},
    {1, 5},
    {5, 3},
    {3, 0},
    {0, 4},
    {4, 5},
    {5, 2},
    {2, 0},
    {1, 2},
    {2, 3},
    {3, 4},
    {4, 1},
}

Definition at line 120 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

bone_octahedral_wire_lines_adjacency

const std::array<uint4, 12> blender::draw::overlay::bone_octahedral_wire_lines_adjacency

static

Initial value:

                                                             = {
    uint4{0, 1, 2, 6},
    {0, 12, 1, 6},
    {0, 3, 12, 6},
    {0, 2, 3, 6},
    {1, 6, 2, 3},
    {1, 12, 6, 3},
    {1, 0, 12, 3},
    {1, 2, 0, 3},
    {2, 0, 1, 12},
    {2, 3, 0, 12},
    {2, 6, 3, 12},
    {2, 1, 6, 12},
}

Store indices of generated verts from bone_octahedral_solid_tris to define adjacency information. Example: triangle {2, 1, 0} is adjacent to {3, 2, 0}, {1, 4, 0} and {5, 1, 2}. {2, 1, 0} becomes {0, 1, 2} {3, 2, 0} becomes {3, 4, 5} {1, 4, 0} becomes {9, 10, 11} {5, 1, 2} becomes {12, 13, 14} According to opengl specification it becomes (starting from the first vertex of the first face aka. vertex 2): {0, 12, 1, 10, 2, 3}

Definition at line 159 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

circle_nsegments

int blender::draw::overlay::circle_nsegments = 32

staticconstexpr

Definition at line 19 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

diamond_nsegments

int blender::draw::overlay::diamond_nsegments = 4

staticconstexpr

Definition at line 16 of file overlay_shape.cc.

Referenced by light_append_direction_line(), and blender::draw::overlay::ShapeCache::ShapeCache().

inner_nsegments

int blender::draw::overlay::inner_nsegments = 8

staticconstexpr

Definition at line 17 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

outer_nsegments

int blender::draw::overlay::outer_nsegments = 10

staticconstexpr

Definition at line 18 of file overlay_shape.cc.

Referenced by blender::draw::overlay::ShapeCache::ShapeCache().

overlay_edit_text

int blender::draw::overlay::overlay_edit_text

constexpr

Initial value:

= V3D_OVERLAY_EDIT_EDGE_LEN | V3D_OVERLAY_EDIT_FACE_AREA |
  V3D_OVERLAY_EDIT_FACE_ANG | V3D_OVERLAY_EDIT_EDGE_ANG |
  V3D_OVERLAY_EDIT_INDICES

Definition at line 38 of file overlay_mesh.hh.

Referenced by blender::draw::overlay::Meshes::edit_object_sync().