Class Collection


  • public class Collection
    extends CFacade
    Generated facet for DNA struct type 'Collection'.

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

        public static final int __DNA__SDNA_INDEX
        This is the sdna index of the struct Collection.

        It is required when allocating a new block to store data for Collection.

        See Also:
        StructDNA, BlockTable, Constant Field Values
      • __DNA__FIELD__id

        public static final long[] __DNA__FIELD__id
        Field descriptor (offset) for struct member 'id'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__id);
         CPointer<ID> p_id = p.cast(new Class[]{ID.class});
         

        Metadata

        • Field: 'id'
        • Signature: 'ID'
        • Actual Size (32bit/64bit): 152/192
      • __DNA__FIELD__gobject

        public static final long[] __DNA__FIELD__gobject
        Field descriptor (offset) for struct member 'gobject'.

        Field Documentation

        Blender Source Code

        CollectionObject .

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__gobject);
         CPointer<ListBase> p_gobject = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'gobject'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__children

        public static final long[] __DNA__FIELD__children
        Field descriptor (offset) for struct member 'children'.

        Field Documentation

        Blender Python API

        (read-only) Collections that are immediate children of this collection

        Blender Source Code

        CollectionChild .

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__children);
         CPointer<ListBase> p_children = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'children'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__preview

        public static final long[] __DNA__FIELD__preview
        Field descriptor (offset) for struct member 'preview'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__preview);
         CPointer<CPointer<PreviewImage>> p_preview = p.cast(new Class[]{CPointer.class, PreviewImage.class});
         

        Metadata

        • Field: 'preview'
        • Signature: 'PreviewImage*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__layer

        public static final long[] __DNA__FIELD__layer
        Deprecated.
        Deprecated

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__layer);
         CPointer<Integer> p_layer = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'layer'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
        Field descriptor (offset) for struct member 'layer'.

        Field Documentation

        Blender Source Code

      • __DNA__FIELD__dupli_ofs

        public static final long[] __DNA__FIELD__dupli_ofs
        Field descriptor (offset) for struct member 'dupli_ofs'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__dupli_ofs);
         CPointer<CArrayFacade<Float>> p_dupli_ofs = p.cast(new Class[]{CArrayFacade.class, Float.class});
         

        Metadata

        • Field: 'dupli_ofs'
        • Signature: 'float[3]'
        • Actual Size (32bit/64bit): 12/12
      • __DNA__FIELD__flag

        public static final long[] __DNA__FIELD__flag
        Field descriptor (offset) for struct member 'flag'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__flag);
         CPointer<Short> p_flag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__tag

        public static final long[] __DNA__FIELD__tag
        Field descriptor (offset) for struct member 'tag'.

        Field Documentation

        Blender Source Code

        Runtime-only, always cleared on file load.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__tag);
         CPointer<Short> p_tag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'tag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__lineart_usage

        public static final long[] __DNA__FIELD__lineart_usage
        Field descriptor (offset) for struct member 'lineart_usage'.

        Field Documentation

        Blender Python API

        How to use this collection in line art

        Blender Source Code

        eCollectionLineArt_Usage

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__lineart_usage);
         CPointer<Short> p_lineart_usage = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'lineart_usage'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__lineart_flags

        public static final long[] __DNA__FIELD__lineart_flags
        Field descriptor (offset) for struct member 'lineart_flags'.

        Field Documentation

        Blender Source Code

        eCollectionLineArt_Flags

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__lineart_flags);
         CPointer<Byte> p_lineart_flags = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'lineart_flags'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__lineart_intersection_mask

        public static final long[] __DNA__FIELD__lineart_intersection_mask
        Field descriptor (offset) for struct member 'lineart_intersection_mask'.

        Field Documentation

        Blender Python API

        Intersection generated by this collection will have this mask value

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__lineart_intersection_mask);
         CPointer<Byte> p_lineart_intersection_mask = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'lineart_intersection_mask'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__lineart_intersection_priority

        public static final long[] __DNA__FIELD__lineart_intersection_priority
        Field descriptor (offset) for struct member 'lineart_intersection_priority'.

        Field Documentation

        Blender Python API

        The intersection line will be included into the object with the higher intersection priority value

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__lineart_intersection_priority);
         CPointer<Byte> p_lineart_intersection_priority = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'lineart_intersection_priority'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD___pad

        public static final long[] __DNA__FIELD___pad
        Field descriptor (offset) for struct member '_pad'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD___pad);
         CPointer<CArrayFacade<Byte>> p__pad = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad'
        • Signature: 'char[5]'
        • Actual Size (32bit/64bit): 5/5
      • __DNA__FIELD__color_tag

        public static final long[] __DNA__FIELD__color_tag
        Field descriptor (offset) for struct member 'color_tag'.

        Field Documentation

        Blender Python API

        Color tag for a collection

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__color_tag);
         CPointer<Short> p_color_tag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'color_tag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__object_cache

        public static final long[] __DNA__FIELD__object_cache
        Field descriptor (offset) for struct member 'object_cache'.

        Field Documentation

        Blender Source Code

        Runtime. Cache of objects in this collection and all its children. This is created on demand when e.g. some physics simulation needs it, we don't want to have it for every collections due to memory usage reasons.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__object_cache);
         CPointer<ListBase> p_object_cache = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'object_cache'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__object_cache_instanced

        public static final long[] __DNA__FIELD__object_cache_instanced
        Field descriptor (offset) for struct member 'object_cache_instanced'.

        Field Documentation

        Blender Source Code

        Need this for line art sub-collection selections.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__object_cache_instanced);
         CPointer<ListBase> p_object_cache_instanced = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'object_cache_instanced'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__parents

        public static final long[] __DNA__FIELD__parents
        Field descriptor (offset) for struct member 'parents'.

        Field Documentation

        Blender Source Code

        Runtime. List of collections that are a parent of this datablock.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__parents);
         CPointer<ListBase> p_parents = p.cast(new Class[]{ListBase.class});
         

        Metadata

        • Field: 'parents'
        • Signature: 'ListBase'
        • Actual Size (32bit/64bit): 8/16
      • __DNA__FIELD__collection

        public static final long[] __DNA__FIELD__collection
        Deprecated.
        Deprecated

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__collection);
         CPointer<CPointer<SceneCollection>> p_collection = p.cast(new Class[]{CPointer.class, SceneCollection.class});
         

        Metadata

        • Field: 'collection'
        • Signature: 'SceneCollection*'
        • Actual Size (32bit/64bit): 4/8
        Field descriptor (offset) for struct member 'collection'.

        Field Documentation

        Blender Source Code

        Deprecated

      • __DNA__FIELD__view_layer

        public static final long[] __DNA__FIELD__view_layer
        Deprecated.
        Deprecated

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         Collection collection = ...;
         CPointer<Object> p = collection.__dna__addressof(Collection.__DNA__FIELD__view_layer);
         CPointer<CPointer<ViewLayer>> p_view_layer = p.cast(new Class[]{CPointer.class, ViewLayer.class});
         

        Metadata

        • Field: 'view_layer'
        • Signature: 'ViewLayer*'
        • Actual Size (32bit/64bit): 4/8
        Field descriptor (offset) for struct member 'view_layer'.

        Field Documentation

        Blender Source Code

    • Constructor Detail

      • Collection

        public Collection​(long __address,
                          Block __block,
                          BlockTable __blockTable)
      • Collection

        protected Collection​(Collection that)
    • Method Detail

      • getId

        public ID getId()
                 throws java.io.IOException
        Get method for struct member 'id'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • setId

        public void setId​(ID id)
                   throws java.io.IOException
        Set method for struct member 'id'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__id
      • getGobject

        public ListBase getGobject()
                            throws java.io.IOException
        Get method for struct member 'gobject'.

        Field Documentation

        Blender Source Code

        CollectionObject .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__gobject
      • setGobject

        public void setGobject​(ListBase gobject)
                        throws java.io.IOException
        Set method for struct member 'gobject'.

        Field Documentation

        Blender Source Code

        CollectionObject .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__gobject
      • getChildren

        public ListBase getChildren()
                             throws java.io.IOException
        Get method for struct member 'children'.

        Field Documentation

        Blender Python API

        (read-only) Collections that are immediate children of this collection

        Blender Source Code

        CollectionChild .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__children
      • setChildren

        public void setChildren​(ListBase children)
                         throws java.io.IOException
        Set method for struct member 'children'.

        Field Documentation

        Blender Python API

        (read-only) Collections that are immediate children of this collection

        Blender Source Code

        CollectionChild .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__children
      • getLayer

        public int getLayer()
                     throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'layer'.

        Field Documentation

        Blender Source Code

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layer
      • setLayer

        public void setLayer​(int layer)
                      throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'layer'.

        Field Documentation

        Blender Source Code

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layer
      • getDupli_ofs

        public CArrayFacade<java.lang.Float> getDupli_ofs()
                                                   throws java.io.IOException
        Get method for struct member 'dupli_ofs'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dupli_ofs
      • setDupli_ofs

        public void setDupli_ofs​(CArrayFacade<java.lang.Float> dupli_ofs)
                          throws java.io.IOException
        Set method for struct member 'dupli_ofs'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dupli_ofs
      • getFlag

        public short getFlag()
                      throws java.io.IOException
        Get method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(short flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getTag

        public short getTag()
                     throws java.io.IOException
        Get method for struct member 'tag'.

        Field Documentation

        Blender Source Code

        Runtime-only, always cleared on file load.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tag
      • setTag

        public void setTag​(short tag)
                    throws java.io.IOException
        Set method for struct member 'tag'.

        Field Documentation

        Blender Source Code

        Runtime-only, always cleared on file load.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tag
      • getLineart_usage

        public short getLineart_usage()
                               throws java.io.IOException
        Get method for struct member 'lineart_usage'.

        Field Documentation

        Blender Python API

        How to use this collection in line art

        Blender Source Code

        eCollectionLineArt_Usage

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_usage
      • setLineart_usage

        public void setLineart_usage​(short lineart_usage)
                              throws java.io.IOException
        Set method for struct member 'lineart_usage'.

        Field Documentation

        Blender Python API

        How to use this collection in line art

        Blender Source Code

        eCollectionLineArt_Usage

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_usage
      • getLineart_flags

        public byte getLineart_flags()
                              throws java.io.IOException
        Get method for struct member 'lineart_flags'.

        Field Documentation

        Blender Source Code

        eCollectionLineArt_Flags

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_flags
      • setLineart_flags

        public void setLineart_flags​(byte lineart_flags)
                              throws java.io.IOException
        Set method for struct member 'lineart_flags'.

        Field Documentation

        Blender Source Code

        eCollectionLineArt_Flags

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_flags
      • getLineart_intersection_mask

        public byte getLineart_intersection_mask()
                                          throws java.io.IOException
        Get method for struct member 'lineart_intersection_mask'.

        Field Documentation

        Blender Python API

        Intersection generated by this collection will have this mask value
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_intersection_mask
      • setLineart_intersection_mask

        public void setLineart_intersection_mask​(byte lineart_intersection_mask)
                                          throws java.io.IOException
        Set method for struct member 'lineart_intersection_mask'.

        Field Documentation

        Blender Python API

        Intersection generated by this collection will have this mask value
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_intersection_mask
      • getLineart_intersection_priority

        public byte getLineart_intersection_priority()
                                              throws java.io.IOException
        Get method for struct member 'lineart_intersection_priority'.

        Field Documentation

        Blender Python API

        The intersection line will be included into the object with the higher intersection priority value
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_intersection_priority
      • setLineart_intersection_priority

        public void setLineart_intersection_priority​(byte lineart_intersection_priority)
                                              throws java.io.IOException
        Set method for struct member 'lineart_intersection_priority'.

        Field Documentation

        Blender Python API

        The intersection line will be included into the object with the higher intersection priority value
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lineart_intersection_priority
      • get_pad

        public CArrayFacade<java.lang.Byte> get_pad()
                                             throws java.io.IOException
        Get method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • set_pad

        public void set_pad​(CArrayFacade<java.lang.Byte> _pad)
                     throws java.io.IOException
        Set method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • getColor_tag

        public short getColor_tag()
                           throws java.io.IOException
        Get method for struct member 'color_tag'.

        Field Documentation

        Blender Python API

        Color tag for a collection
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__color_tag
      • setColor_tag

        public void setColor_tag​(short color_tag)
                          throws java.io.IOException
        Set method for struct member 'color_tag'.

        Field Documentation

        Blender Python API

        Color tag for a collection
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__color_tag
      • getObject_cache

        public ListBase getObject_cache()
                                 throws java.io.IOException
        Get method for struct member 'object_cache'.

        Field Documentation

        Blender Source Code

        Runtime. Cache of objects in this collection and all its children. This is created on demand when e.g. some physics simulation needs it, we don't want to have it for every collections due to memory usage reasons.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_cache
      • setObject_cache

        public void setObject_cache​(ListBase object_cache)
                             throws java.io.IOException
        Set method for struct member 'object_cache'.

        Field Documentation

        Blender Source Code

        Runtime. Cache of objects in this collection and all its children. This is created on demand when e.g. some physics simulation needs it, we don't want to have it for every collections due to memory usage reasons.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_cache
      • getObject_cache_instanced

        public ListBase getObject_cache_instanced()
                                           throws java.io.IOException
        Get method for struct member 'object_cache_instanced'.

        Field Documentation

        Blender Source Code

        Need this for line art sub-collection selections.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_cache_instanced
      • setObject_cache_instanced

        public void setObject_cache_instanced​(ListBase object_cache_instanced)
                                       throws java.io.IOException
        Set method for struct member 'object_cache_instanced'.

        Field Documentation

        Blender Source Code

        Need this for line art sub-collection selections.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_cache_instanced
      • getParents

        public ListBase getParents()
                            throws java.io.IOException
        Get method for struct member 'parents'.

        Field Documentation

        Blender Source Code

        Runtime. List of collections that are a parent of this datablock.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__parents
      • setParents

        public void setParents​(ListBase parents)
                        throws java.io.IOException
        Set method for struct member 'parents'.

        Field Documentation

        Blender Source Code

        Runtime. List of collections that are a parent of this datablock.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__parents
      • getCollection

        public CPointer<SceneCollection> getCollection()
                                                throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'collection'.

        Field Documentation

        Blender Source Code

        Deprecated

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__collection
      • setCollection

        public void setCollection​(CPointer<SceneCollection> collection)
                           throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'collection'.

        Field Documentation

        Blender Source Code

        Deprecated

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__collection
      • getView_layer

        public CPointer<ViewLayer> getView_layer()
                                          throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'view_layer'.

        Field Documentation

        Blender Source Code

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view_layer
      • setView_layer

        public void setView_layer​(CPointer<ViewLayer> view_layer)
                           throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'view_layer'.

        Field Documentation

        Blender Source Code

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view_layer
      • __io__addressof

        public CPointer<Collection> __io__addressof()
        Instantiates a pointer on this instance.