hom_mat3d_rotate T_hom_mat3d_rotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate (Operator)
Name
hom_mat3d_rotate T_hom_mat3d_rotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate
— Add a rotation to a homogeneous 3D transformation matrix.
Signature
void HomMat3dRotate (const HTuple& HomMat3D , const HTuple& Phi , const HTuple& Axis , const HTuple& Px , const HTuple& Py , const HTuple& Pz , HTuple* HomMat3DRotate )
HHomMat3D HHomMat3D ::HomMat3dRotate (const HTuple& Phi , const HTuple& Axis , const HTuple& Px , const HTuple& Py , const HTuple& Pz ) const
HHomMat3D HHomMat3D ::HomMat3dRotate (double Phi , const HString& Axis , double Px , double Py , double Pz ) const
HHomMat3D HHomMat3D ::HomMat3dRotate (double Phi , const char* Axis , double Px , double Py , double Pz ) const
HHomMat3D HHomMat3D ::HomMat3dRotate (double Phi , const wchar_t* Axis , double Px , double Py , double Pz ) const
(Windows only)
static void HOperatorSet .HomMat3dRotate (HTuple homMat3D , HTuple phi , HTuple axis , HTuple px , HTuple py , HTuple pz , out HTuple homMat3DRotate )
HHomMat3D HHomMat3D .HomMat3dRotate (HTuple phi , HTuple axis , HTuple px , HTuple py , HTuple pz )
HHomMat3D HHomMat3D .HomMat3dRotate (double phi , string axis , double px , double py , double pz )
def hom_mat3d_rotate (hom_mat_3d : Sequence[float], phi : Union[float, int], axis : MaybeSequence[Union[str, float, int]], px : Union[float, int], py : Union[float, int], pz : Union[float, int]) -> Sequence[float]
Description
hom_mat3d_rotate hom_mat3d_rotate HomMat3dRotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate
adds a rotation by the angle Phi Phi Phi Phi phi phi
around the
axis passed in the parameter Axis Axis Axis Axis axis axis
to the homogeneous 3D
transformation matrix HomMat3D HomMat3D HomMat3D HomMat3D homMat3D hom_mat_3d
and returns the resulting matrix in
HomMat3DRotate HomMat3DRotate HomMat3DRotate HomMat3DRotate homMat3DRotate hom_mat_3drotate
. The axis can be specified by passing the strings
'x', 'y', or 'z', or by passing a vector [x,y,z] as a tuple.
The rotation is described by a 3×3 rotation matrix
R. It is performed relative to the global
(i.e., fixed) coordinate system; this corresponds to the following chain of
transformation matrices:
Axis Axis Axis Axis axis axis
= 'x' "x" "x" "x" "x" "x" :
Axis Axis Axis Axis axis axis
= 'y' "y" "y" "y" "y" "y" :
Axis Axis Axis Axis axis axis
= 'z' "z" "z" "z" "z" "z" :
Axis Axis Axis Axis axis axis
= [x,y,z] :
The point (Px Px Px Px px px
,Py Py Py Py py py
,Pz Pz Pz Pz pz pz
) is the fixed point of the
transformation, i.e., this point remains unchanged when transformed using
HomMat3DRotate HomMat3DRotate HomMat3DRotate HomMat3DRotate homMat3DRotate hom_mat_3drotate
. 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 rotation 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 HomMat3D HomMat3D HomMat3D homMat3D hom_mat_3d
, use
hom_mat3d_rotate_local hom_mat3d_rotate_local HomMat3dRotateLocal HomMat3dRotateLocal HomMat3dRotateLocal hom_mat3d_rotate_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 HomMat3D HomMat3D HomMat3D homMat3D hom_mat_3d
(input_control) hom_mat3d →
HHomMat3D , HTuple Sequence[float] HTuple Htuple (real) (double ) (double ) (double )
Input transformation matrix.
Phi Phi Phi Phi phi phi
(input_control) angle.rad →
HTuple Union[float, int] HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Rotation angle.
Default value: 0.78
Suggested values: 0.1, 0.2, 0.3, 0.4, 0.78, 1.57, 3.14
Typical range of values: 0
≤
Phi
Phi
Phi
Phi
phi
phi
≤
6.28318530718
Axis Axis Axis Axis axis axis
(input_control) string(-array) →
HTuple MaybeSequence[Union[str, float, int]] HTuple Htuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Axis, to be rotated around.
Default value:
'x'
"x"
"x"
"x"
"x"
"x"
Suggested values: 'x' "x" "x" "x" "x" "x" , 'y' "y" "y" "y" "y" "y" , 'z' "z" "z" "z" "z" "z"
Px Px Px Px px px
(input_control) point3d.x →
HTuple Union[float, int] HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Fixed point of the transformation (x coordinate).
Default value: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
Py Py Py Py py py
(input_control) point3d.y →
HTuple Union[float, int] HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Fixed point of the transformation (y coordinate).
Default value: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
Pz Pz Pz Pz pz pz
(input_control) point3d.z →
HTuple Union[float, int] HTuple Htuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Fixed point of the transformation (z coordinate).
Default value: 0
Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024
HomMat3DRotate HomMat3DRotate HomMat3DRotate HomMat3DRotate homMat3DRotate hom_mat_3drotate
(output_control) hom_mat3d →
HHomMat3D , HTuple Sequence[float] HTuple Htuple (real) (double ) (double ) (double )
Output transformation matrix.
Result
If the parameters are valid, the operator hom_mat3d_rotate hom_mat3d_rotate HomMat3dRotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate
returns
2 (H_MSG_TRUE ). If necessary, an exception is raised.
Possible Predecessors
hom_mat3d_identity hom_mat3d_identity HomMat3dIdentity HomMat3dIdentity HomMat3dIdentity hom_mat3d_identity
,
hom_mat3d_translate hom_mat3d_translate HomMat3dTranslate HomMat3dTranslate HomMat3dTranslate hom_mat3d_translate
,
hom_mat3d_scale hom_mat3d_scale HomMat3dScale HomMat3dScale HomMat3dScale hom_mat3d_scale
,
hom_mat3d_rotate hom_mat3d_rotate HomMat3dRotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate
Possible Successors
hom_mat3d_translate hom_mat3d_translate HomMat3dTranslate HomMat3dTranslate HomMat3dTranslate hom_mat3d_translate
,
hom_mat3d_scale hom_mat3d_scale HomMat3dScale HomMat3dScale HomMat3dScale hom_mat3d_scale
,
hom_mat3d_rotate hom_mat3d_rotate HomMat3dRotate HomMat3dRotate HomMat3dRotate hom_mat3d_rotate
See also
hom_mat3d_invert hom_mat3d_invert HomMat3dInvert HomMat3dInvert HomMat3dInvert hom_mat3d_invert
,
hom_mat3d_identity hom_mat3d_identity HomMat3dIdentity HomMat3dIdentity HomMat3dIdentity hom_mat3d_identity
,
hom_mat3d_rotate_local hom_mat3d_rotate_local HomMat3dRotateLocal HomMat3dRotateLocal HomMat3dRotateLocal hom_mat3d_rotate_local
,
pose_to_hom_mat3d pose_to_hom_mat3d PoseToHomMat3d PoseToHomMat3d PoseToHomMat3d pose_to_hom_mat3d
,
hom_mat3d_to_pose hom_mat3d_to_pose HomMat3dToPose HomMat3dToPose HomMat3dToPose hom_mat3d_to_pose
,
hom_mat3d_compose hom_mat3d_compose HomMat3dCompose HomMat3dCompose HomMat3dCompose hom_mat3d_compose
Module
Foundation