Blender V5.3
blender::bke::pbvh::Tree Class Reference

#include <BKE_paint_bvh.hh>

Public Member Functions

 Tree (const Tree &other)=delete
 Tree (Tree &&other)=default
Tree & operator= (const Tree &other)=delete
Tree & operator= (Tree &&other)=default
 ~Tree ()
int nodes_num () const
template<typename NodeT>
Span< NodeT > nodes () const
template<typename NodeT>
MutableSpan< NodeT > nodes ()
Type type () const
void tag_positions_changed (const IndexMask &node_mask)
void tag_visibility_changed (const IndexMask &node_mask)
void tag_topology_changed (const IndexMask &node_mask)
void tag_face_sets_changed (const IndexMask &node_mask)
void tag_masks_changed (const IndexMask &node_mask)
void tag_attribute_changed (const IndexMask &node_mask, StringRef attribute_name)
void flush_bounds_to_parents ()
void update_bounds (const Depsgraph &depsgraph, const Object &object)
void update_bounds_mesh (Span< float3 > vert_positions)
void update_bounds_grids (Span< float3 > positions, int grid_area)
void update_bounds_bmesh (const BMesh &bm)
void update_normals (Object &object_orig, Object &object_eval)
void update_visibility (const Object &object)
template<>
Span< MeshNode > nodes () const
template<>
Span< GridsNode > nodes () const
template<>
Span< BMeshNode > nodes () const
template<>
MutableSpan< MeshNode > nodes ()
template<>
MutableSpan< GridsNode > nodes ()
template<>
MutableSpan< BMeshNode > nodes ()

Static Public Member Functions

static Tree from_mesh (const Mesh &mesh)
static Tree from_grids (const Mesh &base_mesh, const SubdivCCG &subdiv_ccg)
static Tree from_bmesh (BMesh &bm)

Public Attributes

std::variant< Vector< MeshNode >, Vector< GridsNode >, Vector< BMeshNode > > nodes_
pixels::PixelData * pixels_ = nullptr
std::unique_ptr< DrawCache > draw_data

Detailed Description

Todo
Most data is public but should either be removed or become private in the future. The "_" suffix means that fields shouldn't be used by consumers of the bke::pbvh API.

Definition at line 226 of file BKE_paint_bvh.hh.

Constructor & Destructor Documentation

◆ Tree() [1/2]

blender::bke::pbvh::Tree::Tree ( const Tree & other)
delete

◆ Tree() [2/2]

blender::bke::pbvh::Tree::Tree ( Tree && other)
default

References Tree().

◆ ~Tree()

blender::bke::pbvh::Tree::~Tree ( )

Definition at line 609 of file pbvh.cc.

References blender::bke::pbvh::pixels_free().

Member Function Documentation

◆ flush_bounds_to_parents()

◆ from_bmesh()

◆ from_grids()

◆ from_mesh()

◆ nodes() [1/8]

◆ nodes() [2/8]

template<>
MutableSpan< BMeshNode > blender::bke::pbvh::Tree::nodes ( )

Definition at line 604 of file pbvh.cc.

References nodes_.

◆ nodes() [3/8]

template<>
MutableSpan< GridsNode > blender::bke::pbvh::Tree::nodes ( )

Definition at line 600 of file pbvh.cc.

References nodes_.

◆ nodes() [4/8]

template<>
MutableSpan< MeshNode > blender::bke::pbvh::Tree::nodes ( )

Definition at line 596 of file pbvh.cc.

References nodes_.

◆ nodes() [5/8]

◆ nodes() [6/8]

template<>
Span< BMeshNode > blender::bke::pbvh::Tree::nodes ( ) const

Definition at line 592 of file pbvh.cc.

References nodes_.

◆ nodes() [7/8]

template<>
Span< GridsNode > blender::bke::pbvh::Tree::nodes ( ) const

Definition at line 588 of file pbvh.cc.

References nodes_.

◆ nodes() [8/8]

template<>
Span< MeshNode > blender::bke::pbvh::Tree::nodes ( ) const

Definition at line 584 of file pbvh.cc.

References nodes_.

◆ nodes_num()

