|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetContextTransformation |
|---|
| extern SE_Return_Code | |||
| SE_GetContextTransformation | |||
| ( | |||
| SE_Object | transformed_object, | 1 | |
| SRM_Matrix_4x4 | matrix | 2 | |
| ); | |||
Retrieves a copy of the currently effective composition of <Transformation> instances that apply to transformed_object. This is the accumulation of all transformations for one of two possible cases as described below.
In the first case, the accumulated transformation is from the <Environment Root> instance down to transformed_object, including any transformation components directly aggregated by that DRM object. If transformed_object, or any of the DRM objects between it and its <Environment Root> instance, are referenced as a component from another transmittal and that transmittal is open, the accumulation is from the other transmittal's <Environment Root> instance. Otherwise, the accumulation is from the <Environment Root> instance within transformed_object's own transmittal.
In the second case, the accumulated transformation is from the <Model> instance down to transformed_object, including any <Transformation> components aggregated directly by that DRM object.
If no matrices were accumulated by transformed_object, the identity matrix shall be returned.
| SE_RETCOD_SUCCESS | and the requested transformation is returned, if valid parameters were passed in and all operations succeeded. |
| SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if valid parameters were passed in. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_UNRESOLVED_INPUT_OBJECT | set if transformed_object is unresolved. |
| SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
1 the object whose effective transformation is desired.
2 a pointer to a 4x4 matrix in the user's memory space where the given object's effective transformation will be copied.
Prev: SE_GetComponent.
Next: SE_GetDRMClass.
Up:Index.
|