Class bToolRef


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

    Class Documentation

    Blender Source Code

    Note

    Stored per mode.

    Stored per mode.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__next);
         CPointer<CPointer<bToolRef>> p_next = p.cast(new Class[]{CPointer.class, bToolRef.class});
         

        Metadata

        • Field: 'next'
        • Signature: 'bToolRef*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__prev

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

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__prev);
         CPointer<CPointer<bToolRef>> p_prev = p.cast(new Class[]{CPointer.class, bToolRef.class});
         

        Metadata

        • Field: 'prev'
        • Signature: 'bToolRef*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__idname

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

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__idname);
         CPointer<CArrayFacade<Byte>> p_idname = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Optionally use these when not interacting directly with the primary tools gizmo.

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__idname_fallback);
         CPointer<CArrayFacade<Byte>> p_idname_fallback = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Use to avoid initializing the same tool multiple times.

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__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__space_type

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

        Field Documentation

        Blender Source Code

        #bToolKey (space-type, mode), used in 'WM_api.h'

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__space_type);
         CPointer<Short> p_space_type = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'space_type'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__mode

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

        Field Documentation

        Blender Source Code

        Value depends on the 'space_type', object mode for 3D view, image editor has own mode too. RNA needs to handle using item function.

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__mode);
         CPointer<Integer> p_mode = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'mode'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__properties

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

        Field Documentation

        Blender Source Code

        Use for tool options, each group's name must match a tool name:

        {"Tool Name": {"SOME_OT_operator": {...}, ..}, ..}

        This is done since different tools may call the same operators with their own options.

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__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__runtime

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

        Field Documentation

        Blender Source Code

        Variables needed to operate the tool.

        Pointer Arithmetics

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

         bToolRef btoolref = ...;
         CPointer<Object> p = btoolref.__dna__addressof(bToolRef.__DNA__FIELD__runtime);
         CPointer<CPointer<Object>> p_runtime = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

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

      • bToolRef

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

        protected bToolRef​(bToolRef that)
    • Method Detail

      • setNext

        public void setNext​(CPointer<bToolRef> next)
                     throws java.io.IOException
        Set method for struct member 'next'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__next
      • setPrev

        public void setPrev​(CPointer<bToolRef> prev)
                     throws java.io.IOException
        Set method for struct member 'prev'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev
      • getIdname

        public CArrayFacade<java.lang.Byte> getIdname()
                                               throws java.io.IOException
        Get method for struct member 'idname'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname
      • setIdname

        public void setIdname​(CArrayFacade<java.lang.Byte> idname)
                       throws java.io.IOException
        Set method for struct member 'idname'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname
      • getIdname_fallback

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

        Field Documentation

        Blender Source Code

        Optionally use these when not interacting directly with the primary tools gizmo.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname_fallback
      • setIdname_fallback

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

        Field Documentation

        Blender Source Code

        Optionally use these when not interacting directly with the primary tools gizmo.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname_fallback
      • getTag

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

        Field Documentation

        Blender Source Code

        Use to avoid initializing the same tool multiple times.

        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

        Use to avoid initializing the same tool multiple times.

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

        public short getSpace_type()
                            throws java.io.IOException
        Get method for struct member 'space_type'.

        Field Documentation

        Blender Source Code

        #bToolKey (space-type, mode), used in 'WM_api.h'

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__space_type
      • setSpace_type

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

        Field Documentation

        Blender Source Code

        #bToolKey (space-type, mode), used in 'WM_api.h'

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__space_type
      • getMode

        public int getMode()
                    throws java.io.IOException
        Get method for struct member 'mode'.

        Field Documentation

        Blender Source Code

        Value depends on the 'space_type', object mode for 3D view, image editor has own mode too. RNA needs to handle using item function.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__mode
      • setMode

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

        Field Documentation

        Blender Source Code

        Value depends on the 'space_type', object mode for 3D view, image editor has own mode too. RNA needs to handle using item function.

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

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

        Field Documentation

        Blender Source Code

        Use for tool options, each group's name must match a tool name:

        {"Tool Name": {"SOME_OT_operator": {...}, ..}, ..}

        This is done since different tools may call the same operators with their own options.

        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

        Use for tool options, each group's name must match a tool name:

        {"Tool Name": {"SOME_OT_operator": {...}, ..}, ..}

        This is done since different tools may call the same operators with their own options.

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

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

        Field Documentation

        Blender Source Code

        Variables needed to operate the tool.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__runtime
      • setRuntime

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

        Field Documentation

        Blender Source Code

        Variables needed to operate the tool.

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

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