GEO_realize_instances.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BKE_geometry_set.hh"
 
namespace blender::geometry {

struct RealizeInstancesOptions {
  bool keep_original_ids = false;
  bool realize_instance_attributes = true;
 
  std::reference_wrapper<const bke::AttributeFilter> attribute_filter =
      bke::AttributeFilter::default_filter();
};

struct VariedDepthOptions {
  IndexMask selection;

  VArray<int> depths;

  static constexpr int MAX_DEPTH = -1;
};
 
struct RealizeInstancesResult {
  bke::GeometrySet geometry;
  Vector<std::string> errors;
};

RealizeInstancesResult realize_instances(bke::GeometrySet geometry_set,
                                         const RealizeInstancesOptions &options);

RealizeInstancesResult realize_instances(bke::GeometrySet geometry_set,
                                         const RealizeInstancesOptions &options,
                                         const VariedDepthOptions &varied_depth_option);
 
}  // namespace blender::geometry