Class FMod_FunctionGenerator


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

    Class Documentation

    Blender Source Code

    'Built-In Function' Generator modifier data

    This uses the general equation for equations: y = amplitude * fn(phase_multiplier*x + phase_offset) + y_offset

    where amplitude, phase_multiplier/offset, y_offset are user-defined coefficients, x is the evaluation 'time', and 'y' is the resultant value

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Source Code

        Coefficients for general equation (as above).

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__DNA__FIELD__amplitude);
         CPointer<Float> p_amplitude = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'amplitude'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__phase_multiplier

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

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__DNA__FIELD__phase_multiplier);
         CPointer<Float> p_phase_multiplier = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'phase_multiplier'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__phase_offset

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

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__DNA__FIELD__phase_offset);
         CPointer<Float> p_phase_offset = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'phase_offset'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__value_offset

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

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__DNA__FIELD__value_offset);
         CPointer<Float> p_value_offset = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'value_offset'
        • 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

        flags eFMod_Generator_Functions .

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__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

        #eFMod_Generator_flags.

        Pointer Arithmetics

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

         FMod_FunctionGenerator fmod_functiongenerator = ...;
         CPointer<Object> p = fmod_functiongenerator.__dna__addressof(FMod_FunctionGenerator.__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

      • FMod_FunctionGenerator

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

      • getAmplitude

        public float getAmplitude()
                           throws java.io.IOException
        Get method for struct member 'amplitude'.

        Field Documentation

        Blender Source Code

        Coefficients for general equation (as above).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__amplitude
      • setAmplitude

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

        Field Documentation

        Blender Source Code

        Coefficients for general equation (as above).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__amplitude
      • getPhase_multiplier

        public float getPhase_multiplier()
                                  throws java.io.IOException
        Get method for struct member 'phase_multiplier'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__phase_multiplier
      • setPhase_multiplier

        public void setPhase_multiplier​(float phase_multiplier)
                                 throws java.io.IOException
        Set method for struct member 'phase_multiplier'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__phase_multiplier
      • getPhase_offset

        public float getPhase_offset()
                              throws java.io.IOException
        Get method for struct member 'phase_offset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__phase_offset
      • setPhase_offset

        public void setPhase_offset​(float phase_offset)
                             throws java.io.IOException
        Set method for struct member 'phase_offset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__phase_offset
      • getValue_offset

        public float getValue_offset()
                              throws java.io.IOException
        Get method for struct member 'value_offset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__value_offset
      • setValue_offset

        public void setValue_offset​(float value_offset)
                             throws java.io.IOException
        Set method for struct member 'value_offset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__value_offset
      • getType

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

        Field Documentation

        Blender Source Code

        flags eFMod_Generator_Functions .

        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

        flags eFMod_Generator_Functions .

        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

        #eFMod_Generator_flags.

        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

        #eFMod_Generator_flags.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag