Class CustomDataLayer


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

    Class Documentation

    Java .Blend

    Object describing referenced custom data

    Blender Source Code

    Descriptor and storage for a custom data layer.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Java .Blend

        Values:

                CD_AUTO_FROM_NAME   = -1,
         
                CD_MVERT            = 0,
                CD_MSTICKY          = 1,  // DEPRECATED 
                CD_MDEFORMVERT      = 2,
                CD_MEDGE            = 3,
                CD_MFACE            = 4,
                CD_MTFACE           = 5,
                CD_MCOL             = 6,
                CD_ORIGINDEX        = 7,
                CD_NORMAL           = 8,
         //     CD_POLYINDEX        = 9, 
                CD_PROP_FLT         = 10,
                CD_PROP_INT         = 11,
                CD_PROP_STR         = 12,
                CD_ORIGSPACE        = 13,  // for modifier stack face location mapping 
                CD_ORCO             = 14,
                CD_MTEXPOLY         = 15,
                CD_MLOOPUV          = 16,
                CD_MLOOPCOL         = 17,
                CD_TANGENT          = 18,
                CD_MDISPS           = 19,
                CD_PREVIEW_MCOL     = 20,  // for displaying weightpaint colors
         //     CD_ID_MCOL          = 21, 
                CD_TEXTURE_MLOOPCOL = 22,
                CD_CLOTH_ORCO       = 23,
                CD_RECAST           = 24,
         
         // BMESH ONLY START
                CD_MPOLY            = 25,
                CD_MLOOP            = 26,
                CD_SHAPE_KEYINDEX   = 27,
                CD_SHAPEKEY         = 28,
                CD_BWEIGHT          = 29,
                CD_CREASE           = 30,
                CD_ORIGSPACE_MLOOP  = 31,
                CD_PREVIEW_MLOOPCOL = 32,
                CD_BM_ELEM_PYPTR    = 33,
         // BMESH ONLY END 
         
                CD_PAINT_MASK       = 34,
                CD_GRID_PAINT_MASK  = 35,
                CD_MVERT_SKIN       = 36,
                CD_FREESTYLE_EDGE   = 37,
                CD_FREESTYLE_FACE   = 38,
                CD_MLOOPTANGENT     = 39,
                CD_TESSLOOPNORMAL   = 40,
                CD_CUSTOMLOOPNORMAL = 41,
         
                CD_NUMTYPES         = 42
                                        

        Blender Source Code

        Type of data in layer.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__type);
         CPointer<Integer> p_type = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'type'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__offset

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

        Field Documentation

        Blender Source Code

        In editmode, offset of layer in block.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__offset);
         CPointer<Integer> p_offset = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'offset'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__flag

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

        Field Documentation

        Java .Blend

        Values:

                // Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data 
                CD_FLAG_NOCOPY    = (1 << 0),
                // Indicates layer should not be freed (for layers backed by external data) 
                CD_FLAG_NOFREE    = (1 << 1),
                // Indicates the layer is only temporary, also implies no copy 
                CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
                // Indicates the layer is stored in an external file 
                CD_FLAG_EXTERNAL  = (1 << 3),
                // Indicates external data is read into memory 
                CD_FLAG_IN_MEMORY = (1 << 4),
                                        

        Blender Source Code

        General purpose flag.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__flag);
         CPointer<Integer> p_flag = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__active

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

        Field Documentation

        Blender Source Code

        Number of the active layer of this type.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__active);
         CPointer<Integer> p_active = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__active_rnd

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

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__active_rnd);
         CPointer<Integer> p_active_rnd = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active_rnd'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__active_clone

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

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__active_clone);
         CPointer<Integer> p_active_clone = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active_clone'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__active_mask

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

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__active_mask);
         CPointer<Integer> p_active_mask = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'active_mask'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__uid

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

        Field Documentation

        Blender Source Code

        Shape keyblock unique id reference.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__uid);
         CPointer<Integer> p_uid = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'uid'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__name

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

        Field Documentation

        Blender Source Code

        Layer name, MAX_CUSTOMDATA_LAYER_NAME.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__name);
         CPointer<CArrayFacade<Byte>> p_name = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: 'name'
        • Signature: 'char[64]'
        • Actual Size (32bit/64bit): 64/64
      • __DNA__FIELD__data

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

        Field Documentation

        Java .Blend

        Pointer on the actual data referenced by this data layer.

        Blender Source Code

        Layer data.

        Pointer Arithmetics

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

         CustomDataLayer customdatalayer = ...;
         CPointer<Object> p = customdatalayer.__dna__addressof(CustomDataLayer.__DNA__FIELD__data);
         CPointer<CPointer<Object>> p_data = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'data'
        • Signature: 'void*'
        • Actual Size (32bit/64bit): 4/8
    • Constructor Detail

      • CustomDataLayer

        public CustomDataLayer​(long __address,
                               Block __block,
                               BlockTable __blockTable)
    • Method Detail

      • getType

        public int getType()
                    throws java.io.IOException
        Get method for struct member 'type'.

        Field Documentation

        Java .Blend

        Values:

                CD_AUTO_FROM_NAME   = -1,
         
                CD_MVERT            = 0,
                CD_MSTICKY          = 1,  // DEPRECATED 
                CD_MDEFORMVERT      = 2,
                CD_MEDGE            = 3,
                CD_MFACE            = 4,
                CD_MTFACE           = 5,
                CD_MCOL             = 6,
                CD_ORIGINDEX        = 7,
                CD_NORMAL           = 8,
         //     CD_POLYINDEX        = 9, 
                CD_PROP_FLT         = 10,
                CD_PROP_INT         = 11,
                CD_PROP_STR         = 12,
                CD_ORIGSPACE        = 13,  // for modifier stack face location mapping 
                CD_ORCO             = 14,
                CD_MTEXPOLY         = 15,
                CD_MLOOPUV          = 16,
                CD_MLOOPCOL         = 17,
                CD_TANGENT          = 18,
                CD_MDISPS           = 19,
                CD_PREVIEW_MCOL     = 20,  // for displaying weightpaint colors
         //     CD_ID_MCOL          = 21, 
                CD_TEXTURE_MLOOPCOL = 22,
                CD_CLOTH_ORCO       = 23,
                CD_RECAST           = 24,
         
         // BMESH ONLY START
                CD_MPOLY            = 25,
                CD_MLOOP            = 26,
                CD_SHAPE_KEYINDEX   = 27,
                CD_SHAPEKEY         = 28,
                CD_BWEIGHT          = 29,
                CD_CREASE           = 30,
                CD_ORIGSPACE_MLOOP  = 31,
                CD_PREVIEW_MLOOPCOL = 32,
                CD_BM_ELEM_PYPTR    = 33,
         // BMESH ONLY END 
         
                CD_PAINT_MASK       = 34,
                CD_GRID_PAINT_MASK  = 35,
                CD_MVERT_SKIN       = 36,
                CD_FREESTYLE_EDGE   = 37,
                CD_FREESTYLE_FACE   = 38,
                CD_MLOOPTANGENT     = 39,
                CD_TESSLOOPNORMAL   = 40,
                CD_CUSTOMLOOPNORMAL = 41,
         
                CD_NUMTYPES         = 42
                                        

        Blender Source Code

        Type of data in layer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__type
      • setType

        public void setType​(int type)
                     throws java.io.IOException
        Set method for struct member 'type'.

        Field Documentation

        Java .Blend

        Values:

                CD_AUTO_FROM_NAME   = -1,
         
                CD_MVERT            = 0,
                CD_MSTICKY          = 1,  // DEPRECATED 
                CD_MDEFORMVERT      = 2,
                CD_MEDGE            = 3,
                CD_MFACE            = 4,
                CD_MTFACE           = 5,
                CD_MCOL             = 6,
                CD_ORIGINDEX        = 7,
                CD_NORMAL           = 8,
         //     CD_POLYINDEX        = 9, 
                CD_PROP_FLT         = 10,
                CD_PROP_INT         = 11,
                CD_PROP_STR         = 12,
                CD_ORIGSPACE        = 13,  // for modifier stack face location mapping 
                CD_ORCO             = 14,
                CD_MTEXPOLY         = 15,
                CD_MLOOPUV          = 16,
                CD_MLOOPCOL         = 17,
                CD_TANGENT          = 18,
                CD_MDISPS           = 19,
                CD_PREVIEW_MCOL     = 20,  // for displaying weightpaint colors
         //     CD_ID_MCOL          = 21, 
                CD_TEXTURE_MLOOPCOL = 22,
                CD_CLOTH_ORCO       = 23,
                CD_RECAST           = 24,
         
         // BMESH ONLY START
                CD_MPOLY            = 25,
                CD_MLOOP            = 26,
                CD_SHAPE_KEYINDEX   = 27,
                CD_SHAPEKEY         = 28,
                CD_BWEIGHT          = 29,
                CD_CREASE           = 30,
                CD_ORIGSPACE_MLOOP  = 31,
                CD_PREVIEW_MLOOPCOL = 32,
                CD_BM_ELEM_PYPTR    = 33,
         // BMESH ONLY END 
         
                CD_PAINT_MASK       = 34,
                CD_GRID_PAINT_MASK  = 35,
                CD_MVERT_SKIN       = 36,
                CD_FREESTYLE_EDGE   = 37,
                CD_FREESTYLE_FACE   = 38,
                CD_MLOOPTANGENT     = 39,
                CD_TESSLOOPNORMAL   = 40,
                CD_CUSTOMLOOPNORMAL = 41,
         
                CD_NUMTYPES         = 42
                                        

        Blender Source Code

        Type of data in layer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__type
      • getOffset

        public int getOffset()
                      throws java.io.IOException
        Get method for struct member 'offset'.

        Field Documentation

        Blender Source Code

        In editmode, offset of layer in block.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__offset
      • setOffset

        public void setOffset​(int offset)
                       throws java.io.IOException
        Set method for struct member 'offset'.

        Field Documentation

        Blender Source Code

        In editmode, offset of layer in block.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__offset
      • getFlag

        public int getFlag()
                    throws java.io.IOException
        Get method for struct member 'flag'.

        Field Documentation

        Java .Blend

        Values:

                // Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data 
                CD_FLAG_NOCOPY    = (1 << 0),
                // Indicates layer should not be freed (for layers backed by external data) 
                CD_FLAG_NOFREE    = (1 << 1),
                // Indicates the layer is only temporary, also implies no copy 
                CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
                // Indicates the layer is stored in an external file 
                CD_FLAG_EXTERNAL  = (1 << 3),
                // Indicates external data is read into memory 
                CD_FLAG_IN_MEMORY = (1 << 4),
                                        

        Blender Source Code

        General purpose flag.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(int flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.

        Field Documentation

        Java .Blend

        Values:

                // Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data 
                CD_FLAG_NOCOPY    = (1 << 0),
                // Indicates layer should not be freed (for layers backed by external data) 
                CD_FLAG_NOFREE    = (1 << 1),
                // Indicates the layer is only temporary, also implies no copy 
                CD_FLAG_TEMPORARY = ((1 << 2) | CD_FLAG_NOCOPY),
                // Indicates the layer is stored in an external file 
                CD_FLAG_EXTERNAL  = (1 << 3),
                // Indicates external data is read into memory 
                CD_FLAG_IN_MEMORY = (1 << 4),
                                        

        Blender Source Code

        General purpose flag.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getActive

        public int getActive()
                      throws java.io.IOException
        Get method for struct member 'active'.

        Field Documentation

        Blender Source Code

        Number of the active layer of this type.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active
      • setActive

        public void setActive​(int active)
                       throws java.io.IOException
        Set method for struct member 'active'.

        Field Documentation

        Blender Source Code

        Number of the active layer of this type.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active
      • getActive_rnd

        public int getActive_rnd()
                          throws java.io.IOException
        Get method for struct member 'active_rnd'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_rnd
      • setActive_rnd

        public void setActive_rnd​(int active_rnd)
                           throws java.io.IOException
        Set method for struct member 'active_rnd'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_rnd
      • getActive_clone

        public int getActive_clone()
                            throws java.io.IOException
        Get method for struct member 'active_clone'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_clone
      • setActive_clone

        public void setActive_clone​(int active_clone)
                             throws java.io.IOException
        Set method for struct member 'active_clone'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_clone
      • getActive_mask

        public int getActive_mask()
                           throws java.io.IOException
        Get method for struct member 'active_mask'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_mask
      • setActive_mask

        public void setActive_mask​(int active_mask)
                            throws java.io.IOException
        Set method for struct member 'active_mask'.

        Field Documentation

        Blender Source Code

        Number of the layer to render.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_mask
      • getUid

        public int getUid()
                   throws java.io.IOException
        Get method for struct member 'uid'.

        Field Documentation

        Blender Source Code

        Shape keyblock unique id reference.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__uid
      • setUid

        public void setUid​(int uid)
                    throws java.io.IOException
        Set method for struct member 'uid'.

        Field Documentation

        Blender Source Code

        Shape keyblock unique id reference.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__uid
      • getName

        public CArrayFacade<java.lang.Byte> getName()
                                             throws java.io.IOException
        Get method for struct member 'name'.

        Field Documentation

        Blender Source Code

        Layer name, MAX_CUSTOMDATA_LAYER_NAME.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__name
      • setName

        public void setName​(CArrayFacade<java.lang.Byte> name)
                     throws java.io.IOException
        Set method for struct member 'name'.

        Field Documentation

        Blender Source Code

        Layer name, MAX_CUSTOMDATA_LAYER_NAME.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__name
      • getData

        public CPointer<java.lang.Object> getData()
                                           throws java.io.IOException
        Get method for struct member 'data'.

        Field Documentation

        Java .Blend

        Pointer on the actual data referenced by this data layer.

        Blender Source Code

        Layer data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__data
      • setData

        public void setData​(CPointer<java.lang.Object> data)
                     throws java.io.IOException
        Set method for struct member 'data'.

        Field Documentation

        Java .Blend

        Pointer on the actual data referenced by this data layer.

        Blender Source Code

        Layer data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__data