Function Name: Set Translate Matrix 4X4

Definition

Sets *mat_ptr to a translate matrix for the given translation amount for the given axis.

Returns

SE_DRM_SUCCESS - and *mat_ptr is set to the appropriate values, if valid parameters were passed in.

SE_DRM_NULL_REQUIRED_PARAMETER - and no changes are made, if

  1. mat_ptr is NULL, or
  2. axis == SE_USE_REFERENCE_VECTOR and vec_ptr is NULL

SE_DRM_FAILURE - and no changes are made, if axis is not a valid, single axis (X, Y, or Z) $$$ SE_USE_REFERENCE_VECTOR is not yet supported

Prototype


extern SE_DRM_STATUS_CODE_ENUM
SE_SetTranslateMatrix4X4
(
SE_MATRIX_4X4_TYPE *mat_ptr, (notes)
constSE_VECTOR_3_TYPE *vec_ptr, (notes)
SE_AXIS_ENUM axis, (notes)
SE_FLOAT64 translation_factor (notes)
);

Parameters Notes

mat_ptr

 pointer to the matrix to be set

vec_ptr

 if axis == SE_USE_REFERENCE_VECTOR, this vector is used to specify
 the axis of translation

axis

 identifies the axis (or axes) along which we're translating

translation_factor

 the distance we're translating
Prev: Set Translate Matrix 3X3. Next: Super Class. Up:Index.