~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_ArmatureBone.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
* 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:
 
1
BL_ArmatureBone(PyObjectPlus)
 
2
=============================
 
3
 
 
4
.. module:: bge.types
 
5
 
 
6
base class --- :class:`PyObjectPlus`
 
7
 
 
8
.. class:: BL_ArmatureBone(PyObjectPlus)
 
9
 
 
10
   Proxy to Blender bone structure. All fields are read-only and comply to RNA names.
 
11
   All space attribute correspond to the rest pose.
 
12
 
 
13
   .. attribute:: name
 
14
 
 
15
      bone name.
 
16
 
 
17
      :type: string
 
18
 
 
19
   .. attribute:: connected
 
20
 
 
21
      true when the bone head is struck to the parent's tail.
 
22
 
 
23
      :type: boolean
 
24
 
 
25
   .. attribute:: hinge
 
26
 
 
27
      true when bone doesn't inherit rotation or scale from parent bone.
 
28
 
 
29
      :type: boolean
 
30
 
 
31
   .. attribute:: inherit_scale
 
32
 
 
33
      true when bone inherits scaling from parent bone.
 
34
 
 
35
      :type: boolean
 
36
 
 
37
   .. attribute:: bbone_segments
 
38
 
 
39
      number of B-bone segments.
 
40
 
 
41
      :type: integer
 
42
 
 
43
   .. attribute:: roll
 
44
 
 
45
      bone rotation around head-tail axis.
 
46
 
 
47
      :type: float
 
48
 
 
49
   .. attribute:: head
 
50
 
 
51
      location of head end of the bone in parent bone space.
 
52
 
 
53
      :type: vector [x, y, z]
 
54
 
 
55
   .. attribute:: tail
 
56
 
 
57
      location of head end of the bone in parent bone space.
 
58
 
 
59
      :type: vector [x, y, z]
 
60
 
 
61
   .. attribute:: length
 
62
 
 
63
      bone length.
 
64
 
 
65
      :type: float
 
66
 
 
67
   .. attribute:: arm_head
 
68
 
 
69
      location of head end of the bone in armature space.
 
70
 
 
71
      :type: vector [x, y, z]
 
72
 
 
73
   .. attribute:: arm_tail
 
74
 
 
75
      location of tail end of the bone in armature space.
 
76
 
 
77
      :type: vector [x, y, z]
 
78
 
 
79
   .. attribute:: arm_mat
 
80
 
 
81
      matrix of the bone head in armature space.
 
82
 
 
83
      :type: matrix [4][4]
 
84
 
 
85
      .. note::
 
86
      
 
87
         This matrix has no scale part. 
 
88
 
 
89
   .. attribute:: bone_mat
 
90
 
 
91
      rotation matrix of the bone in parent bone space.
 
92
 
 
93
      :type: matrix [3][3]
 
94
 
 
95
   .. attribute:: parent
 
96
 
 
97
      parent bone, or None for root bone.
 
98
 
 
99
      :type: :class:`BL_ArmatureBone`
 
100
 
 
101
   .. attribute:: children
 
102
 
 
103
      list of bone's children.
 
104
 
 
105
      :type: list of :class:`BL_ArmatureBone`