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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libg3d-vector">
<refmeta>
<refentrytitle role="top_of_page" id="libg3d-vector.top_of_page">vector</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBG3D Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vector</refname>
<refpurpose>Vector manipulation and calculation</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libg3d-vector.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <g3d/vector.h>
typedef <link linkend="G3DVector">G3DVector</link>;
<link linkend="gboolean">gboolean</link> <link linkend="g3d-vector-normal">g3d_vector_normal</link> (<link linkend="G3DFloat">G3DFloat</link> ax,
<link linkend="G3DFloat">G3DFloat</link> ay,
<link linkend="G3DFloat">G3DFloat</link> az,
<link linkend="G3DFloat">G3DFloat</link> bx,
<link linkend="G3DFloat">G3DFloat</link> by,
<link linkend="G3DFloat">G3DFloat</link> bz,
<link linkend="G3DFloat">G3DFloat</link> *nx,
<link linkend="G3DFloat">G3DFloat</link> *ny,
<link linkend="G3DFloat">G3DFloat</link> *nz);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-vector-unify">g3d_vector_unify</link> (<link linkend="G3DFloat">G3DFloat</link> *nx,
<link linkend="G3DFloat">G3DFloat</link> *ny,
<link linkend="G3DFloat">G3DFloat</link> *nz);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-vector-transform">g3d_vector_transform</link> (<link linkend="G3DFloat">G3DFloat</link> *x,
<link linkend="G3DFloat">G3DFloat</link> *y,
<link linkend="G3DFloat">G3DFloat</link> *z,
<link linkend="G3DMatrix">G3DMatrix</link> *matrix);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libg3d-vector.description" role="desc">
<title role="desc.title">Description</title>
<para>
A vector is a one-dimensional array of floating point data.
</para>
<para>
Declare it as statically as:
</para>
<para>
G3DVector vector[3];
</para>
<para>
or allocate it dynamically with:
</para>
<para>
G3DVector *vector = g3d_vector_new(3, 1);</para>
<para>
</para>
</refsect1>
<refsect1 id="libg3d-vector.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="G3DVector" role="typedef">
<title>G3DVector</title>
<indexterm zone="G3DVector"><primary>G3DVector</primary></indexterm><programlisting>typedef G3DFloat G3DVector;
</programlisting>
<para>
Vector element type.</para>
<para>
</para></refsect2>
<refsect2 id="g3d-vector-normal" role="function">
<title>g3d_vector_normal ()</title>
<indexterm zone="g3d-vector-normal"><primary>g3d_vector_normal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_vector_normal (<link linkend="G3DFloat">G3DFloat</link> ax,
<link linkend="G3DFloat">G3DFloat</link> ay,
<link linkend="G3DFloat">G3DFloat</link> az,
<link linkend="G3DFloat">G3DFloat</link> bx,
<link linkend="G3DFloat">G3DFloat</link> by,
<link linkend="G3DFloat">G3DFloat</link> bz,
<link linkend="G3DFloat">G3DFloat</link> *nx,
<link linkend="G3DFloat">G3DFloat</link> *ny,
<link linkend="G3DFloat">G3DFloat</link> *nz);</programlisting>
<para>
calculate the normal from a plane defined by two vectors</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ax</parameter> :</term>
<listitem><simpara> x component first vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ay</parameter> :</term>
<listitem><simpara> y component first vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>az</parameter> :</term>
<listitem><simpara> z component first vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bx</parameter> :</term>
<listitem><simpara> x component second vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>by</parameter> :</term>
<listitem><simpara> y component second vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bz</parameter> :</term>
<listitem><simpara> z component second vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nx</parameter> :</term>
<listitem><simpara> x component resulting normal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ny</parameter> :</term>
<listitem><simpara> y component resulting normal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nz</parameter> :</term>
<listitem><simpara> z component resulting normal
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-vector-unify" role="function">
<title>g3d_vector_unify ()</title>
<indexterm zone="g3d-vector-unify"><primary>g3d_vector_unify</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_vector_unify (<link linkend="G3DFloat">G3DFloat</link> *nx,
<link linkend="G3DFloat">G3DFloat</link> *ny,
<link linkend="G3DFloat">G3DFloat</link> *nz);</programlisting>
<para>
Transforms the given vector to the unit vector.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nx</parameter> :</term>
<listitem><simpara> x component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ny</parameter> :</term>
<listitem><simpara> y component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nz</parameter> :</term>
<listitem><simpara> z component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-vector-transform" role="function">
<title>g3d_vector_transform ()</title>
<indexterm zone="g3d-vector-transform"><primary>g3d_vector_transform</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_vector_transform (<link linkend="G3DFloat">G3DFloat</link> *x,
<link linkend="G3DFloat">G3DFloat</link> *y,
<link linkend="G3DFloat">G3DFloat</link> *z,
<link linkend="G3DMatrix">G3DMatrix</link> *matrix);</programlisting>
<para>
Transforms the given vector corresponding to the given matrix</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>z</parameter> :</term>
<listitem><simpara> z component of vector
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>matrix</parameter> :</term>
<listitem><simpara> transformation matrix (4x4)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
