SE GetContextTransformation

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetContextTransformation

extern SE_Status_Code
SE_GetContextTransformation
(
SE_Object		object_in,	(notes)
SRM_Matrix_4x4	*	matrix_out_ptr	(notes)
);

Definition

Retrieves a copy of the current effective transformation of the given object. This is the accumulation of all transformations -

from the <Transmittal Root> down to the object, including any transformation components directly aggregated by that object. If object_in, or any of the objects between it and its <Transmittal Root>, are referenced as a component from another transmittal and that transmittal is open, then the accumulation is from the other transmittal's <Transmittal Root>. Otherwise the accumulation is from the <Transmittal Root> within object_in's own transmittal.

or from the <Model> down to the object, including any transformation components directly aggregated by that object depending on whether the object was or wasn't part of a <Model>.

If no matrices were 'accumulated' by the object, then the identity matrix will be returned.

Returns

SE_STAT_CODE_SUCCESS and the current effective transformation of object_in is copied into *matrix_out_ptr, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *matrix_out_ptr is left unchanged, if matrix_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if object_in is not valid.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if object_in is unresolved.

SE_STAT_CODE_FAILURE and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 the object whose effective transformation is desired.

matrix_out_ptr

 a pointer to a 4x4 matrix in the user's memory space
    where the given object's effective transformation will be copied.

SE_STAT_CODE_SUCCESS	and the current effective transformation of object_in is copied into *matrix_out_ptr, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *matrix_out_ptr is left unchanged, if matrix_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if object_in is not valid.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if object_in is unresolved.
SE_STAT_CODE_FAILURE	and *matrix_out_ptr is set to SRM_MATRIX_4X4_TYPE_DEFAULT, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.