Operator Reference
hom_mat3d_scale (Operator)
hom_mat3d_scale
— Add a scaling to a homogeneous 3D transformation matrix.
Signature
Description
hom_mat3d_scale
adds a scaling by the scale factors Sx
,
Sy
, and Sz
to the homogeneous 3D transformation matrix
HomMat3D
and returns the resulting matrix in HomMat3DScale
.
The scaling is described by a 3×3 scaling matrix
S. It is performed relative to the global (i.e.,
fixed) coordinate system; this corresponds to the following chain of
transformation matrices:
The point (Px
,Py
,Pz
) is the fixed point of the
transformation, i.e., this point remains unchanged when transformed using
HomMat3DScale
. To obtain this behavior, first a translation is added
to the input transformation matrix that moves the fixed point onto the origin
of the global coordinate system. Then, the scaling is added, and finally a
translation that moves the fixed point back to its original position. This
corresponds to the following chain of transformations:
To perform the transformation in the local coordinate system, i.e.,
the one described by HomMat3D
, use
hom_mat3d_scale_local
.
Attention
Note that homogeneous matrices are stored row-by-row as a tuple; the last row is usually not stored because it is identical for all homogeneous matrices that describe an affine transformation. For example, the homogeneous matrix is stored as the tuple [ra, rb, rc, td, re, rf, rg, th, ri, rj, rk, tl]. However, it is also possible to process full 4×4 matrices, which represent a projective 4D transformation.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
HomMat3D
(input_control) hom_mat3d →
(real)
Input transformation matrix.
Sx
(input_control) number →
(real / integer)
Scale factor along the x-axis.
Default: 2
Suggested values: 0.125, 0.25, 0.5, 1, 2, 4, 8, 112
Restriction:
Sx != 0
Sy
(input_control) number →
(real / integer)
Scale factor along the y-axis.
Default: 2
Suggested values: 0.125, 0.25, 0.5, 1, 2, 4, 8, 112
Restriction:
Sy != 0
Sz
(input_control) number →
(real / integer)
Scale factor along the z-axis.
Default: 2
Suggested values: 0.125, 0.25, 0.5, 1, 2, 4, 8, 112
Restriction:
Sz != 0
Px
(input_control) point3d.x →
(real / integer)
Fixed point of the transformation (x coordinate).
Default: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
Py
(input_control) point3d.y →
(real / integer)
Fixed point of the transformation (y coordinate).
Default: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
Pz
(input_control) point3d.z →
(real / integer)
Fixed point of the transformation (z coordinate).
Default: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
HomMat3DScale
(output_control) hom_mat3d →
(real)
Output transformation matrix.
Result
hom_mat3d_scale
returns 2 (
H_MSG_TRUE)
if all three scale factors are not
0. If necessary, an exception is raised.
Possible Predecessors
hom_mat3d_identity
,
hom_mat3d_translate
,
hom_mat3d_scale
,
hom_mat3d_rotate
Possible Successors
hom_mat3d_translate
,
hom_mat3d_scale
,
hom_mat3d_rotate
See also
hom_mat3d_invert
,
hom_mat3d_identity
,
hom_mat3d_scale_local
,
pose_to_hom_mat3d
,
hom_mat3d_to_pose
,
hom_mat3d_compose
Module
Foundation