From 98243f7ef9fd01f09e58b02ddfdf620095e0b8de Mon Sep 17 00:00:00 2001 From: Mike Kestner Date: Fri, 2 Jul 2004 12:47:27 +0000 Subject: [PATCH] 2004-07-02 Peter Johanson * en/Art/*.xml : docs for some Art API. svn path=/trunk/gtk-sharp/; revision=30661 --- doc/ChangeLog | 4 ++ doc/en/Art/Affine.xml | 100 +++++++++++++++---------------- doc/en/Art/Point.xml | 10 ++-- doc/en/Gnome/CanvasEventArgs.xml | 10 ++-- 4 files changed, 65 insertions(+), 59 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 6de482857..d41daa355 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2004-07-02 Peter Johanson + + * en/Art/*.xml : docs for some Art API. + 2004-06-29 Mike Kestner * en/Gdk/Key.xml : script fill summary tags. There isn't a lot of diff --git a/doc/en/Art/Affine.xml b/doc/en/Art/Affine.xml index dbe0fa38b..9cbcc18f7 100644 --- a/doc/en/Art/Affine.xml +++ b/doc/en/Art/Affine.xml @@ -30,9 +30,9 @@ - To be added - a - a + Sets up a rotation matrix. + Where to store the resulting affine transformation. + Rotation angle in degrees. To be added @@ -46,10 +46,10 @@ - To be added - a - a - To be added + Finds the expansion factor, i.e. the square root of the factor by which the affine transform affects area. + The affine transformation. + The expansion factor. + In an affine transform composed of scaling, rotation, shearing, and translation, returns the amount of scaling. @@ -62,8 +62,8 @@ - To be added - a + Set up the identity matrix. + Where to store the resulting affine transform. To be added @@ -80,12 +80,12 @@ - To be added - a - a - a - a - To be added + Flips the affine transform. + Where to store the resulting affine transform. + The original affine transformation. + Whether or not to flip horizontally. + Whether or not to flip vertically. + Both horz and vert false results in a simple copy operation. True for both results in an 180 degree rotation. @@ -99,10 +99,10 @@ - To be added - a - a - To be added + Converts an affine transform into a bit of PostScript code that implements the transform. + The resulting string. + The affine transform. + Special cases of scaling, rotation, and translation are detected, and the corresponding PostScript operators used (this greatly aids understanding the output generated). The identity transform is mapped to the null string. @@ -116,10 +116,10 @@ - To be added - a - a - To be added + Sets up the inverse of the given transformation. + Where the resulting affine is stored. + The original affine transformation. + The inverse is in the classical sense; src_affine multiplied with dst_affine, or dst_affine multiplied with src_affine will be (to within roundoff error) the identify affine. See @@ -134,10 +134,10 @@ - To be added - a - a - a + Multiplies two affine transforms together, i.e. the resulting dst is equivalent to doing first src1 then src2. + Where to store the resulting affine transform. + The first affine transform to multiply. + The second affine transform to multiply. To be added @@ -152,9 +152,9 @@ - To be added - a - a + Setup a shearing matrix + Where to store the resulting affine transformation. + Shear angle in degrees. To be added @@ -168,10 +168,10 @@ - To be added - a + Determines wether a matrix is rectilinear, i.e. grid-aligned rectangles are transformed to other grid-aligned rectangles. + The affine transformation to test. a - To be added + The implementation has epsilon-tolerance for roundoff errors. @@ -185,11 +185,11 @@ - To be added - a - a - a - To be added + Determine if two matrices are equal. + An affine transformation. + Another affine transformation. + True if the matrices are equal, otherwise false. + Equality is verified with epsilon-tolerance for roundoff errors. @@ -204,10 +204,10 @@ - To be added - a - a - a + Sets up a translation matrix. + Where to store the resulting affine transform. + X translation amount. + Y translation amount. To be added @@ -223,10 +223,10 @@ - To be added - a - a - a + Sets up a scaling matrix. + Where to store the resulting affine transform. + X scale factor. + Y scale factor. To be added @@ -252,10 +252,10 @@ - To be added - a - a - a + Apply an affine transform to an . + The original point. + The affine transform. + The resulting point after performing the transform. To be added diff --git a/doc/en/Art/Point.xml b/doc/en/Art/Point.xml index a48ada838..196678a95 100644 --- a/doc/en/Art/Point.xml +++ b/doc/en/Art/Point.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Structure representing a point in the Art 2D space. + The Art 2D space is not a direct cartesian 2D space: it is an indirect cartesian space (that is, its direction is the invert of the standard trigonometric direction). The 2D space used by Art is inspired by the X coordinate space. System.ValueType @@ -28,7 +28,7 @@ - To be added + Get a point at the origin. To be added @@ -57,7 +57,7 @@ - To be added + The X coordinate. To be added @@ -70,7 +70,7 @@ - To be added + The Y coordinate. To be added diff --git a/doc/en/Gnome/CanvasEventArgs.xml b/doc/en/Gnome/CanvasEventArgs.xml index dda103ff9..5d443c593 100644 --- a/doc/en/Gnome/CanvasEventArgs.xml +++ b/doc/en/Gnome/CanvasEventArgs.xml @@ -10,10 +10,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Event data. - - The event invokes delegates which pass event data via this class. - + Details of events coming from CanvasItems. See . + Contains mouse button clicks, motion, enter/leave, and key press events from CanvasItems. Use these to create user interactive items. The x and y coordinates of the event structure have been converted to canvas world coordinates. + + To signify that an event has been handled, and stop it from being further emitted, set to true. + + GLib.SignalArgs