dual_quat_trans_line_3dT_dual_quat_trans_line_3dDualQuatTransLine3dDualQuatTransLine3ddual_quat_trans_line_3d (Operator)

Name

dual_quat_trans_line_3dT_dual_quat_trans_line_3dDualQuatTransLine3dDualQuatTransLine3ddual_quat_trans_line_3d — Transform a 3D line with a unit dual quaternion.

Signature

dual_quat_trans_line_3d( : : DualQuaternion, LineFormat, LineDirectionX, LineDirectionY, LineDirectionZ, LineMomentOrPointX, LineMomentOrPointY, LineMomentOrPointZ : TransLineDirectionX, TransLineDirectionY, TransLineDirectionZ, TransLineMomentOrPointX, TransLineMomentOrPointY, TransLineMomentOrPointZ)

Herror T_dual_quat_trans_line_3d(const Htuple DualQuaternion, const Htuple LineFormat, const Htuple LineDirectionX, const Htuple LineDirectionY, const Htuple LineDirectionZ, const Htuple LineMomentOrPointX, const Htuple LineMomentOrPointY, const Htuple LineMomentOrPointZ, Htuple* TransLineDirectionX, Htuple* TransLineDirectionY, Htuple* TransLineDirectionZ, Htuple* TransLineMomentOrPointX, Htuple* TransLineMomentOrPointY, Htuple* TransLineMomentOrPointZ)

void DualQuatTransLine3d(const HTuple& DualQuaternion, const HTuple& LineFormat, const HTuple& LineDirectionX, const HTuple& LineDirectionY, const HTuple& LineDirectionZ, const HTuple& LineMomentOrPointX, const HTuple& LineMomentOrPointY, const HTuple& LineMomentOrPointZ, HTuple* TransLineDirectionX, HTuple* TransLineDirectionY, HTuple* TransLineDirectionZ, HTuple* TransLineMomentOrPointX, HTuple* TransLineMomentOrPointY, HTuple* TransLineMomentOrPointZ)

void HDualQuaternion::DualQuatTransLine3d(const HString& LineFormat, const HTuple& LineDirectionX, const HTuple& LineDirectionY, const HTuple& LineDirectionZ, const HTuple& LineMomentOrPointX, const HTuple& LineMomentOrPointY, const HTuple& LineMomentOrPointZ, HTuple* TransLineDirectionX, HTuple* TransLineDirectionY, HTuple* TransLineDirectionZ, HTuple* TransLineMomentOrPointX, HTuple* TransLineMomentOrPointY, HTuple* TransLineMomentOrPointZ) const

void HDualQuaternion::DualQuatTransLine3d(const HString& LineFormat, double LineDirectionX, double LineDirectionY, double LineDirectionZ, double LineMomentOrPointX, double LineMomentOrPointY, double LineMomentOrPointZ, double* TransLineDirectionX, double* TransLineDirectionY, double* TransLineDirectionZ, double* TransLineMomentOrPointX, double* TransLineMomentOrPointY, double* TransLineMomentOrPointZ) const

void HDualQuaternion::DualQuatTransLine3d(const char* LineFormat, double LineDirectionX, double LineDirectionY, double LineDirectionZ, double LineMomentOrPointX, double LineMomentOrPointY, double LineMomentOrPointZ, double* TransLineDirectionX, double* TransLineDirectionY, double* TransLineDirectionZ, double* TransLineMomentOrPointX, double* TransLineMomentOrPointY, double* TransLineMomentOrPointZ) const

void HDualQuaternion::DualQuatTransLine3d(const wchar_t* LineFormat, double LineDirectionX, double LineDirectionY, double LineDirectionZ, double LineMomentOrPointX, double LineMomentOrPointY, double LineMomentOrPointZ, double* TransLineDirectionX, double* TransLineDirectionY, double* TransLineDirectionZ, double* TransLineMomentOrPointX, double* TransLineMomentOrPointY, double* TransLineMomentOrPointZ) const   (Windows only)

