blender::bke::InstanceReference Class Reference

#include <BKE_instances.hh>

Public Types
enum class	Type { None , Object , Collection , GeometrySet }

Public Member Functions
	InstanceReference ()=default
	InstanceReference (GeometrySet geometry_set)
	InstanceReference (const InstanceReference &other)
void	to_geometry_set (GeometrySet &r_geometry_set) const
StringRefNull	name () const
bool	owns_direct_data () const
void	ensure_owns_direct_data ()
void	count_memory (MemoryCounter &memory) const
uint64_t	hash () const
#InstanceReference Inline Methods
	InstanceReference (Object &object)
	InstanceReference (Collection &collection)
	InstanceReference (std::unique_ptr< GeometrySet > geometry_set)
	InstanceReference (InstanceReference &&other)
InstanceReference &	operator= (const InstanceReference &other)
InstanceReference &	operator= (InstanceReference &&other)
Type	type () const
Object &	object () const
Collection &	collection () const
GeometrySet &	geometry_set ()
const GeometrySet &	geometry_set () const

Friends
bool	operator== (const InstanceReference &a, const InstanceReference &b)

Detailed Description

Holds a reference to conceptually unique geometry or a pointer to object/collection data that is instanced with a transform in #Instances.

Definition at line 54 of file BKE_instances.hh.

Member Enumeration Documentation

Type

enum class blender::bke::InstanceReference::Type

strong

Enumerator
None	An empty instance. This allows an InstanceReference to be default constructed without being in an invalid state. There might also be other use cases that we haven't explored much yet (such as changing the instance later on, and "disabling" some instances).
Object
Collection
GeometrySet

Definition at line 56 of file BKE_instances.hh.

Constructor & Destructor Documentation

InstanceReference() [1/7]

blender::bke::InstanceReference::InstanceReference ( )

default

Referenced by operator=(), and operator=().

InstanceReference() [2/7]

blender::bke::InstanceReference::InstanceReference ( Object & object )

inline

Definition at line 244 of file BKE_instances.hh.

InstanceReference() [3/7]

blender::bke::InstanceReference::InstanceReference ( Collection & collection )

inline

Definition at line 248 of file BKE_instances.hh.

InstanceReference() [4/7]

blender::bke::InstanceReference::InstanceReference

(

GeometrySet

geometry_set

)

Definition at line 20 of file instances.cc.

InstanceReference() [5/7]

blender::bke::InstanceReference::InstanceReference ( std::unique_ptr< GeometrySet > geometry_set )

inline

Definition at line 239 of file BKE_instances.hh.

InstanceReference() [6/7]

blender::bke::InstanceReference::InstanceReference

(

const InstanceReference &

other

)

Definition at line 26 of file instances.cc.

InstanceReference() [7/7]

blender::bke::InstanceReference::InstanceReference ( InstanceReference && other )

inline

Definition at line 253 of file BKE_instances.hh.

References None.

Member Function Documentation

collection()

Collection & blender::bke::InstanceReference::collection ( ) const

inline

Definition at line 291 of file BKE_instances.hh.

References BLI_assert, and Collection.

Referenced by BPy_GeometrySet_get_instance_references(), make_duplis_geometry_set_impl(), name(), and to_geometry_set().

count_memory()

void blender::bke::InstanceReference::count_memory

(

MemoryCounter &

memory

)

const

Definition at line 51 of file instances.cc.

References GeometrySet.

ensure_owns_direct_data()

void blender::bke::InstanceReference::ensure_owns_direct_data

(

)

Definition at line 34 of file instances.cc.

References GeometrySet.

Referenced by blender::bke::Instances::ensure_owns_direct_data().

geometry_set() [1/2]

GeometrySet & blender::bke::InstanceReference::geometry_set ( )

inline

Definition at line 297 of file BKE_instances.hh.

References BLI_assert, and GeometrySet.

