File: Trans_Rotate.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (52 lines) | stat: -rw-r--r-- 2,094 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
  SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>Trans_Rotate</title>
    <category>Arithmetics</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>array</rtype>
      <params>
        <param>
          <type>int</type>
          <name>angle</name>
          <desc>Rotation angle. When looking into the same direction as the rotation axis then positive angles do anti-clockwise rotation and negative angles do clockwise rotation.</desc>
        </param>
        <param>
          <type>int</type>
          <name>rx</name>
          <desc>X coordinate of the rotation axis.</desc>
        </param>
        <param>
          <type>int</type>
          <name>ry</name>
          <desc>Y coordinate of the rotation axis.</desc>
        </param>
        <param>
          <type>int</type>
          <name>rz</name>
          <desc>Z coordinate of the rotation axis.</desc>
        </param>
      </params>
    </syntax>
    <desc>Returns a 3x4 rotation matrix around the axis given by the vector (<code>rx</code>, <code>ry</code>, <code>rz</code>) by <code>angle</code> degrees. It can be used as a transformation for <funclink>AttachMesh</funclink> or for the "PictureTransformation" or "MeshTransformation" properties (see <emlink href="definition/meshes.html#Picture">Meshes</emlink>).</desc>
    <examples>
      <example>
        <code><funclink>this</funclink>[&quot;PictureTransformation&quot;] = <funclink>Trans_Rotate</funclink>(20, 0, 1, 0);</code>
        <text>Rotates the picture graphics of the calling object by 20 degrees around the Y axis.</text>
      </example>
    </examples>
    <related>
      <funclink>Trans_Identity</funclink>
      <funclink>Trans_Translate</funclink>
      <funclink>Trans_Scale</funclink>
      <funclink>Trans_Mul</funclink>
      <funclink>AttachMesh</funclink>
      <funclink>SetAttachTransform</funclink>
    </related>
  </func>
  <author>Clonk-Karl</author><date>2010-04</date>
</funcs>