← Back to branch summary

~ubuntu-branches/ubuntu/trusty/blender/trusty

« back to all changes in this revision

Viewing changes to doc/python_api/rst/bge_types/bge.types.BL_ArmatureConstraint.rst

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-03-06 12:08:47 UTC
  • mfrom: (1.5.1) (14.1.8 experimental)
  • Revision ID: package-import@ubuntu.com-20130306120847-frjfaryb2zrotwcg
Tags: 2.66a-1ubuntu1
https://launchpad.net/bugs/1076930
https://launchpad.net/bugs/1089256
https://launchpad.net/bugs/1052743
https://launchpad.net/bugs/999024
* Resynchronize with Debian (LP: #1076930, #1089256, #1052743, #999024,
  #1122888, #1147084)
* debian/control:
  - Lower build-depends on libavcodec-dev since we're not
    doing the libav9 transition in Ubuntu yet

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/python_api/rst/bge_types/bge.types.BL_ArmatureConstraint.rst
 
1
BL_ArmatureConstraint(PyObjectPlus)
 
2
===================================
 
3
 
 
4
.. module:: bge.types
 
5
 
 
6
base class --- :class:`PyObjectPlus`
 
7
 
 
8
.. class:: BL_ArmatureConstraint(PyObjectPlus)
 
9
 
 
10
   Proxy to Armature Constraint. Allows to change constraint on the fly.
 
11
   Obtained through :class:`BL_ArmatureObject`.constraints.
 
12
 
 
13
   .. note::
 
14
   
 
15
      Not all armature constraints are supported in the GE.
 
16
 
 
17
      
 
18
   .. attribute:: type
 
19
 
 
20
      Type of constraint, (read-only).
 
21
 
 
22
      Use one of :ref:`these constants<armatureconstraint-constants-type>`.
 
23
      
 
24
      :type: integer, one of CONSTRAINT_TYPE_* constants
 
25
 
 
26
   .. attribute:: name
 
27
 
 
28
      Name of constraint constructed as <bone_name>:<constraint_name>. constraints list.
 
29
 
 
30
      :type: string
 
31
 
 
32
      This name is also the key subscript on :class:`BL_ArmatureObject`.
 
33
 
 
34
   .. attribute:: enforce
 
35
 
 
36
      fraction of constraint effect that is enforced. Between 0 and 1.
 
37
 
 
38
      :type: float
 
39
 
 
40
   .. attribute:: headtail
 
41
 
 
42
      Position of target between head and tail of the target bone: 0=head, 1=tail.
 
43
 
 
44
      :type: float.
 
45
 
 
46
      .. note::
 
47
      
 
48
         Only used if the target is a bone (i.e target object is an armature.
 
49
 
 
50
   .. attribute:: lin_error
 
51
 
 
52
      runtime linear error (in Blender units) on constraint at the current frame.
 
53
 
 
54
      This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
 
55
 
 
56
      :type: float
 
57
 
 
58
   .. attribute:: rot_error
 
59
 
 
60
      Runtime rotation error (in radiant) on constraint at the current frame.
 
61
 
 
62
      :type: float.
 
63
 
 
64
      This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
 
65
 
 
66
      It is only set if the constraint has a rotation part, for example, a CopyPose+Rotation IK constraint.
 
67
 
 
68
   .. attribute:: target
 
69
 
 
70
      Primary target object for the constraint. The position of this object in the GE will be used as target for the constraint.
 
71
 
 
72
      :type: :class:`KX_GameObject`.
 
73
 
 
74
   .. attribute:: subtarget
 
75
 
 
76
      Secondary target object for the constraint. The position of this object in the GE will be used as secondary target for the constraint.
 
77
 
 
78
      :type: :class:`KX_GameObject`.
 
79
 
 
80
      Currently this is only used for pole target on IK constraint.
 
81
 
 
82
   .. attribute:: active
 
83
 
 
84
      True if the constraint is active.
 
85
 
 
86
      :type: boolean
 
87
      
 
88
      .. note::
 
89
      
 
90
         An inactive constraint does not update lin_error and rot_error.
 
91
 
 
92
   .. attribute:: ik_weight
 
93
 
 
94
      Weight of the IK constraint between 0 and 1.
 
95
 
 
96
      Only defined for IK constraint.
 
97
 
 
98
      :type: float
 
99
 
 
100
   .. attribute:: ik_type
 
101
 
 
102
      Type of IK constraint, (read-only).
 
103
 
 
104
      Use one of :ref:`these constants<armatureconstraint-constants-ik-type>`.
 
105
      
 
106
      :type: integer.
 
107
 
 
108
   .. attribute:: ik_flag
 
109
 
 
110
      Combination of IK constraint option flags, read-only.
 
111
      
 
112
      Use one of :ref:`these constants<armatureconstraint-constants-ik-flag>`.
 
113
 
 
114
      :type: integer
 
115
 
 
116
   .. attribute:: ik_dist
 
117
 
 
118
      Distance the constraint is trying to maintain with target, only used when ik_type=CONSTRAINT_IK_DISTANCE.
 
119
 
 
120
      :type: float
 
121
 
 
122
   .. attribute:: ik_mode
 
123
 
 
124
      Use one of :ref:`these constants<armatureconstraint-constants-ik-mode>`.
 
125
      
 
126
      Additional mode for IK constraint. Currently only used for Distance constraint:
 
127
 
 
128
      :type: integer
 
129