static void HOperatorSet.DualQuatTransLine3d(HTuple dualQuaternion, HTuple lineFormat, HTuple lineDirectionX, HTuple lineDirectionY, HTuple lineDirectionZ, HTuple lineMomentOrPointX, HTuple lineMomentOrPointY, HTuple lineMomentOrPointZ, out HTuple transLineDirectionX, out HTuple transLineDirectionY, out HTuple transLineDirectionZ, out HTuple transLineMomentOrPointX, out HTuple transLineMomentOrPointY, out HTuple transLineMomentOrPointZ)

void HDualQuaternion.DualQuatTransLine3d(string lineFormat, HTuple lineDirectionX, HTuple lineDirectionY, HTuple lineDirectionZ, HTuple lineMomentOrPointX, HTuple lineMomentOrPointY, HTuple lineMomentOrPointZ, out HTuple transLineDirectionX, out HTuple transLineDirectionY, out HTuple transLineDirectionZ, out HTuple transLineMomentOrPointX, out HTuple transLineMomentOrPointY, out HTuple transLineMomentOrPointZ)

void HDualQuaternion.DualQuatTransLine3d(string lineFormat, double lineDirectionX, double lineDirectionY, double lineDirectionZ, double lineMomentOrPointX, double lineMomentOrPointY, double lineMomentOrPointZ, out double transLineDirectionX, out double transLineDirectionY, out double transLineDirectionZ, out double transLineMomentOrPointX, out double transLineMomentOrPointY, out double transLineMomentOrPointZ)

def dual_quat_trans_line_3d(dual_quaternion: Sequence[Union[float, int]], line_format: str, line_direction_x: MaybeSequence[Union[float, int]], line_direction_y: MaybeSequence[Union[float, int]], line_direction_z: MaybeSequence[Union[float, int]], line_moment_or_point_x: MaybeSequence[Union[float, int]], line_moment_or_point_y: MaybeSequence[Union[float, int]], line_moment_or_point_z: MaybeSequence[Union[float, int]]) -> Tuple[Sequence[Union[float, int]], Sequence[Union[float, int]], Sequence[Union[float, int]], Sequence[Union[float, int]], Sequence[Union[float, int]], Sequence[Union[float, int]]]

def dual_quat_trans_line_3d_s(dual_quaternion: Sequence[Union[float, int]], line_format: str, line_direction_x: MaybeSequence[Union[float, int]], line_direction_y: MaybeSequence[Union[float, int]], line_direction_z: MaybeSequence[Union[float, int]], line_moment_or_point_x: MaybeSequence[Union[float, int]], line_moment_or_point_y: MaybeSequence[Union[float, int]], line_moment_or_point_z: MaybeSequence[Union[float, int]]) -> Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]

Description

The operator dual_quat_trans_line_3ddual_quat_trans_line_3dDualQuatTransLine3dDualQuatTransLine3dDualQuatTransLine3ddual_quat_trans_line_3d transforms a 3D line that is represented by its Plücker coordinates by a 3D rigid transformation that is given by the unit dual quaternion DualQuaternionDualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion.

For a brief introduction to dual quaternions, Plücker coordinates and the used notation, see the documentation of this chapter (Transformations / Dual Quaternions).

A line in Plücker coordinates is given by its direction with and its moment with . It can be written as a dual quaternion with 0 scalar parts. The line can be transformed by the 3D rigid transformation that is represented by the unit dual quaternion very conveniently: The resulting dual quaternion also has a 0 scalar part and directly contains the direction and the moment of the transformed line in its vector parts.

The direction of the line must be passed in LineDirectionXLineDirectionXLineDirectionXLineDirectionXlineDirectionXline_direction_x, LineDirectionYLineDirectionYLineDirectionYLineDirectionYlineDirectionYline_direction_y, and LineDirectionZLineDirectionZLineDirectionZLineDirectionZlineDirectionZline_direction_z. Note that the length of the direction vector must be 1 to get meaningful results, i.e., .