Referenced by BPy_GeometrySet_get_instance_references(), blender::ed::view3d::geometry_nodes_gizmos::find_gizmo_geometry_transform_recursive(), make_duplis_geometry_set_impl(), name(), blender::nodes::node_geo_boolean_cc::node_geo_exec(), and to_geometry_set().

geometry_set() [2/2]

const GeometrySet & blender::bke::InstanceReference::geometry_set ( ) const

inline

Definition at line 303 of file BKE_instances.hh.

References BLI_assert, and GeometrySet.

hash()

uint64_t blender::bke::InstanceReference::hash

(

)

const

Definition at line 142 of file instances.cc.

References blender::get_default_hash().

name()

StringRefNull blender::bke::InstanceReference::name

(

)

const

Definition at line 119 of file instances.cc.

References Collection, collection(), geometry_set(), GeometrySet, Collection::id, Object::id, blender::bke::GeometrySet::name, ID::name, None, Object, and object().

Referenced by blender::ed::spreadsheet::InstanceReferenceViewItem::build_row(), and blender::nodes::node_geo_curves_to_grease_pencil_cc::curve_instances_to_grease_pencil_layers().

object()

Object & blender::bke::InstanceReference::object ( ) const

inline

Definition at line 285 of file BKE_instances.hh.

References BLI_assert, and Object.

Referenced by BPy_GeometrySet_get_instance_references(), blender::ed::spreadsheet::get_instance_reference_icon(), make_duplis_geometry_set_impl(), name(), blender::nodes::node_geo_boolean_cc::node_geo_exec(), and to_geometry_set().

operator=() [1/2]

InstanceReference & blender::bke::InstanceReference::operator= ( const InstanceReference & other )

inline

Definition at line 260 of file BKE_instances.hh.

References InstanceReference().

operator=() [2/2]

InstanceReference & blender::bke::InstanceReference::operator= ( InstanceReference && other )

inline

Definition at line 270 of file BKE_instances.hh.

References InstanceReference().

owns_direct_data()

bool blender::bke::InstanceReference::owns_direct_data

(

)

const

Definition at line 42 of file instances.cc.

References GeometrySet.

to_geometry_set()

void blender::bke::InstanceReference::to_geometry_set

(

GeometrySet &

r_geometry_set

)

const

Converts the instance reference to a geometry set, even if it was an object or collection before.

Note

Uses out-parameter to be able to use GeometrySet forward declaration.

Definition at line 93 of file instances.cc.

References blender::bke::GeometrySet::clear(), Collection, collection(), blender::bke::convert_collection_to_instances(), geometry_set(), GeometrySet, None, Object, object(), blender::bke::object_get_evaluated_geometry_set(), and blender::bke::GeometrySet::replace_instances().

Referenced by blender::nodes::node_geo_curves_to_grease_pencil_cc::curve_instances_to_grease_pencil_layers(), blender::geometry::foreach_geometry_in_reference(), blender::geometry::gather_attribute_propagation_components(), blender::geometry::gather_attribute_propagation_components_with_custom_depths(), and blender::ed::spreadsheet::get_geometry_set_for_instance_ids().

type()

InstanceReference::Type blender::bke::InstanceReference::type ( ) const

inline

Definition at line 280 of file BKE_instances.hh.

Referenced by BPy_GeometrySet_get_instance_references(), blender::ed::view3d::geometry_nodes_gizmos::find_gizmo_geometry_transform_recursive(), blender::ed::spreadsheet::get_instance_reference_icon(), blender::nodes::node_geo_input_instance_bounds_cc::InstanceBoundsField::get_varray_for_context(), make_duplis_geometry_set_impl(), and blender::nodes::node_geo_boolean_cc::node_geo_exec().

Friends And Related Symbol Documentation

operator==

bool operator== ( const InstanceReference & a, const InstanceReference & b )

friend

Definition at line 134 of file instances.cc.

---

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

• BKE_instances.hh
• instances.cc