diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-07-05 08:03:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-05 08:03:14 +0200 |
| commit | 9c27cfd761ffe425f28e5ec4437611a0ecd10e28 (patch) | |
| tree | 202120923bcedfaf9e8a1ce355f3266c11f4db8e | |
| parent | 259a3fb1e99ecd5a4c79d4083e6db19496b8556d (diff) | |
| parent | f99e84d18087db4aece49608270caf7d313f8704 (diff) | |
Merge pull request #30332 from marcotc/docs-transform
Document constants in Transform/Transform2D
| -rw-r--r-- | doc/classes/Transform.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 3 |
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 80a393dcee..9916d25af5 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -167,12 +167,16 @@ </members> <constants> <constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the YZ plane. </constant> <constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XZ plane. </constant> <constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )"> + [Transform] with mirroring applied perpendicular to the XY plane. </constant> </constants> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index c5ae88d050..f6fce1aaa1 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -172,10 +172,13 @@ </members> <constants> <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the X axis. </constant> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the Y axis. </constant> </constants> </class> |