Class bNodeSocket


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

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

        • Field: 'next'
        • Signature: 'bNodeSocket*'
        • 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:

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        User-defined properties.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__prop);
         CPointer<CPointer<IDProperty>> p_prop = p.cast(new Class[]{CPointer.class, IDProperty.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Unique identifier for mapping.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__identifier);
         CPointer<CArrayFacade<Byte>> p_identifier = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        MAX_NAME.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__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__storage

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

        Field Documentation

        Blender Source Code

        Only used for the Image and OutputFile nodes, should be removed at some point.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__storage);
         CPointer<CPointer<Object>> p_storage = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'storage'
        • Signature: 'void*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__type

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

        Field Documentation

        Blender Source Code

        The socket's data type. eNodeSocketDatatype .

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__type);
         CPointer<Short> p_type = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'type'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        eNodeSocketFlag

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__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__limit

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

        Field Documentation

        Blender Source Code

        Maximum number of links that can connect to the socket. Read via #nodeSocketLinkLimit, because the limit might be defined on the socket type, in which case this value does not have any effect. It is necessary to store this in the socket because it is exposed as an RNA property for custom nodes.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__limit);
         CPointer<Short> p_limit = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'limit'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__in_out

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

        Field Documentation

        Blender Source Code

        Input/output type.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__in_out);
         CPointer<Short> p_in_out = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'in_out'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__typeinfo

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

        Field Documentation

        Blender Source Code

        Runtime type information.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__typeinfo);
         CPointer<CPointer<Object>> p_typeinfo = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Runtime type identifier.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__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__locx

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

        Field Documentation

        Blender Source Code

        The location of the sockets, in the view-space of the node editor.

        Note

        These are runtime data only calculated when drawing, and could be removed from DNA.

        These are runtime data only calculated when drawing, and could be removed from DNA.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__locx);
         CPointer<Float> p_locx = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'locx'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__locy

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

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__locy);
         CPointer<Float> p_locy = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'locy'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__default_value

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

        Field Documentation

        Blender Source Code

        Default input value used for unlinked sockets.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__default_value);
         CPointer<CPointer<Object>> p_default_value = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'default_value'
        • Signature: 'void*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__stack_index

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

        Field Documentation

        Blender Source Code

        execution data Local stack index.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__stack_index);
         CPointer<Short> p_stack_index = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'stack_index'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__stack_type

        public static final long[] __DNA__FIELD__stack_type
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__stack_type);
         CPointer<Short> p_stack_type = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'stack_type'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
        Field descriptor (offset) for struct member 'stack_type'.

        Field Documentation

        Blender Source Code

        XXX deprecated, kept for forward compatibility

      • __DNA__FIELD__display_shape

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

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__display_shape);
         CPointer<Byte> p_display_shape = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'display_shape'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__attribute_domain

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

        Field Documentation

        Blender Source Code

        #eAttrDomain used when the geometry nodes modifier creates an attribute for a group output.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__attribute_domain);
         CPointer<Byte> p_attribute_domain = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'attribute_domain'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__total_inputs

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

        Field Documentation

        Blender Source Code

        Runtime-only cache of the number of input links, for multi-input sockets.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__total_inputs);
         CPointer<Short> p_total_inputs = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'total_inputs'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__label

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

        Field Documentation

        Blender Source Code

        Custom dynamic defined label, MAX_NAME.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__label);
         CPointer<CArrayFacade<Byte>> p_label = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Pointer Arithmetics

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        The default attribute name to use for geometry nodes modifier output attribute sockets.

        Note

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__default_attribute_name);
         CPointer<CPointer<Byte>> p_default_attribute_name = p.cast(new Class[]{CPointer.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Cached data from execution.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__cache);
         CPointer<CPointer<Object>> p_cache = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'cache'
        • Signature: 'void*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__own_index

        public static final long[] __DNA__FIELD__own_index
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__own_index);
         CPointer<Integer> p_own_index = p.cast(new Class[]{Integer.class});
         

        Metadata

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

        Field Documentation

        Blender Source Code

        internal data to retrieve relations and groups DEPRECATED, now uses the generic identifier string instead Group socket identifiers, to find matching pairs after reading files.

      • __DNA__FIELD__to_index

        public static final long[] __DNA__FIELD__to_index
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__to_index);
         CPointer<Integer> p_to_index = p.cast(new Class[]{Integer.class});
         

        Metadata

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

        Field Documentation

        Blender Source Code

        XXX deprecated, only used for restoring old group node links

      • __DNA__FIELD__groupsock

        public static final long[] __DNA__FIELD__groupsock
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__groupsock);
         CPointer<CPointer<bNodeSocket>> p_groupsock = p.cast(new Class[]{CPointer.class, bNodeSocket.class});
         

        Metadata

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

        Field Documentation

        Blender Source Code

        XXX deprecated, still forward compatible since verification restores pointer from matching own_index.

      • __DNA__FIELD__link

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

        Field Documentation

        Blender Source Code

        A link pointer, set in #BKE_ntree_update_main.

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__link);
         CPointer<CPointer<bNodeLink>> p_link = p.cast(new Class[]{CPointer.class, bNodeLink.class});
         

        Metadata

        • Field: 'link'
        • Signature: 'bNodeLink*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__ns

        public static final long[] __DNA__FIELD__ns
        Deprecated.
        Deprecated

        Pointer Arithmetics

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

         bNodeSocket bnodesocket = ...;
         CPointer<Object> p = bnodesocket.__dna__addressof(bNodeSocket.__DNA__FIELD__ns);
         CPointer<bNodeStack> p_ns = p.cast(new Class[]{bNodeStack.class});
         

        Metadata

        • Field: 'ns'
        • Signature: 'bNodeStack'
        • Actual Size (32bit/64bit): 44/48
        Field descriptor (offset) for struct member 'ns'.

        Field Documentation

        Blender Source Code

        XXX deprecated, socket input values are stored in default_value now. kept for forward compatibility Custom data for inputs, only UI writes in this.

      • __DNA__FIELD__runtime

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

        Pointer Arithmetics

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

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

        Metadata

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

      • bNodeSocket

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

        protected bNodeSocket​(bNodeSocket that)
    • Method Detail

      • getProp

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

        Field Documentation

        Blender Source Code

        User-defined properties.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prop
      • setProp

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

        Field Documentation

        Blender Source Code

        User-defined properties.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prop
      • getIdentifier

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

        Field Documentation

        Blender Source Code

        Unique identifier for mapping.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__identifier
      • setIdentifier

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

        Field Documentation

        Blender Source Code

        Unique identifier for mapping.

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

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

        Field Documentation

        Blender Source Code

        MAX_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

        MAX_NAME.

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

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

        Field Documentation

        Blender Source Code

        Only used for the Image and OutputFile nodes, should be removed at some point.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__storage
      • setStorage

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

        Field Documentation

        Blender Source Code

        Only used for the Image and OutputFile nodes, should be removed at some point.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__storage
      • getType

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

        Field Documentation

        Blender Source Code

        The socket's data type. eNodeSocketDatatype .

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

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

        Field Documentation

        Blender Source Code

        The socket's data type. eNodeSocketDatatype .

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

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

        Field Documentation

        Blender Source Code

        eNodeSocketFlag

        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'.

        Field Documentation

        Blender Source Code

        eNodeSocketFlag

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

        public short getLimit()
                       throws java.io.IOException
        Get method for struct member 'limit'.

        Field Documentation

        Blender Source Code

        Maximum number of links that can connect to the socket. Read via #nodeSocketLinkLimit, because the limit might be defined on the socket type, in which case this value does not have any effect. It is necessary to store this in the socket because it is exposed as an RNA property for custom nodes.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__limit
      • setLimit

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

        Field Documentation

        Blender Source Code

        Maximum number of links that can connect to the socket. Read via #nodeSocketLinkLimit, because the limit might be defined on the socket type, in which case this value does not have any effect. It is necessary to store this in the socket because it is exposed as an RNA property for custom nodes.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__limit
      • getIn_out

        public short getIn_out()
                        throws java.io.IOException
        Get method for struct member 'in_out'.

        Field Documentation

        Blender Source Code

        Input/output type.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__in_out
      • setIn_out

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

        Field Documentation

        Blender Source Code

        Input/output type.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__in_out
      • getTypeinfo

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

        Field Documentation

        Blender Source Code

        Runtime type information.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__typeinfo
      • setTypeinfo

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

        Field Documentation

        Blender Source Code

        Runtime type information.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__typeinfo
      • getIdname

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

        Field Documentation

        Blender Source Code

        Runtime type identifier.

        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'.

        Field Documentation

        Blender Source Code

        Runtime type identifier.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__idname
      • getLocx

        public float getLocx()
                      throws java.io.IOException
        Get method for struct member 'locx'.

        Field Documentation

        Blender Source Code

        The location of the sockets, in the view-space of the node editor.

        Note

        These are runtime data only calculated when drawing, and could be removed from DNA.

        These are runtime data only calculated when drawing, and could be removed from DNA.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__locx
      • setLocx

        public void setLocx​(float locx)
                     throws java.io.IOException
        Set method for struct member 'locx'.

        Field Documentation

        Blender Source Code

        The location of the sockets, in the view-space of the node editor.

        Note

        These are runtime data only calculated when drawing, and could be removed from DNA.

        These are runtime data only calculated when drawing, and could be removed from DNA.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__locx
      • getLocy

        public float getLocy()
                      throws java.io.IOException
        Get method for struct member 'locy'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__locy
      • setLocy

        public void setLocy​(float locy)
                     throws java.io.IOException
        Set method for struct member 'locy'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__locy
      • getDefault_value

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

        Field Documentation

        Blender Source Code

        Default input value used for unlinked sockets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__default_value
      • setDefault_value

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

        Field Documentation

        Blender Source Code

        Default input value used for unlinked sockets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__default_value
      • getStack_index

        public short getStack_index()
                             throws java.io.IOException
        Get method for struct member 'stack_index'.

        Field Documentation

        Blender Source Code

        execution data Local stack index.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__stack_index
      • setStack_index

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

        Field Documentation

        Blender Source Code

        execution data Local stack index.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__stack_index
      • getStack_type

        public short getStack_type()
                            throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'stack_type'.

        Field Documentation

        Blender Source Code

        XXX deprecated, kept for forward compatibility

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__stack_type
      • setStack_type

        public void setStack_type​(short stack_type)
                           throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'stack_type'.

        Field Documentation

        Blender Source Code

        XXX deprecated, kept for forward compatibility

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__stack_type
      • getDisplay_shape

        public byte getDisplay_shape()
                              throws java.io.IOException
        Get method for struct member 'display_shape'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__display_shape
      • setDisplay_shape

        public void setDisplay_shape​(byte display_shape)
                              throws java.io.IOException
        Set method for struct member 'display_shape'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__display_shape
      • getAttribute_domain

        public byte getAttribute_domain()
                                 throws java.io.IOException
        Get method for struct member 'attribute_domain'.

        Field Documentation

        Blender Source Code

        #eAttrDomain used when the geometry nodes modifier creates an attribute for a group output.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__attribute_domain
      • setAttribute_domain

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

        Field Documentation

        Blender Source Code

        #eAttrDomain used when the geometry nodes modifier creates an attribute for a group output.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__attribute_domain
      • getTotal_inputs

        public short getTotal_inputs()
                              throws java.io.IOException
        Get method for struct member 'total_inputs'.

        Field Documentation

        Blender Source Code

        Runtime-only cache of the number of input links, for multi-input sockets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__total_inputs
      • setTotal_inputs

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

        Field Documentation

        Blender Source Code

        Runtime-only cache of the number of input links, for multi-input sockets.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__total_inputs
      • getLabel

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

        Field Documentation

        Blender Source Code

        Custom dynamic defined label, MAX_NAME.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__label
      • setLabel

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

        Field Documentation

        Blender Source Code

        Custom dynamic defined label, MAX_NAME.

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

        public CArrayFacade<java.lang.Byte> getDescription()
                                                    throws java.io.IOException
        Get method for struct member 'description'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • setDescription

        public void setDescription​(CArrayFacade<java.lang.Byte> description)
                            throws java.io.IOException
        Set method for struct member 'description'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__description
      • getDefault_attribute_name

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

        Field Documentation

        Blender Source Code

        The default attribute name to use for geometry nodes modifier output attribute sockets.

        Note

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__default_attribute_name
      • setDefault_attribute_name

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

        Field Documentation

        Blender Source Code

        The default attribute name to use for geometry nodes modifier output attribute sockets.

        Note

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Storing this pointer in every single socket exposes the bad design of using sockets to describe group inputs and outputs. In the future, it should be stored in socket declarations.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__default_attribute_name
      • getCache

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

        Field Documentation

        Blender Source Code

        Cached data from execution.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cache
      • setCache

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

        Field Documentation

        Blender Source Code

        Cached data from execution.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cache
      • getOwn_index

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

        Get method for struct member 'own_index'.

        Field Documentation

        Blender Source Code

        internal data to retrieve relations and groups DEPRECATED, now uses the generic identifier string instead Group socket identifiers, to find matching pairs after reading files.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__own_index
      • setOwn_index

        public void setOwn_index​(int own_index)
                          throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'own_index'.

        Field Documentation

        Blender Source Code

        internal data to retrieve relations and groups DEPRECATED, now uses the generic identifier string instead Group socket identifiers, to find matching pairs after reading files.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__own_index
      • getTo_index

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

        Get method for struct member 'to_index'.

        Field Documentation

        Blender Source Code

        XXX deprecated, only used for restoring old group node links

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__to_index
      • setTo_index

        public void setTo_index​(int to_index)
                         throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'to_index'.

        Field Documentation

        Blender Source Code

        XXX deprecated, only used for restoring old group node links

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__to_index
      • getGroupsock

        public CPointer<bNodeSocket> getGroupsock()
                                           throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'groupsock'.

        Field Documentation

        Blender Source Code

        XXX deprecated, still forward compatible since verification restores pointer from matching own_index.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__groupsock
      • setGroupsock

        public void setGroupsock​(CPointer<bNodeSocket> groupsock)
                          throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'groupsock'.

        Field Documentation

        Blender Source Code

        XXX deprecated, still forward compatible since verification restores pointer from matching own_index.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__groupsock
      • getLink

        public CPointer<bNodeLink> getLink()
                                    throws java.io.IOException
        Get method for struct member 'link'.

        Field Documentation

        Blender Source Code

        A link pointer, set in #BKE_ntree_update_main.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__link
      • setLink

        public void setLink​(CPointer<bNodeLink> link)
                     throws java.io.IOException
        Set method for struct member 'link'.

        Field Documentation

        Blender Source Code

        A link pointer, set in #BKE_ntree_update_main.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__link
      • getNs

        public bNodeStack getNs()
                         throws java.io.IOException
        Deprecated.
        Deprecated

        Get method for struct member 'ns'.

        Field Documentation

        Blender Source Code

        XXX deprecated, socket input values are stored in default_value now. kept for forward compatibility Custom data for inputs, only UI writes in this.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ns
      • setNs

        public void setNs​(bNodeStack ns)
                   throws java.io.IOException
        Deprecated.
        Deprecated

        Set method for struct member 'ns'.

        Field Documentation

        Blender Source Code

        XXX deprecated, socket input values are stored in default_value now. kept for forward compatibility Custom data for inputs, only UI writes in this.

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

        public CPointer<java.lang.Object> getRuntime()
                                              throws java.io.IOException
        Get method for struct member 'runtime'.
        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'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__runtime
      • __io__addressof

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