Class ChannelDriver


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

    Class Documentation

    Blender Source Code


    Channel Driver (i.e. Drivers / Expressions) (driver)

    Channel Drivers are part of the dependency system, and are executed in addition to normal user-defined animation. They take the animation result of some channel(s), and use that (optionally combined with its own F-Curve for modification of results) to define the value of some setting semi-procedurally.

    Drivers are stored as part of F-Curve data, so that the F-Curve's RNA-path settings (for storing what setting the driver will affect). The order in which they are stored defines the order that they're evaluated in. This order is set by the Depsgraph's sorting stuff.

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Source Code

        Targets for this driver (i.e. list of DriverVar ).

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__variables);
         CPointer<ListBase> p_variables = p.cast(new Class[]{ListBase.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        python expression to execute (may call functions defined in an accessory file) which relates the target 'variables' in some way to yield a single usable value Expression to compile for evaluation.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__expression);
         CPointer<CArrayFacade<Byte>> p_expression = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: 'expression'
        • Signature: 'char[256]'
        • Actual Size (32bit/64bit): 256/256
      • __DNA__FIELD__expr_comp

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

        Field Documentation

        Blender Source Code

        PyObject - compiled expression, don't save this.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__expr_comp);
         CPointer<CPointer<Object>> p_expr_comp = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Compiled simple arithmetic expression.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__expr_simple);
         CPointer<CPointer<Object>> p_expr_simple = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        XXX to be implemented... this is like the constraint influence setting. Influence of driver on result.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__influence);
         CPointer<Float> p_influence = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'influence'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__type

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

        Field Documentation

        Blender Source Code

        general settings Type of driver.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__type);
         CPointer<Integer> p_type = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'type'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__flag

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

        Field Documentation

        Blender Source Code

        Settings of driver.

        Pointer Arithmetics

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

         ChannelDriver channeldriver = ...;
         CPointer<Object> p = channeldriver.__dna__addressof(ChannelDriver.__DNA__FIELD__flag);
         CPointer<Integer> p_flag = p.cast(new Class[]{Integer.class});
         

        Metadata

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

      • ChannelDriver

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

      • getVariables

        public ListBase getVariables()
                              throws java.io.IOException
        Get method for struct member 'variables'.

        Field Documentation

        Blender Source Code

        Targets for this driver (i.e. list of DriverVar ).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__variables
      • setVariables

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

        Field Documentation

        Blender Source Code

        Targets for this driver (i.e. list of DriverVar ).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__variables
      • getExpression

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

        Field Documentation

        Blender Source Code

        python expression to execute (may call functions defined in an accessory file) which relates the target 'variables' in some way to yield a single usable value Expression to compile for evaluation.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__expression
      • setExpression

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

        Field Documentation

        Blender Source Code

        python expression to execute (may call functions defined in an accessory file) which relates the target 'variables' in some way to yield a single usable value Expression to compile for evaluation.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__expression
      • getExpr_comp

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

        Field Documentation

        Blender Source Code

        PyObject - compiled expression, don't save this.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__expr_comp
      • setExpr_comp

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

        Field Documentation

        Blender Source Code

        PyObject - compiled expression, don't save this.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__expr_comp
      • getExpr_simple

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

        Field Documentation

        Blender Source Code

        Compiled simple arithmetic expression.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__expr_simple
      • setExpr_simple

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

        Field Documentation

        Blender Source Code

        Compiled simple arithmetic expression.

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

        public float getInfluence()
                           throws java.io.IOException
        Get method for struct member 'influence'.

        Field Documentation

        Blender Source Code

        XXX to be implemented... this is like the constraint influence setting. Influence of driver on result.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__influence
      • setInfluence

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

        Field Documentation

        Blender Source Code

        XXX to be implemented... this is like the constraint influence setting. Influence of driver on result.

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

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

        Field Documentation

        Blender Source Code

        general settings Type of driver.

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

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

        Field Documentation

        Blender Source Code

        general settings Type of driver.

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

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

        Field Documentation

        Blender Source Code

        Settings of driver.

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

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

        Field Documentation

        Blender Source Code

        Settings of driver.

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

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