Commit 89f2eff5 authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: improve usage notes for transformPoints, surfaceTransformPoints

parent 5844d337
......@@ -53,9 +53,9 @@ Usage
it will also read & transform vector & tensor fields.
Note:
yaw (rotation about z)
pitch (rotation about y)
roll (rotation about x)
pitch (rotation about y)
yaw (rotation about z)
\*---------------------------------------------------------------------------*/
......@@ -143,6 +143,12 @@ void rotateFields(const argList& args, const Time& runTime, const tensor& T)
int main(int argc, char *argv[])
{
argList::addNote
(
"Transform (translate/rotate/scale) mesh points.\n"
"Note: roll=rotation about x, pitch=rotation about y, "
"yaw=rotation about z"
);
argList::addOption
(
"translate",
......@@ -160,13 +166,13 @@ int main(int argc, char *argv[])
(
"rollPitchYaw",
"vector",
"transform in terms of '(roll pitch yaw)' in degrees"
"rotate by '(roll pitch yaw)' in degrees"
);
argList::addOption
(
"yawPitchRoll",
"vector",
"transform in terms of '(yaw pitch roll)' in degrees"
"rotate by '(yaw pitch roll)' in degrees"
);
argList::addBoolOption
(
......
......@@ -61,8 +61,10 @@ int main(int argc, char *argv[])
{
argList::addNote
(
"Transform (scale/rotate) a surface. "
"Like transformPoints but for surfaces."
"Transform (translate/rotate/scale) a surface. "
"Like transformPoints but for surfaces.\n"
"Note: roll=rotation about x, pitch=rotation about y, "
"yaw=rotation about z"
);
argList::noParallel();
argList::validArgs.append("surfaceFile");
......@@ -91,13 +93,13 @@ int main(int argc, char *argv[])
(
"rollPitchYaw",
"vector",
"transform in terms of '( roll pitch yaw )' in degrees"
"rotate by '(roll pitch yaw)' in degrees"
);
argList::addOption
(
"yawPitchRoll",
"vector",
"transform in terms of '( yaw pitch roll )' in degrees"
"rotate by '(yaw pitch roll)' in degrees"
);
argList args(argc, argv);
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment