build.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2009-2010 NVIDIA Corporation
 * SPDX-FileCopyrightText: 2011-2022 Blender Foundation
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Adapted code from NVIDIA Corporation. */
 
#pragma once
 
#include <cfloat>
 
#include "bvh/params.h"
#include "bvh/unaligned.h"
 
#include "util/array.h"
#include "util/task.h"
#include "util/unique_ptr.h"
#include "util/vector.h"
 
CCL_NAMESPACE_BEGIN
 
class Boundbox;
class BVHBuildTask;
class BVHNode;
class BVHSpatialSplitBuildTask;
class BVHParams;
class InnerNode;
class Geometry;
class Hair;
class Mesh;
class Object;
class PointCloud;
class Progress;
 
/* BVH Builder */
 
class BVHBuild {
 public:
  /* Constructor/Destructor */
  BVHBuild(const vector<Object *> &objects,
           array<int> &prim_type,
           array<int> &prim_index,
           array<int> &prim_object,
           array<float2> &prim_time,
           const BVHParams &params,
           Progress &progress);
  ~BVHBuild();
 
  unique_ptr<BVHNode> run();
 
 protected:
  friend class BVHMixedSplit;
  friend class BVHObjectSplit;
  friend class BVHSpatialSplit;
  friend class BVHBuildTask;
  friend class BVHSpatialSplitBuildTask;
  friend class BVHObjectBinning;
 
  /* Adding references. */
  void add_reference_triangles(BoundBox &root,
                               BoundBox &center,
                               Mesh *mesh,
                               const int object_index);
  void add_reference_curves(BoundBox &root, BoundBox &center, Hair *hair, const int object_index);
  void add_reference_points(BoundBox &root, BoundBox &center, PointCloud *pointcloud, const int i);
  void add_reference_geometry(BoundBox &root,
                              BoundBox &center,
                              Geometry *geom,
                              const int object_index);
  void add_reference_object(BoundBox &root, BoundBox &center, Object *ob, const int i);
  void add_references(BVHRange &root);
 
  /* Building. */
  unique_ptr<BVHNode> build_node(const BVHRange &range,
                                 vector<BVHReference> &references,
                                 const int level,
                                 BVHSpatialStorage *storage);
  unique_ptr<BVHNode> build_node(const BVHObjectBinning &range, const int level);
  unique_ptr<BVHNode> create_leaf_node(const BVHRange &range,
                                       const vector<BVHReference> &references);
  unique_ptr<BVHNode> create_object_leaf_nodes(const BVHReference *ref,
                                               const int start,
                                               const int num);
 
  bool range_within_max_leaf_size(const BVHRange &range,
                                  const vector<BVHReference> &references) const;
 
  /* Threads. */
  enum { THREAD_TASK_SIZE = 4096 };
  void thread_build_node(InnerNode *inner,
                         const int child,
                         const BVHObjectBinning &range,
                         const int level);
  void thread_build_spatial_split_node(InnerNode *inner,
                                       const int child,
                                       const BVHRange &range,
                                       vector<BVHReference> &references,
                                       int level);
  thread_mutex build_mutex;
 
  /* Progress. */
  void progress_update();
 
  /* Tree rotations. */
  void rotate(BVHNode *node, const int max_depth);
  void rotate(BVHNode *node, const int max_depth, const int iterations);
 
  /* Objects and primitive references. */
  vector<Object *> objects;
  vector<BVHReference> references;
  int num_original_references;
 
  /* Output primitive indexes and objects. */
  array<int> &prim_type;
  array<int> &prim_index;
  array<int> &prim_object;
  array<float2> &prim_time;
 
  bool need_prim_time;
 
  /* Build parameters. */
  BVHParams params;
 
  /* Progress reporting. */
  Progress &progress;
  double progress_start_time;
  size_t progress_count;
  size_t progress_total;
  size_t progress_original_total;
 
  /* Spatial splitting. */
  float spatial_min_overlap;
  enumerable_thread_specific<BVHSpatialStorage> spatial_storage;
  size_t spatial_free_index;
  thread_spin_lock spatial_spin_lock;
 
  /* Threads. */
  TaskPool task_pool;
 
  /* Unaligned building. */
  BVHUnaligned unaligned_heuristic;
};
 
CCL_NAMESPACE_END