SGTtransT

by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - Kinematics and Frames
Introduced first in SolidGeometry 5.5, Creation date: 2025-07-09, Last change: 2025-09-15

Desired, but ambiguous, so only a help text is displayed.

Description

Use either SGTalignT or SGTmatchT for frames

See Also: SGTalignT , SGTmatchT

Example Illustration

Syntax

SGN=SGTtransT([SG,T,TM,az])

Input Parameter

`SG`:		Solid with frames for SGTalignT, SGTmatchT
`T`:		Frame name
`TM`:		Reference frame; default is eye(4)
`az`:		rotation around final z axis

Output Parameter

SGN: would be the transformed SG by SGTalignT, SGTmatchT

Examples


A=SGTsetBFsimple(SGbox('noframe'))
AA=SGTalignT(A,'F'); AM=SGTmatchT(A,'F'); SGfigure;
subplot(1,2,1); SGTplotalpha(AA); title('SGTalignT'); subplot(1,2,2); SGTplotalpha(AM); title('SGTmatchT'); view4all(-30,30);

Copyright 2025 Tim C. Lueth. All rights reserved. The code is the property of Tim C. Lueth and may not be redistributed or modified without explicit written permission. This software may be used free of charge for academic research and teaching purposes only. Commercial use, redistribution, modification, or reverse engineering is strictly prohibited. Access to source code is restricted and granted only under specific agreements. For licensing inquiries or commercial use, please contact: Tim C. Lueth

Algorithm (Workflow)

This function, SGTtransT, is part of the Solid Geometry Library and is designed to handle transformations of solid geometries with frames. However, the function itself does not perform any operations and instead prompts the user to use either SGTalignT or SGTmatchT for frame transformations.

Input Parameters

SG: A solid geometry object that includes frames. This is used as input for the SGTalignT or SGTmatchT functions.
T: The name of the frame to be transformed. If not specified, it defaults to 'F'.
TM: The reference frame for the transformation. The default value is the identity matrix eye(4), which represents no transformation.
az: The angle of rotation around the final z-axis. The default value is 0, indicating no rotation.

Output Results

SGN: This would be the transformed solid geometry object if the function performed transformations. However, since the function only displays a help message, no transformation is actually performed.

Function Workflow

The function begins by retrieving the input parameters using the getfuncparams function. This function extracts the parameters from the input arguments, applying default values if necessary.

After retrieving the parameters, the function immediately triggers an error message, instructing the user to use either SGTalignT or SGTmatchT for frame transformations. This indicates that the function is not intended to be used directly for transformations but serves as a placeholder or guide for users to select the appropriate transformation function.

Example Usage

An example is provided in the comments to illustrate how to use the related functions:

A = SGTsetBFsimple(SGbox('noframe'));
AA = SGTalignT(A, 'F');
AM = SGTmatchT(A, 'F');
SGfigure;
subplot(1,2,1); SGTplotalpha(AA); title('SGTalignT');
subplot(1,2,2); SGTplotalpha(AM); title('SGTmatchT');
view4all(-30,30);

This example demonstrates creating a simple solid geometry, aligning it using SGTalignT, matching it using SGTmatchT, and plotting the results.

Algorithm explaination created using ChatGPT on 2025-08-19 00:46. (Please note: No guarantee for the correctness of this explanation)

Last html export of this page out of FM database by TL: 2025-09-21