Class bKinematicConstraint


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

    Class Documentation

    Blender Source Code

    Inverse-Kinematics (IK) constraint This constraint supports a variety of mode determine by the type field according to eConstraint_IK_Type. Some fields are used by all types, some are specific to some types This is indicated in the comments for each field

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Source Code

        All: target object in case constraint needs a target.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__tar);
         CPointer<CPointer<BlenderObject>> p_tar = p.cast(new Class[]{CPointer.class, BlenderObject.class});
         

        Metadata

        • Field: 'tar'
        • Signature: 'Object*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__iterations

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

        Field Documentation

        Blender Source Code

        All: Maximum number of iterations to try.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__iterations);
         CPointer<Short> p_iterations = p.cast(new Class[]{Short.class});
         

        Metadata

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

        All & CopyPose: some options Like CONSTRAINT_IK_TIP.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__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__rootbone

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

        Field Documentation

        Blender Source Code

        All: index to rootbone, if zero go all the way to mother bone.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__rootbone);
         CPointer<Short> p_rootbone = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'rootbone'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__max_rootbone

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

        Field Documentation

        Blender Source Code

        CopyPose: for auto-ik, maximum length of chain.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__max_rootbone);
         CPointer<Short> p_max_rootbone = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'max_rootbone'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__subtarget

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

        Field Documentation

        Blender Source Code

        All: String to specify sub-object target, MAX_ID_NAME-2.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__subtarget);
         CPointer<CArrayFacade<Byte>> p_subtarget = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        All: Pole vector target.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__poletar);
         CPointer<CPointer<BlenderObject>> p_poletar = p.cast(new Class[]{CPointer.class, BlenderObject.class});
         

        Metadata

        • Field: 'poletar'
        • Signature: 'Object*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__polesubtarget

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

        Field Documentation

        Blender Source Code

        All: Pole vector sub-object target, MAX_ID_NAME-2.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__polesubtarget);
         CPointer<CArrayFacade<Byte>> p_polesubtarget = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

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

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

        Field Documentation

        Blender Source Code

        All: Pole vector rest angle.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__poleangle);
         CPointer<Float> p_poleangle = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'poleangle'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__weight

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

        Field Documentation

        Blender Source Code

        All: Weight of constraint in IK tree.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__weight);
         CPointer<Float> p_weight = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'weight'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__orientweight

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

        Field Documentation

        Blender Source Code

        CopyPose: Amount of rotation a target applies on chain.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__orientweight);
         CPointer<Float> p_orientweight = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'orientweight'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__grabtarget

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

        Field Documentation

        Blender Source Code

        CopyPose: for target-less IK.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__grabtarget);
         CPointer<CArrayFacade<Float>> p_grabtarget = p.cast(new Class[]{CArrayFacade.class, Float.class});
         

        Metadata

        • Field: 'grabtarget'
        • Signature: 'float[3]'
        • Actual Size (32bit/64bit): 12/12
      • __DNA__FIELD__type

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

        Field Documentation

        Blender Source Code

        Subtype of IK constraint: eConstraint_IK_Type.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__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__mode

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

        Field Documentation

        Blender Source Code

        Distance: how to limit in relation to clamping sphere: LIMITDIST_...

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__mode);
         CPointer<Short> p_mode = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'mode'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__dist

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

        Field Documentation

        Blender Source Code

        Distance: distance (radius of clamping sphere) from target.

        Pointer Arithmetics

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

         bKinematicConstraint bkinematicconstraint = ...;
         CPointer<Object> p = bkinematicconstraint.__dna__addressof(bKinematicConstraint.__DNA__FIELD__dist);
         CPointer<Float> p_dist = p.cast(new Class[]{Float.class});
         

        Metadata

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

      • bKinematicConstraint

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

      • getTar

        public CPointer<BlenderObject> getTar()
                                       throws java.io.IOException
        Get method for struct member 'tar'.

        Field Documentation

        Blender Source Code

        All: target object in case constraint needs a target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tar
      • setTar

        public void setTar​(CPointer<BlenderObject> tar)
                    throws java.io.IOException
        Set method for struct member 'tar'.

        Field Documentation

        Blender Source Code

        All: target object in case constraint needs a target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tar
      • getIterations

        public short getIterations()
                            throws java.io.IOException
        Get method for struct member 'iterations'.

        Field Documentation

        Blender Source Code

        All: Maximum number of iterations to try.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__iterations
      • setIterations

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

        Field Documentation

        Blender Source Code

        All: Maximum number of iterations to try.

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

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

        Field Documentation

        Blender Source Code

        All & CopyPose: some options Like CONSTRAINT_IK_TIP.

        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

        All & CopyPose: some options Like CONSTRAINT_IK_TIP.

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

        public short getRootbone()
                          throws java.io.IOException
        Get method for struct member 'rootbone'.

        Field Documentation

        Blender Source Code

        All: index to rootbone, if zero go all the way to mother bone.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__rootbone
      • setRootbone

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

        Field Documentation

        Blender Source Code

        All: index to rootbone, if zero go all the way to mother bone.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__rootbone
      • getMax_rootbone

        public short getMax_rootbone()
                              throws java.io.IOException
        Get method for struct member 'max_rootbone'.

        Field Documentation

        Blender Source Code

        CopyPose: for auto-ik, maximum length of chain.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__max_rootbone
      • setMax_rootbone

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

        Field Documentation

        Blender Source Code

        CopyPose: for auto-ik, maximum length of chain.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__max_rootbone
      • getSubtarget

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

        Field Documentation

        Blender Source Code

        All: String to specify sub-object target, MAX_ID_NAME-2.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__subtarget
      • setSubtarget

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

        Field Documentation

        Blender Source Code

        All: String to specify sub-object target, MAX_ID_NAME-2.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__subtarget
      • getPoletar

        public CPointer<BlenderObject> getPoletar()
                                           throws java.io.IOException
        Get method for struct member 'poletar'.

        Field Documentation

        Blender Source Code

        All: Pole vector target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__poletar
      • setPoletar

        public void setPoletar​(CPointer<BlenderObject> poletar)
                        throws java.io.IOException
        Set method for struct member 'poletar'.

        Field Documentation

        Blender Source Code

        All: Pole vector target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__poletar
      • getPolesubtarget

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

        Field Documentation

        Blender Source Code

        All: Pole vector sub-object target, MAX_ID_NAME-2.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__polesubtarget
      • setPolesubtarget

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

        Field Documentation

        Blender Source Code

        All: Pole vector sub-object target, MAX_ID_NAME-2.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__polesubtarget
      • getPoleangle

        public float getPoleangle()
                           throws java.io.IOException
        Get method for struct member 'poleangle'.

        Field Documentation

        Blender Source Code

        All: Pole vector rest angle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__poleangle
      • setPoleangle

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

        Field Documentation

        Blender Source Code

        All: Pole vector rest angle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__poleangle
      • getWeight

        public float getWeight()
                        throws java.io.IOException
        Get method for struct member 'weight'.

        Field Documentation

        Blender Source Code

        All: Weight of constraint in IK tree.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__weight
      • setWeight

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

        Field Documentation

        Blender Source Code

        All: Weight of constraint in IK tree.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__weight
      • getOrientweight

        public float getOrientweight()
                              throws java.io.IOException
        Get method for struct member 'orientweight'.

        Field Documentation

        Blender Source Code

        CopyPose: Amount of rotation a target applies on chain.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__orientweight
      • setOrientweight

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

        Field Documentation

        Blender Source Code

        CopyPose: Amount of rotation a target applies on chain.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__orientweight
      • getGrabtarget

        public CArrayFacade<java.lang.Float> getGrabtarget()
                                                    throws java.io.IOException
        Get method for struct member 'grabtarget'.

        Field Documentation

        Blender Source Code

        CopyPose: for target-less IK.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__grabtarget
      • setGrabtarget

        public void setGrabtarget​(CArrayFacade<java.lang.Float> grabtarget)
                           throws java.io.IOException
        Set method for struct member 'grabtarget'.

        Field Documentation

        Blender Source Code

        CopyPose: for target-less IK.

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

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

        Field Documentation

        Blender Source Code

        Subtype of IK constraint: eConstraint_IK_Type.

        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

        Subtype of IK constraint: eConstraint_IK_Type.

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

        public short getMode()
                      throws java.io.IOException
        Get method for struct member 'mode'.

        Field Documentation

        Blender Source Code

        Distance: how to limit in relation to clamping sphere: LIMITDIST_...

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__mode
      • setMode

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

        Field Documentation

        Blender Source Code

        Distance: how to limit in relation to clamping sphere: LIMITDIST_...

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__mode
      • getDist

        public float getDist()
                      throws java.io.IOException
        Get method for struct member 'dist'.

        Field Documentation

        Blender Source Code

        Distance: distance (radius of clamping sphere) from target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dist
      • setDist

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

        Field Documentation

        Blender Source Code

        Distance: distance (radius of clamping sphere) from target.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dist