This is the 3d-transforms Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:29:10 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
3d-transformsA utility library implementing a common structure to encapsulate spatial transformations
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/3d-transforms.git)
zlib
1.0.0
documentation-utils (system).
3d-vectors (system).
3d-matrices (system).
3d-quaternions (system).
package.lisp (file).
struct.lisp (file).
ops.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
3d-transforms/3d-transforms.asd3d-transforms/package.lisp3d-transforms/struct.lisp3d-transforms/ops.lisp3d-transforms/documentation.lisp3d-transforms/struct.lisppackage.lisp (file).
3d-transforms (system).
copy-transform (function).
make-load-form (method).
print-object (method).
tlocation (reader).
(setf tlocation) (writer).
transform (function).
transform (structure).
transform-p (function).
trotation (reader).
(setf trotation) (writer).
tscaling (reader).
(setf tscaling) (writer).
3d-transforms/ops.lispstruct.lisp (file).
3d-transforms (system).
nt+ (function).
t*p (function).
t*p-inv (function).
t*v (function).
t+ (function).
t<- (function).
t= (function).
tdquat (function).
tfrom-dquat (function).
tfrom-mat (function).
tinv (function).
tmat4 (function).
tmix (function).
tmove (function).
tmove-by (function).
toffset (function).
toffset-by (function).
trotate (function).
trotate-by (function).
tscale (function).
tscale-by (function).
tx (function).
ty (function).
tz (function).
t~= (function).
3d-transforms/documentation.lispops.lisp (file).
3d-transforms (system).
Packages are listed by definition order.
org.shirakumo.flare.transform3d-matrices.
3d-vectors.
common-lisp.
org.shirakumo.flare.quaternion.
copy-transform (function).
nt+ (function).
t*p (function).
t*p-inv (function).
t*v (function).
t+ (function).
t<- (function).
t= (function).
tdquat (function).
tfrom-dquat (function).
tfrom-mat (function).
tinv (function).
tlocation (reader).
(setf tlocation) (writer).
tmat4 (function).
tmix (function).
tmove (function).
tmove-by (function).
toffset (function).
toffset-by (function).
transform (function).
transform (structure).
transform-p (function).
trotate (function).
trotate-by (function).
trotation (reader).
(setf trotation) (writer).
tscale (function).
tscale-by (function).
tscaling (reader).
(setf tscaling) (writer).
tx (function).
ty (function).
tz (function).
t~= (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Creates a deep copy of the transform.
The returned transform does NOT share its location, scale, or rotation
components.
See TRANSFORM (type)
Modifies the first transform such that it encompasses the transform B on top of itself.
See T+
See TRANSFORM (type)
Applies the transform to the given point.
This transforms the point completely by the coordinate system
represented by the transform.
See T*P
See VEC3 (type)
See TRANSFORM (type)
Applies the transform to the given vector.
This scales and rotates the vector, but does not translate it.
See T*P
See VEC3 (type)
See TRANSFORM (type)
Returns a transform that encompasses the combination of transform B on top of A.
This is particularly important in regard to the location expressed by
the transform, as the rotation has to be taken into account properly.
See NT+
See TRANSFORM (type)
Copies the transform information into the target from the source.
See TRANSFORM (type)
Compares both transforms component-wise and returns true if each component is v=/q=.
See TRANSFORM (type)
Returns a transform that represents the same linear transformation as the dual-quaternion.
See DQUAT (type)
See TRANSFORM (type)
Returns a transform that represents the same linear transformation as the matrix, if possible.
See MAT4 (type)
See TRANSFORM (type)
Returns the inverses of the given transform.
This is not a precise inversion, instead performing an approximation
for speed.
See TRANSFORM (type)
Accesses the location or position component of the transform.
See TRANSFORM (type)
Returns a 4x4 matrix that encompasses the same transformation as the transform’s components encompass.
See MAT4 (type)
See TRANSFORM (type)
Returns a new transform that is the linear interpolation between the two at the given point.
X should be a REAL in the range of [0,1].
See TRANSFORM (type)
Moves the transform space by the given vector.
This is equivalent to
(nt+ a (transform v))
Note that as a consequence, this is relative to the rotation
encompassed by the transform.
See TMOVE-BY
See TOFFSET
See VEC3 (type)
See TRANSFORM (type)
Moves the transform space by the given amount in each axis.
This is equivalent to
(nt+ a (transform (vec x y z)))
Note that as a consequence, this is relative to the rotation
encompassed by the transform.
See TMOVE
See TOFFSET-BY
See VEC3 (type)
See TRANSFORM (type)
Offsets the transform in the basic cartesian space by the given vector.
This is equivalent to
(nv+ (tlocation a) v)
Note that as a consequence, this is NOT relative to the rotation
encompassed by the transform.
See TMOVE
See TOFFSET-BY
See VEC3 (type)
See TRANSFORM (type)
Offsets the transform in the basic cartesian space by the given amount in each axis.
This is equivalent to
(nv+ (tlocation a) (vec x y z))
Note that as a consequence, this is NOT relative to the rotation
encompassed by the transform.
See TMOVE
See TOFFSET-BY
See VEC3 (type)
See TRANSFORM (type)
Creates a new transform.
Note that the given location, scale, and rotation are shared and NOT copied. Any change to them will thus reflect within the transform.
If not passed, they default to "neutral" values, meaning:
0,0,0 for location,
1,1,1 for scale,
0,0,0,1 for rotation
See TRANSFORM (type)
Returns true if the given value is a TRANSFORM structure.
See TRANSFORM (type)
Rotates the transform space by the given quaternion.
This is equivalent to
(nq* (trotation a) q)
See TROTATE-BY
See QUAT (type)
See TRANSFORM (type)
Rotates the transform space around the given axis by the given angle.
This is equivalent to
(nq* (trotation a) (qfrom-angle axis angle))
See TROTATE
See QUAT (type)
See TRANSFORM (type)
Accesses the rotational component of the transform.
See TRANSFORM (type)
Scales the transform space by the given vector.
This is equivalent to
(nv+ (tscaling a) v)
See TSCALE-BY
See VEC3 (type)
See TRANSFORM (type)
Scales the transform space by the given amount in each axis.
This is equivalent to
(nv+ (tscaling a) (vec x y z))
See TSCALE
See VEC3 (type)
See TRANSFORM (type)
Accesses the scaling component of the transform.
See TRANSFORM (type)
Returns a unit vector along X in the transform’s local coordinate system.
See T*N
See 3D-VECTORS:+VX+
See TRANSFORM (type)
Returns a unit vector along Y in the transform’s local coordinate system.
See T*N
See 3D-VECTORS:+VY+
See TRANSFORM (type)
Compares both transforms component-wise and returns true if each component is v~=/qequal.
See TRANSFORM (type)
Encapsulation of a spatial transform.
A transform holds a translation, rotation, and scaling.
By nesting transforms you can create relative coordinate systems.
A transform is readable and dumpable, meaning it can be inlined at
compile-time and printed and read back.
See TRANSFORM (function)
See TRANSFORM-P
See COPY-TRANSFORM
See TLOCATION
See TSCALING
See TROTATION
See T+
See NT+
See T=
See T~=
See T*V
See T*P
See TINV
See TMIX
See TMAT4
See TFROM-MAT
See TDQUAT
See TFROM-DQUAT
See TMOVE
See TMOVE-BY
See TOFFSET
See TOFFSET-BY
See TROTATE
See TROTATE-BY
See TSCALE
See TSCALE-BY
| Jump to: | (
C F M N P T |
|---|
| Jump to: | (
C F M N P T |
|---|
| Jump to: | L R S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| L | |||
location: | Public structures | ||
| | |||
| R | |||
rotation: | Public structures | ||
| | |||
| S | |||
scaling: | Public structures | ||
Slot, location: | Public structures | ||
Slot, rotation: | Public structures | ||
Slot, scaling: | Public structures | ||
| | |||
| Jump to: | L R S |
|---|
| Jump to: | 3
D F O P S T |
|---|
| Jump to: | 3
D F O P S T |
|---|