DNA_collection_types.h File Reference

Object groups, one object can be in many groups at once. More...

#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"

Go to the source code of this file.

Classes
struct	CollectionLightLinking
struct	CollectionObject
struct	CollectionChild
struct	CollectionExport
struct	Collection_Runtime
struct	Collection

Macros
#define	COLLECTION_FLAG_ALL_RUNTIME    (COLLECTION_HAS_OBJECT_CACHE | COLLECTION_HAS_OBJECT_CACHE_INSTANCED)

Typedefs
typedef struct CollectionLightLinking	CollectionLightLinking
typedef struct CollectionObject	CollectionObject
typedef struct CollectionChild	CollectionChild
typedef struct CollectionExport	CollectionExport
typedef enum IOHandlerPanelFlag	IOHandlerPanelFlag
typedef enum eCollectionLightLinkingState	eCollectionLightLinkingState
typedef struct Collection_Runtime	Collection_Runtime
typedef struct Collection	Collection
typedef enum CollectionColorTag	CollectionColorTag

Enumerations
enum	IOHandlerPanelFlag { IO_HANDLER_PANEL_OPEN = 1 << 0 }
enum	eCollectionLightLinkingState { COLLECTION_LIGHT_LINKING_STATE_INCLUDE = 0 , COLLECTION_LIGHT_LINKING_STATE_EXCLUDE = 1 }
enum	eCollectionLineArt_Usage {   COLLECTION_LRT_INCLUDE = 0 , COLLECTION_LRT_OCCLUSION_ONLY = (1 << 0) , COLLECTION_LRT_EXCLUDE = (1 << 1) , COLLECTION_LRT_INTERSECTION_ONLY = (1 << 2) ,   COLLECTION_LRT_NO_INTERSECTION = (1 << 3) , COLLECTION_LRT_FORCE_INTERSECTION = (1 << 4) }
enum	eCollectionLineArt_Flags { COLLECTION_LRT_USE_INTERSECTION_MASK = (1 << 0) , COLLECTION_LRT_USE_INTERSECTION_PRIORITY = (1 << 1) }
enum	{   COLLECTION_HIDE_VIEWPORT = (1 << 0) , COLLECTION_HIDE_SELECT = (1 << 1) , COLLECTION_HIDE_RENDER = (1 << 3) , COLLECTION_HAS_OBJECT_CACHE = (1 << 4) ,   COLLECTION_IS_MASTER = (1 << 5) , COLLECTION_HAS_OBJECT_CACHE_INSTANCED = (1 << 6) }
enum	{ COLLECTION_TAG_RELATION_REBUILD = (1 << 0) , COLLECTION_TAG_COLLECTION_OBJECT_DIRTY = (1 << 1) }
enum	CollectionColorTag {   COLLECTION_COLOR_NONE = -1 , COLLECTION_COLOR_01 , COLLECTION_COLOR_02 , COLLECTION_COLOR_03 ,   COLLECTION_COLOR_04 , COLLECTION_COLOR_05 , COLLECTION_COLOR_06 , COLLECTION_COLOR_07 ,   COLLECTION_COLOR_08 , COLLECTION_COLOR_TOT }

Detailed Description

Object groups, one object can be in many groups at once.

Definition in file DNA_collection_types.h.

Macro Definition Documentation

COLLECTION_FLAG_ALL_RUNTIME

#define COLLECTION_FLAG_ALL_RUNTIME    (COLLECTION_HAS_OBJECT_CACHE | COLLECTION_HAS_OBJECT_CACHE_INSTANCED)

Definition at line 180 of file DNA_collection_types.h.

Typedef Documentation

Collection

typedef struct Collection Collection

Collection_Runtime

typedef struct Collection_Runtime Collection_Runtime

CollectionChild

typedef struct CollectionChild CollectionChild

CollectionColorTag

typedef enum CollectionColorTag CollectionColorTag

Collection.color_tag

CollectionExport

typedef struct CollectionExport CollectionExport

CollectionLightLinking

typedef struct CollectionLightLinking CollectionLightLinking

CollectionObject

typedef struct CollectionObject CollectionObject

eCollectionLightLinkingState

typedef enum eCollectionLightLinkingState eCollectionLightLinkingState

IOHandlerPanelFlag

typedef enum IOHandlerPanelFlag IOHandlerPanelFlag

Enumeration Type Documentation

anonymous enum

anonymous enum

Collection.flag

Enumerator
COLLECTION_HIDE_VIEWPORT	Disable in viewports.
COLLECTION_HIDE_SELECT	Not selectable in viewport.
COLLECTION_HIDE_RENDER	Disable in renders.
COLLECTION_HAS_OBJECT_CACHE	Runtime: object_cache is populated.
COLLECTION_IS_MASTER	Is master collection embedded in the scene.
COLLECTION_HAS_OBJECT_CACHE_INSTANCED	for object_cache_instanced.

Definition at line 164 of file DNA_collection_types.h.

anonymous enum

anonymous enum

Collection_Runtime.tag

Enumerator
COLLECTION_TAG_RELATION_REBUILD	That code (BKE_main_collections_parent_relations_rebuild and the like) is called from very low-level places, like e.g ID remapping... Using a generic tag like ID_TAG_DOIT for this is just impossible, we need our very own.
COLLECTION_TAG_COLLECTION_OBJECT_DIRTY	Mark the gobject list and/or its runtime.gobject_hash mapping as dirty, i.e. that their data is not reliable and should be cleaned-up or updated. This should typically only be set by ID remapping code.

Definition at line 184 of file DNA_collection_types.h.

CollectionColorTag

enum CollectionColorTag

Collection.color_tag

Enumerator
COLLECTION_COLOR_NONE
COLLECTION_COLOR_01
COLLECTION_COLOR_02
COLLECTION_COLOR_03
COLLECTION_COLOR_04
COLLECTION_COLOR_05
COLLECTION_COLOR_06
COLLECTION_COLOR_07
COLLECTION_COLOR_08
COLLECTION_COLOR_TOT

Definition at line 201 of file DNA_collection_types.h.

eCollectionLightLinkingState

enum eCollectionLightLinkingState

Enumerator
COLLECTION_LIGHT_LINKING_STATE_INCLUDE
COLLECTION_LIGHT_LINKING_STATE_EXCLUDE

Definition at line 85 of file DNA_collection_types.h.

eCollectionLineArt_Flags

enum eCollectionLineArt_Flags

Enumerator
COLLECTION_LRT_USE_INTERSECTION_MASK
COLLECTION_LRT_USE_INTERSECTION_PRIORITY

Definition at line 99 of file DNA_collection_types.h.

eCollectionLineArt_Usage

enum eCollectionLineArt_Usage

Enumerator
COLLECTION_LRT_INCLUDE
COLLECTION_LRT_OCCLUSION_ONLY
COLLECTION_LRT_EXCLUDE
COLLECTION_LRT_INTERSECTION_ONLY
COLLECTION_LRT_NO_INTERSECTION
COLLECTION_LRT_FORCE_INTERSECTION

Definition at line 90 of file DNA_collection_types.h.

IOHandlerPanelFlag

enum IOHandlerPanelFlag

Enumerator
IO_HANDLER_PANEL_OPEN

Definition at line 79 of file DNA_collection_types.h.