int blender::bke::pbvh::Tree::nodes_num ( ) const

Definition at line 579 of file pbvh.cc.

References nodes(), nodes_, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

Referenced by operator=().

◆ operator=() [1/2]

Tree & blender::bke::pbvh::Tree::operator= ( const Tree & other)
delete

References Tree().

◆ operator=() [2/2]

Tree & blender::bke::pbvh::Tree::operator= ( Tree && other)
default

◆ tag_attribute_changed()

void blender::bke::pbvh::Tree::tag_attribute_changed ( const IndexMask & node_mask,
StringRef attribute_name )

Tag nodes where generic attribute data has changed (not positions, masks, or face sets).

Definition at line 655 of file pbvh.cc.

References draw_data.

Referenced by nodes().

◆ tag_face_sets_changed()

void blender::bke::pbvh::Tree::tag_face_sets_changed ( const IndexMask & node_mask)

Tag nodes where face sets have changed, causing refresh of derived data.

Definition at line 641 of file pbvh.cc.

References draw_data.

Referenced by nodes().

◆ tag_masks_changed()

void blender::bke::pbvh::Tree::tag_masks_changed ( const IndexMask & node_mask)

Tag nodes where mask values have changed, causing refresh of derived data.

Definition at line 648 of file pbvh.cc.

References draw_data.

Referenced by nodes().

◆ tag_positions_changed()

void blender::bke::pbvh::Tree::tag_positions_changed ( const IndexMask & node_mask)

Mark data based on positions for specific BVH nodes dirty. In particular: bounds, normals, and GPU data buffers. That data is recomputed later on in functions like update_bounds.

Warning
Must not be called from multiple threads in parallel.

Definition at line 614 of file pbvh.cc.

References draw_data, blender::index_mask::IndexMask::min_array_size(), and blender::index_mask::IndexMask::set_bits().

Referenced by nodes().

◆ tag_topology_changed()

void blender::bke::pbvh::Tree::tag_topology_changed ( const IndexMask & node_mask)

Tag nodes that have a different number of vertices or faces (currently just for Type::BMesh).

Definition at line 634 of file pbvh.cc.

References draw_data.

Referenced by nodes().

◆ tag_visibility_changed()

void blender::bke::pbvh::Tree::tag_visibility_changed ( const IndexMask & node_mask)

Tag nodes where face or vertex visibility has changed.

Definition at line 625 of file pbvh.cc.

References draw_data, blender::index_mask::IndexMask::min_array_size(), and blender::index_mask::IndexMask::set_bits().

Referenced by nodes().

◆ type()

Type blender::bke::pbvh::Tree::type ( ) const
inline

Definition at line 673 of file BKE_paint_bvh.hh.

Referenced by nodes().

◆ update_bounds()

void blender::bke::pbvh::Tree::update_bounds ( const Depsgraph & depsgraph,
const Object & object )

Recalculate node bounding boxes based on the current coordinates. Calculation is only done for affected nodes that have been tagged by #PBVH::tag_positions_changed().

Definition at line 1309 of file pbvh.cc.

References blender::SculptSession::bm, blender::bke::pbvh::BMesh, blender::Core, blender::SubdivCCG::grid_area, blender::bke::pbvh::Grids, blender::bke::pbvh::Mesh, blender::SubdivCCG::positions, PRF_scope, blender::SculptSession::subdiv_ccg, update_bounds_bmesh(), update_bounds_grids(), update_bounds_mesh(), and blender::bke::pbvh::vert_positions_eval().

Referenced by nodes().

◆ update_bounds_bmesh()

◆ update_bounds_grids()

◆ update_bounds_mesh()

◆ update_normals()

◆ update_visibility()

Member Data Documentation

◆ draw_data

std::unique_ptr<DrawCache> blender::bke::pbvh::Tree::draw_data

◆ nodes_

std::variant<Vector<MeshNode>, Vector<GridsNode>, Vector<BMeshNode> > blender::bke::pbvh::Tree::nodes_

◆ pixels_

pixels::PixelData* blender::bke::pbvh::Tree::pixels_ = nullptr

Definition at line 257 of file BKE_paint_bvh.hh.


The documentation for this class was generated from the following files: