BKE_light_linking.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include "DNA_collection_types.h" /* eCollectionLightLinkingState */
 
struct ID;
struct Main;
struct Object;
struct Collection;
struct ReportList;
struct Scene;
struct ViewLayer;
 
typedef enum LightLinkingType {
  LIGHT_LINKING_RECEIVER,
  LIGHT_LINKING_BLOCKER,
} LightLinkingType;

void BKE_light_linking_ensure(struct Object *object);

void BKE_light_linking_copy(struct Object *object_dst,
                            const struct Object *object_src,
                            const int copy_flags);

void BKE_light_linking_delete(struct Object *object, const int delete_flags);

void BKE_light_linking_free_if_empty(struct Object *object);

struct Collection *BKE_light_linking_collection_get(const struct Object *object,
                                                    LightLinkingType link_type);

struct Collection *BKE_light_linking_collection_new(struct Main *bmain,
                                                    struct Object *object,
                                                    LightLinkingType link_type);

void BKE_light_linking_collection_assign_only(struct Object *object,
                                              struct Collection *new_collection,
                                              LightLinkingType link_type);
void BKE_light_linking_collection_assign(struct Main *bmain,
                                         struct Object *object,
                                         struct Collection *new_collection,
                                         LightLinkingType link_type);

void BKE_light_linking_add_receiver_to_collection(struct Main *bmain,
                                                  struct Collection *collection,
                                                  struct ID *receiver,
                                                  const eCollectionLightLinkingState link_state);
void BKE_light_linking_add_receiver_to_collection_before(
    struct Main *bmain,
    struct Collection *collection,
    struct ID *receiver,
    const struct ID *before,
    const eCollectionLightLinkingState link_state);
void BKE_light_linking_add_receiver_to_collection_after(
    struct Main *bmain,
    struct Collection *collection,
    struct ID *receiver,
    const struct ID *after,
    const eCollectionLightLinkingState link_state);

bool BKE_light_linking_unlink_id_from_collection(struct Main *bmain,
                                                 struct Collection *collection,
                                                 struct ID *id,
                                                 struct ReportList *reports);

void BKE_light_linking_link_receiver_to_emitter(struct Main *bmain,
                                                struct Object *emitter,
                                                struct Object *receiver,
                                                LightLinkingType link_type,
                                                eCollectionLightLinkingState link_state);

void BKE_light_linking_select_receivers_of_emitter(struct Scene *scene,
                                                   struct ViewLayer *view_layer,
                                                   struct Object *emitter,
                                                   LightLinkingType link_type);