If LineFormatLineFormatLineFormatLineFormatlineFormatline_format is set to 'moment'"moment""moment""moment""moment""moment", the moment of the line must be passed in LineMomentOrPointXLineMomentOrPointXLineMomentOrPointXLineMomentOrPointXlineMomentOrPointXline_moment_or_point_x, LineMomentOrPointYLineMomentOrPointYLineMomentOrPointYLineMomentOrPointYlineMomentOrPointYline_moment_or_point_y, and LineMomentOrPointZLineMomentOrPointZLineMomentOrPointZLineMomentOrPointZlineMomentOrPointZline_moment_or_point_z.

If LineFormatLineFormatLineFormatLineFormatlineFormatline_format is set to 'point'"point""point""point""point""point", instead of the moment an arbitrary point on the line can be passed in LineMomentOrPointXLineMomentOrPointXLineMomentOrPointXLineMomentOrPointXlineMomentOrPointXline_moment_or_point_x, LineMomentOrPointYLineMomentOrPointYLineMomentOrPointYLineMomentOrPointYlineMomentOrPointYline_moment_or_point_y, and LineMomentOrPointZLineMomentOrPointZLineMomentOrPointZLineMomentOrPointZlineMomentOrPointZline_moment_or_point_z.

The parameters of the transformed line are returned in TransLineDirectionXTransLineDirectionXTransLineDirectionXTransLineDirectionXtransLineDirectionXtrans_line_direction_x, TransLineDirectionYTransLineDirectionYTransLineDirectionYTransLineDirectionYtransLineDirectionYtrans_line_direction_y, TransLineDirectionZTransLineDirectionZTransLineDirectionZTransLineDirectionZtransLineDirectionZtrans_line_direction_z, TransLineMomentOrPointXTransLineMomentOrPointXTransLineMomentOrPointXTransLineMomentOrPointXtransLineMomentOrPointXtrans_line_moment_or_point_x, TransLineMomentOrPointYTransLineMomentOrPointYTransLineMomentOrPointYTransLineMomentOrPointYtransLineMomentOrPointYtrans_line_moment_or_point_y, and TransLineMomentOrPointZTransLineMomentOrPointZTransLineMomentOrPointZTransLineMomentOrPointZtransLineMomentOrPointZtrans_line_moment_or_point_z in the format that was specified in LineFormatLineFormatLineFormatLineFormatlineFormatline_format. If LineFormatLineFormatLineFormatLineFormatlineFormatline_format is set to 'point'"point""point""point""point""point", the point on the line that is closest to the origin of the coordinate system is returned.

Attention

dual_quat_trans_line_3ddual_quat_trans_line_3dDualQuatTransLine3dDualQuatTransLine3dDualQuatTransLine3ddual_quat_trans_line_3d returns meaningful results only if DualQuaternionDualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion is a unit dual quaternion and the length of the line direction is 1.

Execution Information

Parameters

DualQuaternionDualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion (input_control)  dual_quaternion HDualQuaternion, HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Unit dual quaternion representing the transformation.

