Class AssetMetaData


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

    Class Documentation

    Blender Source Code

    The meta-data of an asset. By creating and giving this for a data-block (ID.getAsset_data() ), the data-block becomes an asset.

    Note

    This struct must be readable without having to read anything but blocks from the ID it is attached to! That way, asset information of a file can be read, without reading anything more than that from the file. So pointers to other IDs or ID data are strictly forbidden.

    This struct must be readable without having to read anything but blocks from the ID it is attached to! That way, asset information of a file can be read, without reading anything more than that from the file. So pointers to other IDs or ID data are strictly forbidden.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Source Code

        Runtime type, to reference event callbacks. Only valid for local assets.

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__local_type_info);
         CPointer<CPointer<Object>> p_local_type_info = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'local_type_info'
        • Signature: 'AssetTypeInfo*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__properties

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

        Field Documentation

        Blender Source Code

        Custom asset meta-data. Cannot store pointers to IDs (#STRUCT_NO_DATABLOCK_IDPROPERTIES)!

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__properties);
         CPointer<CPointer<IDProperty>> p_properties = p.cast(new Class[]{CPointer.class, IDProperty.class});
         

        Metadata

        • Field: 'properties'
        • Signature: 'IDProperty*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__catalog_id

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

        Field Documentation

        Blender Python API

        Identifier for the asset's catalog, used by Blender to look up the asset's catalog path. Must be a UUID according to RFC4122

        Blender Source Code

        Asset Catalog identifier. Should not contain spaces. Mapped to a path in the asset catalog hierarchy by an #AssetCatalogService. Use #BKE_asset_metadata_catalog_id_set() to ensure a valid ID is set.

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__catalog_id);
         CPointer<bUUID> p_catalog_id = p.cast(new Class[]{bUUID.class});
         

        Metadata

        • Field: 'catalog_id'
        • Signature: 'bUUID'
        • Actual Size (32bit/64bit): 16/16
      • __DNA__FIELD__catalog_simple_name

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

        Field Documentation

        Blender Python API

        (read-only) Simple name of the asset's catalog, for debugging and data recovery purposes

        Blender Source Code

        Short name of the asset's catalog. This is for debugging purposes only, to allow (partial) reconstruction of asset catalogs in the unfortunate case that the mapping from catalog UUID to catalog path is lost. The catalog's simple name is copied to getCatalog_simple_name() whenever getCatalog_id() is updated. MAX_NAME

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__catalog_simple_name);
         CPointer<CArrayFacade<Byte>> p_catalog_simple_name = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        Name of the creator of the asset

        Blender Source Code

        Optional name of the author for display in the UI. Dynamic length.

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__author);
         CPointer<CPointer<Byte>> p_author = p.cast(new Class[]{CPointer.class, Byte.class});
         

        Metadata

        • Field: 'author'
        • Signature: 'char*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__description

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

        Field Documentation

        Blender Python API

        A description of the asset to be displayed for the user

        Blender Source Code

        Optional description of this asset for display in the UI. Dynamic length.

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__description);
         CPointer<CPointer<Byte>> p_description = p.cast(new Class[]{CPointer.class, Byte.class});
         

        Metadata

        • Field: 'description'
        • Signature: 'char*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__tags

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

        Field Documentation

        Blender Python API

        (read-only) Custom tags (name tokens) for the asset, used for filtering and general asset management

        Blender Source Code

        User defined tags for this asset. The asset manager uses these for filtering, but how they function exactly (e.g. how they are registered to provide a list of searchable available tags) is up to the asset-engine. AssetTag

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__tags);
         CPointer<ListBase> p_tags = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        Index of the tag set for editing

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__active_tag);
         CPointer<Short> p_active_tag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'active_tag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__tot_tags

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

        Field Documentation

        Blender Source Code

        Store the number of tags to avoid continuous counting. Could be turned into runtime data, we can always reliably reconstruct it from the list.

        Pointer Arithmetics

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

         AssetMetaData assetmetadata = ...;
         CPointer<Object> p = assetmetadata.__dna__addressof(AssetMetaData.__DNA__FIELD__tot_tags);
         CPointer<Short> p_tot_tags = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'tot_tags'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __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:

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

        Metadata

        • Field: '_pad'
        • Signature: 'char[4]'
        • Actual Size (32bit/64bit): 4/4
    • Constructor Detail

      • AssetMetaData

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

      • getLocal_type_info

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

        Field Documentation

        Blender Source Code

        Runtime type, to reference event callbacks. Only valid for local assets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__local_type_info
      • setLocal_type_info

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

        Field Documentation

        Blender Source Code

        Runtime type, to reference event callbacks. Only valid for local assets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__local_type_info
      • getProperties

        public CPointer<IDProperty> getProperties()
                                           throws java.io.IOException
        Get method for struct member 'properties'.

        Field Documentation

        Blender Source Code

        Custom asset meta-data. Cannot store pointers to IDs (#STRUCT_NO_DATABLOCK_IDPROPERTIES)!

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__properties
      • setProperties

        public void setProperties​(CPointer<IDProperty> properties)
                           throws java.io.IOException
        Set method for struct member 'properties'.

        Field Documentation

        Blender Source Code

        Custom asset meta-data. Cannot store pointers to IDs (#STRUCT_NO_DATABLOCK_IDPROPERTIES)!

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__properties
      • getCatalog_id

        public bUUID getCatalog_id()
                            throws java.io.IOException
        Get method for struct member 'catalog_id'.

        Field Documentation

        Blender Python API

        Identifier for the asset's catalog, used by Blender to look up the asset's catalog path. Must be a UUID according to RFC4122

        Blender Source Code

        Asset Catalog identifier. Should not contain spaces. Mapped to a path in the asset catalog hierarchy by an #AssetCatalogService. Use #BKE_asset_metadata_catalog_id_set() to ensure a valid ID is set.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__catalog_id
      • setCatalog_id

        public void setCatalog_id​(bUUID catalog_id)
                           throws java.io.IOException
        Set method for struct member 'catalog_id'.

        Field Documentation

        Blender Python API

        Identifier for the asset's catalog, used by Blender to look up the asset's catalog path. Must be a UUID according to RFC4122

        Blender Source Code

        Asset Catalog identifier. Should not contain spaces. Mapped to a path in the asset catalog hierarchy by an #AssetCatalogService. Use #BKE_asset_metadata_catalog_id_set() to ensure a valid ID is set.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__catalog_id
      • getCatalog_simple_name

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

        Field Documentation

        Blender Python API

        (read-only) Simple name of the asset's catalog, for debugging and data recovery purposes

        Blender Source Code

        Short name of the asset's catalog. This is for debugging purposes only, to allow (partial) reconstruction of asset catalogs in the unfortunate case that the mapping from catalog UUID to catalog path is lost. The catalog's simple name is copied to getCatalog_simple_name() whenever getCatalog_id() is updated. MAX_NAME

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__catalog_simple_name
      • setCatalog_simple_name

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

        Field Documentation

        Blender Python API

        (read-only) Simple name of the asset's catalog, for debugging and data recovery purposes

        Blender Source Code

        Short name of the asset's catalog. This is for debugging purposes only, to allow (partial) reconstruction of asset catalogs in the unfortunate case that the mapping from catalog UUID to catalog path is lost. The catalog's simple name is copied to getCatalog_simple_name() whenever getCatalog_id() is updated. MAX_NAME

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__catalog_simple_name
      • getAuthor

        public CPointer<java.lang.Byte> getAuthor()
                                           throws java.io.IOException
        Get method for struct member 'author'.

        Field Documentation

        Blender Python API

        Name of the creator of the asset

        Blender Source Code

        Optional name of the author for display in the UI. Dynamic length.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__author
      • setAuthor

        public void setAuthor​(CPointer<java.lang.Byte> author)
                       throws java.io.IOException
        Set method for struct member 'author'.

        Field Documentation

        Blender Python API

        Name of the creator of the asset

        Blender Source Code

        Optional name of the author for display in the UI. Dynamic length.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__author
      • getDescription

        public CPointer<java.lang.Byte> getDescription()
                                                throws java.io.IOException
        Get method for struct member 'description'.

        Field Documentation

        Blender Python API

        A description of the asset to be displayed for the user

        Blender Source Code

        Optional description of this asset for display in the UI. Dynamic length.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • setDescription

        public void setDescription​(CPointer<java.lang.Byte> description)
                            throws java.io.IOException
        Set method for struct member 'description'.

        Field Documentation

        Blender Python API

        A description of the asset to be displayed for the user

        Blender Source Code

        Optional description of this asset for display in the UI. Dynamic length.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • getTags

        public ListBase getTags()
                         throws java.io.IOException
        Get method for struct member 'tags'.

        Field Documentation

        Blender Python API

        (read-only) Custom tags (name tokens) for the asset, used for filtering and general asset management

        Blender Source Code

        User defined tags for this asset. The asset manager uses these for filtering, but how they function exactly (e.g. how they are registered to provide a list of searchable available tags) is up to the asset-engine. AssetTag

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tags
      • setTags

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

        Field Documentation

        Blender Python API

        (read-only) Custom tags (name tokens) for the asset, used for filtering and general asset management

        Blender Source Code

        User defined tags for this asset. The asset manager uses these for filtering, but how they function exactly (e.g. how they are registered to provide a list of searchable available tags) is up to the asset-engine. AssetTag

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tags
      • getActive_tag

        public short getActive_tag()
                            throws java.io.IOException
        Get method for struct member 'active_tag'.

        Field Documentation

        Blender Python API

        Index of the tag set for editing
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_tag
      • setActive_tag

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

        Field Documentation

        Blender Python API

        Index of the tag set for editing
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__active_tag
      • getTot_tags

        public short getTot_tags()
                          throws java.io.IOException
        Get method for struct member 'tot_tags'.

        Field Documentation

        Blender Source Code

        Store the number of tags to avoid continuous counting. Could be turned into runtime data, we can always reliably reconstruct it from the list.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tot_tags
      • setTot_tags

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

        Field Documentation

        Blender Source Code

        Store the number of tags to avoid continuous counting. Could be turned into runtime data, we can always reliably reconstruct it from the list.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tot_tags
      • 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
      • __io__addressof

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