API reference - Class CplxTransNotation used in Ruby API documentation Description: A complex transformation
A complex transformation provides magnification, mirroring at the x-axis, rotation by an arbitary angle and a displacement. This is also the order, the operations are applied. This version can transform integer-coordinate objects into floating-point coordinate objects. This is the generic and exact case, for example for non-integer magnifications. Complex transformations are extensions of the simple transformation classes (Trans or DTrans in that case) and behave similar. Transformations can be used to transform points or other objects. Transformations can be combined with the '*' operator to form the transformation which is equivalent to applying the second and then the first. Here is some code: # Create a transformation that applies a magnication of 1.5, a rotation by 90 degree # and displacement of 10 in x and 20 units in y direction: t = RBA::DCplxTrans::new(1.5, 90, false, 10.0, 20.0) t.to_s # r90 *1.5 10,20 # compute the inverse: t.inverted.to_s # r270 *0.666666667 -13,7 # Combine with another displacement (applied after that): (RBA::DCplxTrans::new(5, 5) * t).to_s # r90 *1.5 15,25 # Transform a point: t.trans(RBA::DPoint::new(100, 200)).to_s # -290,170 See The Database API for more details about the database objects. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[const] bool !=(const CplxTrans other)Description: Inequality test [const] CplxTrans *(const CplxTrans t)Description: Multiplication (concatenation) of transformations
The * operator returns self*t ("t is applied before this transformation"). [const] bool <(const CplxTrans other)Description: A sorting criterion This method is provided to implement a sorting order. The definition of 'less' is opaque and might change in future versions. [const] bool ==(const CplxTrans other)Description: Equality test [static] int M0Description: Angle/mirror code for the "mirrored at the x-axis" transformation [static] int M135Description: Angle/mirror code for the "mirrored at the 135 degree axis" transformation [static] int M45Description: Angle/mirror code for the "mirrored at the 45 degree axis" transformation [static] int M90Description: Angle/mirror code for the "mirrored at the y (90 degree) axis" transformation [static] int R0Description: Angle/mirror code for the "unrotated" transformation [static] int R180Description: Angle/mirror code for the "rotated by 180 degree counterclockwise" transformation [static] int R270Description: Angle/mirror code for the "rotated by 270 degree counterclockwise" transformation [static] int R90Description: Angle/mirror code for the "rotated by 90 degree counterclockwise" transformation [const] double angleDescription: Gets the angle
Note that the simple transformation returns the angle in units of 90 degree. Hence for a simple trans (i.e. Trans), a rotation angle of 180 degree delivers a value of 2 for the angle attribute. The complex transformation, supporting any rotation angle returns the angle in degree. void angle=(double a)Description: Sets the angle
See angle for a description of that attribute. [const] void assign(const CplxTrans other)Description: Assign the contents of another object to self This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content. void createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. [const] double ctrans(int d)Description: The transformation of a distance
The "ctrans" method transforms the given distance. e = t(d). For the simple transformations, there is no magnification and no modification of the distance therefore. void destroyDescription: Explicitly destroy the object Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing. [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. [const] DPoint dispDescription: Gets the displacement void disp=(const DPoint u)Description: Sets the displacement
[const] CplxTrans dupDescription: Creates a copy of self [static] CplxTrans from_dtrans(const DCplxTrans dbl_trans)Description: Conversion constructor from an floating-point transformation [static] new CplxTrans from_s(string s)Description: Creates an object from a string Creates the object from a string representation (as returned by to_s) This method has been added in version 0.23. CplxTrans invertDescription: In-place inversion
Inverts the transformation and replaces this transformation by the inverted one. [const] CplxTrans invertedDescription: Inversion
Returns the inverted transformation [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. [const] bool is_mag?Description: Test, if the transformation is a magnifying one This is the recommended test for checking if the transformation represents a magnification. [const] bool is_mirror?Description: Gets the mirror flag If this property is true, the transformation is composed of a mirroring at the x-axis followed by a rotation by the angle given by the angle property. [const] bool is_ortho?Description: Test, if the transformation is an orthogonal transformation If the rotation is by a multiple of 90 degree, this method will return true. [const] bool is_unity?Description: Test, whether this is a unit transformation [static] int m0Description: Angle/mirror code for the "mirrored at the x-axis" transformation This method is deprecated. Use method 'M0' instead [static] int m135Description: Angle/mirror code for the "mirrored at the 135 degree axis" transformation This method is deprecated. Use method 'M135' instead [static] int m45Description: Angle/mirror code for the "mirrored at the 45 degree axis" transformation This method is deprecated. Use method 'M45' instead [static] int m90Description: Angle/mirror code for the "mirrored at the y (90 degree) axis" transformation This method is deprecated. Use method 'M90' instead [const] double magDescription: Gets the magnification void mag=(double m)Description: Sets the magnification
void mirror=(bool m)Description: Sets the mirror flag
"mirroring" describes a reflection at the x-axis which is included in the transformation prior to rotation. [static] new CplxTrans newDescription: Creates a unit transformation [static] new CplxTrans new(int f)Description: Conversion constructor from a fixpoint transformation
This constructor will create a transformation with a fixpoint transformation but no displacement. [static] new CplxTrans new(double x,double y)Description: Constructor from a x and y displacement
This constructor will create a transformation with the specified displacement but no rotation. [static] new CplxTrans new(double m)Description: Constructor from a magnification Creates a magnifying transformation without displacement and rotation given the magnification m. [static] new CplxTrans new(const Trans t,double m)Description: Constructor from a simple transformation and a magnification Creates a magnifying transformation from a simple transformation and a magnification. [static] new CplxTrans new(const Trans t)Description: Constructor from a simple transformation alone Creates a magnifying transformation from a simple transformation and a magnification of 1.0. [static] new CplxTrans new(double mag,double rot,bool mirrx,const DPoint u)Description: The standard constructor using magnification, angle, mirror flag and displacement
The sequence of operations is: magnification, mirroring at x axis, rotation, application of displacement. [static] new CplxTrans new(double mag,double rot,bool mirrx,double x,double y)Description: The standard constructor using magnification, angle, mirror flag and displacement
The sequence of operations is: magnification, mirroring at x axis, rotation, application of displacement. [static] new CplxTrans new_f(int f)Description: Conversion constructor from a fixpoint transformation
This method is deprecated. Use method 'new' instead [static] new CplxTrans new_m(double m)Description: Constructor from a magnification This method is deprecated. Use method 'new' instead [static] new CplxTrans new_mrmu(double mag,double rot,bool mirrx,const DPoint u)Description: The standard constructor using magnification, angle, mirror flag and displacement
This method is deprecated. Use method 'new' instead [static] new CplxTrans new_mrmxy(double mag,double rot,bool mirrx,double x,double y)Description: The standard constructor using magnification, angle, mirror flag and displacement
This method is deprecated. Use method 'new' instead [static] new CplxTrans new_t(const Trans t)Description: Constructor from a simple transformation alone This method is deprecated. Use method 'new' instead [static] new CplxTrans new_tm(const Trans t,double m)Description: Constructor from a simple transformation and a magnification This method is deprecated. Use method 'new' instead [static] new CplxTrans new_xy(double x,double y)Description: Constructor from a x and y displacement
This method is deprecated. Use method 'new' instead [static] int r0Description: Angle/mirror code for the "unrotated" transformation This method is deprecated. Use method 'R0' instead [static] int r180Description: Angle/mirror code for the "rotated by 180 degree counterclockwise" transformation This method is deprecated. Use method 'R180' instead [static] int r270Description: Angle/mirror code for the "rotated by 270 degree counterclockwise" transformation This method is deprecated. Use method 'R270' instead [static] int r90Description: Angle/mirror code for the "rotated by 90 degree counterclockwise" transformation This method is deprecated. Use method 'R90' instead [const] int rotDescription: Returns the respective simple transformation equivalent rotation code if possible If this transformation is orthogonal (is_ortho () == true), then this method will return the corresponding fixpoint transformation, not taking into account magnification and displacement. If the transformation is not orthogonal, the result reflects the quadrant the rotation goes into. [const] Trans s_transDescription: Extract the simple transformation part The simple transformation part does not reflect magnification or arbitrary angles. Rotation angles are rounded down to multiples of 90 degree. Magnification is fixed to 1.0. [const] string to_sDescription: String conversion [const] DPoint trans(const Point p)Description: The transformation of a point
The "trans" method transforms the given point. q = t(p) |