LineFormatLineFormatLineFormatLineFormatlineFormatline_format (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Format of the line parameters.

Default value: 'moment' "moment" "moment" "moment" "moment" "moment"

List of values: 'moment'"moment""moment""moment""moment""moment", 'point'"point""point""point""point""point"

LineDirectionXLineDirectionXLineDirectionXLineDirectionXlineDirectionXline_direction_x (input_control)  point3d.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

X component of the direction vector of the line.

LineDirectionYLineDirectionYLineDirectionYLineDirectionYlineDirectionYline_direction_y (input_control)  point3d.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Y component of the direction vector of the line.

LineDirectionZLineDirectionZLineDirectionZLineDirectionZlineDirectionZline_direction_z (input_control)  point3d.z(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Z component of the direction vector of the line.

LineMomentOrPointXLineMomentOrPointXLineMomentOrPointXLineMomentOrPointXlineMomentOrPointXline_moment_or_point_x (input_control)  point3d.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

X component of the moment vector or a point on the line.

LineMomentOrPointYLineMomentOrPointYLineMomentOrPointYLineMomentOrPointYlineMomentOrPointYline_moment_or_point_y (input_control)  point3d.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Y component of the moment vector or a point on the line.

LineMomentOrPointZLineMomentOrPointZLineMomentOrPointZLineMomentOrPointZlineMomentOrPointZline_moment_or_point_z (input_control)  point3d.z(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Z component of the moment vector or a point on the line.

TransLineDirectionXTransLineDirectionXTransLineDirectionXTransLineDirectionXtransLineDirectionXtrans_line_direction_x (output_control)  point3d.x(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

X component of the direction vector of the transformed line.

TransLineDirectionYTransLineDirectionYTransLineDirectionYTransLineDirectionYtransLineDirectionYtrans_line_direction_y (output_control)  point3d.y(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Y component of the direction vector of the transformed line.

TransLineDirectionZTransLineDirectionZTransLineDirectionZTransLineDirectionZtransLineDirectionZtrans_line_direction_z (output_control)  point3d.z(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Z component of the direction vector of the transformed line.

TransLineMomentOrPointXTransLineMomentOrPointXTransLineMomentOrPointXTransLineMomentOrPointXtransLineMomentOrPointXtrans_line_moment_or_point_x (output_control)  point3d.x(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

X component of the moment vector or a point on the transformed line.

TransLineMomentOrPointYTransLineMomentOrPointYTransLineMomentOrPointYTransLineMomentOrPointYtransLineMomentOrPointYtrans_line_moment_or_point_y (output_control)  point3d.y(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Y component of the moment vector or a point on the transformed line.

TransLineMomentOrPointZTransLineMomentOrPointZTransLineMomentOrPointZTransLineMomentOrPointZtransLineMomentOrPointZtrans_line_moment_or_point_z (output_control)  point3d.z(-array) HTupleSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Z component of the moment vector or a point on the transformed line.

Possible Successors

dual_quat_composedual_quat_composeDualQuatComposeDualQuatComposeDualQuatComposedual_quat_compose, dual_quat_conjugatedual_quat_conjugateDualQuatConjugateDualQuatConjugateDualQuatConjugatedual_quat_conjugate, pose_to_dual_quatpose_to_dual_quatPoseToDualQuatPoseToDualQuatPoseToDualQuatpose_to_dual_quat

Alternatives

affine_trans_point_3daffine_trans_point_3dAffineTransPoint3dAffineTransPoint3dAffineTransPoint3daffine_trans_point_3d

See also

dual_quat_to_hom_mat3ddual_quat_to_hom_mat3dDualQuatToHomMat3dDualQuatToHomMat3dDualQuatToHomMat3ddual_quat_to_hom_mat3d, dual_quat_to_screwdual_quat_to_screwDualQuatToScrewDualQuatToScrewDualQuatToScrewdual_quat_to_screw, dual_quat_to_posedual_quat_to_poseDualQuatToPoseDualQuatToPoseDualQuatToPosedual_quat_to_pose, dual_quat_normalizedual_quat_normalizeDualQuatNormalizeDualQuatNormalizeDualQuatNormalizedual_quat_normalize, serialize_dual_quatserialize_dual_quatSerializeDualQuatSerializeDualQuatSerializeDualQuatserialize_dual_quat, deserialize_dual_quatdeserialize_dual_quatDeserializeDualQuatDeserializeDualQuatDeserializeDualQuatdeserialize_dual_quat, quat_rotate_point_3dquat_rotate_point_3dQuatRotatePoint3dQuatRotatePoint3dQuatRotatePoint3dquat_rotate_point_3d

Module

Foundation