Class WorkSpace


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

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__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__layouts

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

        Field Documentation

        Blender Source Code

        WorkSpaceLayout .

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__layouts);
         CPointer<ListBase> p_layouts = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Store for each hook (so for each window) which layout has been activated the last time this workspace was visible. WorkSpaceDataRelation .

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__hook_layout_relations);
         CPointer<ListBase> p_hook_layout_relations = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        Feature tagging (use for addons) wmOwnerID .

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__owner_ids);
         CPointer<ListBase> p_owner_ids = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        List of bToolRef

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__tools);
         CPointer<ListBase> p_tools = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Optional, scene to switch to when enabling this workspace (NULL to disable). Cleared on link/append.

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__pin_scene);
         CPointer<CPointer<Scene>> p_pin_scene = p.cast(new Class[]{CPointer.class, Scene.class});
         

        Metadata

        • Field: 'pin_scene'
        • Signature: 'Scene*'
        • Actual Size (32bit/64bit): 4/8
      • __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:

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__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
      • __DNA__FIELD__object_mode

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

        Field Documentation

        Blender Python API

        Switch to this object mode when activating the workspace

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__object_mode);
         CPointer<Integer> p_object_mode = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'object_mode'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__flags

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

        Field Documentation

        Blender Source Code

        Enum eWorkSpaceFlags.

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__flags);
         CPointer<Integer> p_flags = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'flags'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__order

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

        Field Documentation

        Blender Source Code

        Number for workspace tab reordering in the UI.

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__order);
         CPointer<Integer> p_order = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'order'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__status_text

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

        Field Documentation

        Blender Source Code

        Info text from modal operators (runtime).

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__status_text);
         CPointer<CPointer<Byte>> p_status_text = p.cast(new Class[]{CPointer.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Python API

        Active asset library to show in the UI, not used by the Asset Browser (which has its own active asset library)

        Blender Source Code

        Workspace-wide active asset library, for asset UIs to use (e.g. asset view UI template). The Asset Browser has its own and doesn't use this.

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__asset_library_ref);
         CPointer<AssetLibraryReference> p_asset_library_ref = p.cast(new Class[]{AssetLibraryReference.class});
         

        Metadata

        • Field: 'asset_library_ref'
        • Signature: 'AssetLibraryReference'
        • Actual Size (32bit/64bit): 8/8
      • __DNA__FIELD__viewer_path

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

        Field Documentation

        Blender Source Code

        Ground truth for the currently active viewer node. When a viewer node is activated its path is set here. Editors can check here for which node is active (currently the node editor, spreadsheet and viewport do this).

        Pointer Arithmetics

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

         WorkSpace workspace = ...;
         CPointer<Object> p = workspace.__dna__addressof(WorkSpace.__DNA__FIELD__viewer_path);
         CPointer<ViewerPath> p_viewer_path = p.cast(new Class[]{ViewerPath.class});
         

        Metadata

        • Field: 'viewer_path'
        • Signature: 'ViewerPath'
        • Actual Size (32bit/64bit): 8/16
    • Constructor Detail

      • WorkSpace

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

        protected WorkSpace​(WorkSpace 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
      • getLayouts

        public ListBase getLayouts()
                            throws java.io.IOException
        Get method for struct member 'layouts'.

        Field Documentation

        Blender Source Code

        WorkSpaceLayout .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layouts
      • setLayouts

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

        Field Documentation

        Blender Source Code

        WorkSpaceLayout .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layouts
      • getHook_layout_relations

        public ListBase getHook_layout_relations()
                                          throws java.io.IOException
        Get method for struct member 'hook_layout_relations'.

        Field Documentation

        Blender Source Code

        Store for each hook (so for each window) which layout has been activated the last time this workspace was visible. WorkSpaceDataRelation .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hook_layout_relations
      • setHook_layout_relations

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

        Field Documentation

        Blender Source Code

        Store for each hook (so for each window) which layout has been activated the last time this workspace was visible. WorkSpaceDataRelation .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hook_layout_relations
      • getOwner_ids

        public ListBase getOwner_ids()
                              throws java.io.IOException
        Get method for struct member 'owner_ids'.

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        Feature tagging (use for addons) wmOwnerID .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__owner_ids
      • setOwner_ids

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

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        Feature tagging (use for addons) wmOwnerID .

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__owner_ids
      • getTools

        public ListBase getTools()
                          throws java.io.IOException
        Get method for struct member 'tools'.

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        List of bToolRef

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tools
      • setTools

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

        Field Documentation

        Blender Python API

        (read-only)

        Blender Source Code

        List of bToolRef

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tools
      • getPin_scene

        public CPointer<Scene> getPin_scene()
                                     throws java.io.IOException
        Get method for struct member 'pin_scene'.

        Field Documentation

        Blender Source Code

        Optional, scene to switch to when enabling this workspace (NULL to disable). Cleared on link/append.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__pin_scene
      • setPin_scene

        public void setPin_scene​(CPointer<Scene> pin_scene)
                          throws java.io.IOException
        Set method for struct member 'pin_scene'.

        Field Documentation

        Blender Source Code

        Optional, scene to switch to when enabling this workspace (NULL to disable). Cleared on link/append.

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

        public int getObject_mode()
                           throws java.io.IOException
        Get method for struct member 'object_mode'.

        Field Documentation

        Blender Python API

        Switch to this object mode when activating the workspace
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_mode
      • setObject_mode

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

        Field Documentation

        Blender Python API

        Switch to this object mode when activating the workspace
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__object_mode
      • getFlags

        public int getFlags()
                     throws java.io.IOException
        Get method for struct member 'flags'.

        Field Documentation

        Blender Source Code

        Enum eWorkSpaceFlags.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flags
      • setFlags

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

        Field Documentation

        Blender Source Code

        Enum eWorkSpaceFlags.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flags
      • getOrder

        public int getOrder()
                     throws java.io.IOException
        Get method for struct member 'order'.

        Field Documentation

        Blender Source Code

        Number for workspace tab reordering in the UI.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__order
      • setOrder

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

        Field Documentation

        Blender Source Code

        Number for workspace tab reordering in the UI.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__order
      • getStatus_text

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

        Field Documentation

        Blender Source Code

        Info text from modal operators (runtime).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__status_text
      • setStatus_text

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

        Field Documentation

        Blender Source Code

        Info text from modal operators (runtime).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__status_text
      • getAsset_library_ref

        public AssetLibraryReference getAsset_library_ref()
                                                   throws java.io.IOException
        Get method for struct member 'asset_library_ref'.

        Field Documentation

        Blender Python API

        Active asset library to show in the UI, not used by the Asset Browser (which has its own active asset library)

        Blender Source Code

        Workspace-wide active asset library, for asset UIs to use (e.g. asset view UI template). The Asset Browser has its own and doesn't use this.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__asset_library_ref
      • setAsset_library_ref

        public void setAsset_library_ref​(AssetLibraryReference asset_library_ref)
                                  throws java.io.IOException
        Set method for struct member 'asset_library_ref'.

        Field Documentation

        Blender Python API

        Active asset library to show in the UI, not used by the Asset Browser (which has its own active asset library)

        Blender Source Code

        Workspace-wide active asset library, for asset UIs to use (e.g. asset view UI template). The Asset Browser has its own and doesn't use this.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__asset_library_ref
      • getViewer_path

        public ViewerPath getViewer_path()
                                  throws java.io.IOException
        Get method for struct member 'viewer_path'.

        Field Documentation

        Blender Source Code

        Ground truth for the currently active viewer node. When a viewer node is activated its path is set here. Editors can check here for which node is active (currently the node editor, spreadsheet and viewport do this).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__viewer_path
      • setViewer_path

        public void setViewer_path​(ViewerPath viewer_path)
                            throws java.io.IOException
        Set method for struct member 'viewer_path'.

        Field Documentation

        Blender Source Code

        Ground truth for the currently active viewer node. When a viewer node is activated its path is set here. Editors can check here for which node is active (currently the node editor, spreadsheet and viewport do this).

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

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