Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

Rt2dCTM
[Rt2d]


Functions

RwBool  Rt2dCTMSetIdentity (void)
RwBool  Rt2dCTMRotate (RwReal theta)
RwMatrix Rt2dCTMRead (RwMatrix *result)
RwBool  Rt2dCTMPush (void)
RwBool  Rt2dCTMPop (void)
RwBool  Rt2dCTMScale (RwReal x, RwReal y)
RwBool  Rt2dCTMTranslate (RwReal x, RwReal y)

Detailed Description

Current Transformation Matrix (CTM)

Function Documentation

RwBool Rt2dCTMPop void   
 

Rt2dCTMPop is used to remove the current transformation matrix (CTM), that is, to destroy the matrix at the top of the matrix stack. The matrix previously below the current one in the matrix stack, if any, now becomes the current transformation matrix. The include file rt2d.h and the library file rt2d.lib are required to use this function.

Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMPush , Rt2dCTMRotate , Rt2dCTMTranslate , Rt2dCTMScale , Rt2dCTMSetIdentity
RwBool Rt2dCTMPush void   
 

Rt2dCTMPush is used to create a new transformation matrix and place it at the top of the matrix stack, that is, make it the current transformation matrix (CTM). The include file rt2d.h and the library file rt2d.lib are required to use this function.

Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMPop , Rt2dCTMRotate , Rt2dCTMTranslate , Rt2dCTMScale , Rt2dCTMSetIdentity
RwMatrix* Rt2dCTMRead RwMatrix   result
 

Rt2dCTMRead is used to copy the current CTM matrix into the provided matrix.

Note that this function is used for debug purposes only and, for efficiency, is available as a macro for release versions of an application.

Parameters:
result  the matrix to store the CTM.
Returns:
The matrix if successful or NULL if there is an error.
RwBool Rt2dCTMRotate RwReal    theta
 

Rt2dCTMRotate is used to apply a rotation to the current transformation matrix (CTM) using the specified angle of rotation. A rotation in an anticlockwise direction are achieved using a positive angle. Note that the rotation is preconcatenated with the CTM. The include file rt2d.h and the library file rt2d.lib are required to use this function.

Parameters:
theta  A RwReal value equal to the angle of rotation in degrees
Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMTranslate , Rt2dCTMScale , Rt2dCTMPush , Rt2dCTMPop , Rt2dCTMSetIdentity
RwBool Rt2dCTMScale RwReal    x,
RwReal    y
 

Rt2dCTMScale is used to apply a scale transformation to the current transformation matrix (CTM) using the specified x- and y-scale factors. Note that the scale is preconcatenated with the CTM. The include file rt2d.h and the library file rt2d.lib are required to use this function.

Parameters:
x  A RwReal value equal to the scale factor in the x-direction.
y  A RwReal value equal to the scale factor in the y-direction.
Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMRotate , Rt2dCTMTranslate , Rt2dCTMPush , Rt2dCTMPop , Rt2dCTMSetIdentity
RwBool Rt2dCTMSetIdentity void   
 

Rt2dCTMSetIdentity is used to set the current transformation matrix (the matrix at the top of the matrix stack) equal to the identity matrix. This procedure removes all previously applied transformations. The include file rt2d.h and the library file rt2d.lib are required to use this function.

Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMRotate , Rt2dCTMTranslate , Rt2dCTMScale , Rt2dCTMPush , Rt2dCTMPop
RwBool Rt2dCTMTranslate RwReal    x,
RwReal    y
 

Rt2dCTMTranslate is used to apply a translation to the current transformation matrix (CTM) using the specified x- and y-components. Note that the translation is preconcatenated with the CTM. The include file rt2d.h and the library file rt2d.lib are required to use this function.

Parameters:
x  A RwReal value equal to the translation in the x-direction.
y  A RwReal value equal to the translation in the y-direction.
Returns:
TRUE if successful or FALSE if there is an error
See also:
Rt2dCTMRotate , Rt2dCTMScale , Rt2dCTMPush , Rt2dCTMPop , Rt2dCTMSetIdentity

Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:47 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)