Class FModifier


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

    Class Documentation

    Blender Source Code


    F-Curve DataTypes Modifiers ----------------------------------- F-Curve Modifiers (fcm)

    These alter the way F-Curves behave, by altering the value that is returned when evaluating the curve's data at some time (t).

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

        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:

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

        Metadata

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

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

        Metadata

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

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

        Field Documentation

        Blender Source Code

        Containing curve, only used for updates to CYCLES.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__curve);
         CPointer<CPointer<FCurve>> p_curve = p.cast(new Class[]{CPointer.class, FCurve.class});
         

        Metadata

        • Field: 'curve'
        • Signature: 'FCurve*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__data

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

        Field Documentation

        Blender Source Code

        Pointer to modifier data.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__data);
         CPointer<CPointer<Object>> p_data = p.cast(new Class[]{CPointer.class, Object.class});
         

        Metadata

        • Field: 'data'
        • Signature: 'void*'
        • 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

        .

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__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__type

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

        Field Documentation

        Blender Python API

        (read-only) F-Curve Modifier Type

        Blender Source Code

        Type of f-curve modifier.

        Pointer Arithmetics

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

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

        Settings for the modifier.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__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__ui_expand_flag

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

        Field Documentation

        Blender Source Code

        total panels).

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__ui_expand_flag);
         CPointer<Short> p_ui_expand_flag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'ui_expand_flag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD___pad

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

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD___pad);
         CPointer<CArrayFacade<Byte>> p__pad = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad'
        • Signature: 'char[6]'
        • Actual Size (32bit/64bit): 6/6
      • __DNA__FIELD__influence

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

        Field Documentation

        Blender Python API

        Amount of influence F-Curve Modifier will have when not fading in/out

        Blender Source Code

        The amount that the modifier should influence the value.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__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__sfra

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

        Field Documentation

        Blender Source Code

        Start frame of restricted frame-range.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__sfra);
         CPointer<Float> p_sfra = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'sfra'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__efra

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

        Field Documentation

        Blender Source Code

        End frame of restricted frame-range.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__efra);
         CPointer<Float> p_efra = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'efra'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__blendin

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

        Field Documentation

        Blender Source Code

        Number of frames from sfra before modifier takes full influence.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__blendin);
         CPointer<Float> p_blendin = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'blendin'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__blendout

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

        Field Documentation

        Blender Source Code

        Number of frames from efra before modifier fades out.

        Pointer Arithmetics

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

         FModifier fmodifier = ...;
         CPointer<Object> p = fmodifier.__dna__addressof(FModifier.__DNA__FIELD__blendout);
         CPointer<Float> p_blendout = p.cast(new Class[]{Float.class});
         

        Metadata

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

      • FModifier

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

        protected FModifier​(FModifier that)
    • Method Detail

      • setNext

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

        public CPointer<FCurve> getCurve()
                                  throws java.io.IOException
        Get method for struct member 'curve'.

        Field Documentation

        Blender Source Code

        Containing curve, only used for updates to CYCLES.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__curve
      • setCurve

        public void setCurve​(CPointer<FCurve> curve)
                      throws java.io.IOException
        Set method for struct member 'curve'.

        Field Documentation

        Blender Source Code

        Containing curve, only used for updates to CYCLES.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__curve
      • getData

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

        Field Documentation

        Blender Source Code

        Pointer to modifier data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__data
      • setData

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

        Field Documentation

        Blender Source Code

        Pointer to modifier data.

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

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

        Field Documentation

        Blender Source Code

        .

        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

        .

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

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

        Field Documentation

        Blender Python API

        (read-only) F-Curve Modifier Type

        Blender Source Code

        Type of f-curve modifier.

        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 Python API

        (read-only) F-Curve Modifier Type

        Blender Source Code

        Type of f-curve modifier.

        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

        Settings for the modifier.

        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

        Settings for the modifier.

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

        public short getUi_expand_flag()
                                throws java.io.IOException
        Get method for struct member 'ui_expand_flag'.

        Field Documentation

        Blender Source Code

        total panels).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ui_expand_flag
      • setUi_expand_flag

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

        Field Documentation

        Blender Source Code

        total panels).

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__ui_expand_flag
      • get_pad

        public CArrayFacade<java.lang.Byte> get_pad()
                                             throws java.io.IOException
        Get method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • set_pad

        public void set_pad​(CArrayFacade<java.lang.Byte> _pad)
                     throws java.io.IOException
        Set method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • getInfluence

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

        Field Documentation

        Blender Python API

        Amount of influence F-Curve Modifier will have when not fading in/out

        Blender Source Code

        The amount that the modifier should influence the value.

        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 Python API

        Amount of influence F-Curve Modifier will have when not fading in/out

        Blender Source Code

        The amount that the modifier should influence the value.

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

        public float getSfra()
                      throws java.io.IOException
        Get method for struct member 'sfra'.

        Field Documentation

        Blender Source Code

        Start frame of restricted frame-range.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sfra
      • setSfra

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

        Field Documentation

        Blender Source Code

        Start frame of restricted frame-range.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sfra
      • getEfra

        public float getEfra()
                      throws java.io.IOException
        Get method for struct member 'efra'.

        Field Documentation

        Blender Source Code

        End frame of restricted frame-range.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__efra
      • setEfra

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

        Field Documentation

        Blender Source Code

        End frame of restricted frame-range.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__efra
      • getBlendin

        public float getBlendin()
                         throws java.io.IOException
        Get method for struct member 'blendin'.

        Field Documentation

        Blender Source Code

        Number of frames from sfra before modifier takes full influence.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__blendin
      • setBlendin

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

        Field Documentation

        Blender Source Code

        Number of frames from sfra before modifier takes full influence.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__blendin
      • getBlendout

        public float getBlendout()
                          throws java.io.IOException
        Get method for struct member 'blendout'.

        Field Documentation

        Blender Source Code

        Number of frames from efra before modifier fades out.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__blendout
      • setBlendout

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

        Field Documentation

        Blender Source Code

        Number of frames from efra before modifier fades out.

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

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