Collection(ID)

base classes — bpy_struct, ID

class bpy.types.Collection(ID)

Collection of Object data-blocks

all_objects

Objects that are in this collection and its child collections

Type: bpy_prop_collection of Object, (readonly)

children

Collections that are immediate children of this collection

Type: CollectionChildren bpy_prop_collection of Collection, (readonly)

color_tag

Color tag for a collection

NONE None – Assign no color tag to the collection.
COLOR_01 Color 01.
COLOR_02 Color 02.
COLOR_03 Color 03.
COLOR_04 Color 04.
COLOR_05 Color 05.
COLOR_06 Color 06.
COLOR_07 Color 07.
COLOR_08 Color 08.

Type: enum in [‘NONE’, ‘COLOR_01’, ‘COLOR_02’, ‘COLOR_03’, ‘COLOR_04’, ‘COLOR_05’, ‘COLOR_06’, ‘COLOR_07’, ‘COLOR_08’], default ‘NONE’

hide_render

Globally disable in renders

Type: boolean, default False

hide_select

Disable selection in viewport

Type: boolean, default False

hide_viewport

Globally disable in viewports

Type: boolean, default False

instance_offset

Offset from the origin to use when instancing

Type: float array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

lineart_intersection_mask

Intersection generated by this collection will have this mask value

Type: boolean array of 8 items, default (False, False, False, False, False, False, False, False)

lineart_usage

How to use this collection in line art

INCLUDE Include – Generate feature lines for this collection.
OCCLUSION_ONLY Occlusion Only – Only use the collection to produce occlusion.
EXCLUDE Exclude – Don’t use this collection in line art.
INTERSECTION_ONLY Intersection Only – Only generate intersection lines for this collection.
NO_INTERSECTION No Intersection – Include this collection but do not generate intersection lines.

Type: enum in [‘INCLUDE’, ‘OCCLUSION_ONLY’, ‘EXCLUDE’, ‘INTERSECTION_ONLY’, ‘NO_INTERSECTION’], default ‘INCLUDE’

lineart_use_intersection_mask

Use custom intersection mask for faces in this collection

Type: boolean, default False

objects

Objects that are directly in this collection

Type: CollectionObjects bpy_prop_collection of Object, (readonly)

children_recursive

A list of all children from this collection.

(readonly)

users_dupli_group

The collection instance objects this collection is used in

(readonly)

classmethod bl_rna_get_subclass(id, default=None)

Parameters: id (string) – The RNA type identifier.
Returns: The RNA type or default when not found.
Return type: bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters: id (string) – The RNA type identifier.
Returns: The class or default when not found.
Return type: type

Inherited Properties

Inherited Functions

References