Foxit::Matrix Class Reference

Class to represent matrix used for transformation. More...

Public Member Functions

 Matrix ()
 Default constructor.
 
 Matrix (float a, float b, float c, float d, float e, float f)
 Constructor to initialize a new instance of class Foxit::Matrix with specific values.
 
MatrixGetReverse ()
 Get a reversed matrix from current one. More...
 
PointFTransformPointF (PointF^ pointF)
 Transform a float point. More...
 
RectFTransformRectF (RectF^ rectF)
 Transform a float rectangle. More...
 

Properties

float A
 Coefficient a.
 
float B
 Coefficient b.
 
float C
 Coefficient c.
 
float D
 Coefficient d.
 
float E
 Coefficient e.
 
float F
 Coefficient f.
 

Detailed Description

Class to represent matrix used for transformation.

Since device coordinate and PDF page coordinate are two different coordinates, matrix is useful to transform rectangle or point between these two coordinates. Usually, a PDF page transformation matrix can be got by function PDF::Page::GetDisplayMatrix.

Member Function Documentation

Matrix ^ Foxit::Matrix::GetReverse ( )

Get a reversed matrix from current one.

Returns
A Foxit::Matrix object that receives the reversed matrix.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
PointF ^ Foxit::Matrix::TransformPointF ( PointF pointF)

Transform a float point.

Parameters
[in]pointFA Foxit::PointF object that specifies the float point to be transformed.
Returns
A Foxit::PointF object that receives the transfomred point value.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param if parameter pointF is nullptr.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.
RectF ^ Foxit::Matrix::TransformRectF ( RectF rectF)

Transform a float rectangle.

Parameters
[in]rectFA Foxit::RectF object that specifies the float renctangle to be tranformed.
Returns
A Foxit::RectF object that receives the transfomred rectangle value.
Call function Library::GetLastError after this function returns, to get the error code.
ErrorCode::Success means success.
ErrorCode::Param if parameter rectF is nullptr.
ErrorCode::Error means the function fails because of any other reasons.
For more error code values, please refer to enumeration Foxit::ErrorCode.

Foxit Corporation