Class DriverVar


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

    Class Documentation

    Blender Source Code

    Driver Variable (dvar)

    A 'variable' for use as an input for the driver evaluation. Defines a way of accessing some channel to use, that can be referred to in the expression as a variable, thus simplifying expressions and also Depsgraph building.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Name of the variable to use in py-expression (must be valid python identifier) - MAX_ID_NAME-2.

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__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__targets

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

        Field Documentation

        Blender Source Code

        MAX_DRIVER_TARGETS, target slots.

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__DNA__FIELD__targets);
         CPointer<CArrayFacade<DriverTarget>> p_targets = p.cast(new Class[]{CArrayFacade.class, DriverTarget.class});
         

        Metadata

        • Field: 'targets'
        • Signature: 'DriverTarget[8]'
        • Actual Size (32bit/64bit): 704/768
      • __DNA__FIELD__num_targets

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

        Field Documentation

        Blender Source Code

        Number of targets actually used by this variable.

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__DNA__FIELD__num_targets);
         CPointer<Byte> p_num_targets = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'num_targets'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__type

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

        Field Documentation

        Blender Source Code

        Type of driver variable (eDriverVar_Types).

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__DNA__FIELD__type);
         CPointer<Byte> p_type = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'type'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        Validation tags, etc. (eDriverVar_Flags).

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__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__curval

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

        Field Documentation

        Blender Source Code

        Result of previous evaluation.

        Pointer Arithmetics

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

         DriverVar drivervar = ...;
         CPointer<Object> p = drivervar.__dna__addressof(DriverVar.__DNA__FIELD__curval);
         CPointer<Float> p_curval = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'curval'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
    • Constructor Detail

      • DriverVar

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

        protected DriverVar​(DriverVar that)
    • Method Detail

      • setNext

        public void setNext​(CPointer<DriverVar> 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<DriverVar> prev)
                     throws java.io.IOException
        Set method for struct member 'prev'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev
      • getName

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

        Field Documentation

        Blender Source Code

        Name of the variable to use in py-expression (must be valid python identifier) - MAX_ID_NAME-2.

        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

        Name of the variable to use in py-expression (must be valid python identifier) - MAX_ID_NAME-2.

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

        public CArrayFacade<DriverTarget> getTargets()
                                              throws java.io.IOException
        Get method for struct member 'targets'.

        Field Documentation

        Blender Source Code

        MAX_DRIVER_TARGETS, target slots.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__targets
      • setTargets

        public void setTargets​(CArrayFacade<DriverTarget> targets)
                        throws java.io.IOException
        Set method for struct member 'targets'.

        Field Documentation

        Blender Source Code

        MAX_DRIVER_TARGETS, target slots.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__targets
      • getNum_targets

        public byte getNum_targets()
                            throws java.io.IOException
        Get method for struct member 'num_targets'.

        Field Documentation

        Blender Source Code

        Number of targets actually used by this variable.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__num_targets
      • setNum_targets

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

        Field Documentation

        Blender Source Code

        Number of targets actually used by this variable.

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

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

        Field Documentation

        Blender Source Code

        Type of driver variable (eDriverVar_Types).

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

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

        Field Documentation

        Blender Source Code

        Type of driver variable (eDriverVar_Types).

        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

        Validation tags, etc. (eDriverVar_Flags).

        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

        Validation tags, etc. (eDriverVar_Flags).

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

        public float getCurval()
                        throws java.io.IOException
        Get method for struct member 'curval'.

        Field Documentation

        Blender Source Code

        Result of previous evaluation.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__curval
      • setCurval

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

        Field Documentation

        Blender Source Code

        Result of previous evaluation.

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

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