Document constants in Transform/Transform2D

This commit is contained in:
Marco Costa 2019-07-04 22:10:47 -04:00
parent 550f436f8f
commit f99e84d180
2 changed files with 7 additions and 0 deletions

View file

@ -167,12 +167,16 @@
</members> </members>
<constants> <constants>
<constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> <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>
<constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> <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>
<constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )"> <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>
<constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )"> <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> </constant>
</constants> </constants>
</class> </class>

View file

@ -172,10 +172,13 @@
</members> </members>
<constants> <constants>
<constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> <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>
<constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )">
[Transform2D] with mirroring applied parallel to the X axis.
</constant> </constant>
<constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )">
[Transform2D] with mirroring applied parallel to the Y axis.
</constant> </constant>
</constants> </constants>
</class> </class>