Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: graphic ::

unpublished interface XGraphicRasterizer
Usage Restrictions
not published
Description
This interfaces exposes the initialize and a rasterize method to rasterize a given data stream to a pixel graphic

Methods' Summary
initializeData Initializing the rasterizer  
rasterize Rasterizing the initialized data into a XGraphic container.  
Methods' Details
initializeData
boolean
initializeData( [in] ::com::sun::star::io::XInputStream  DataStream,
[in] unsigned long  DPI_X,
[in] unsigned long  DPI_Y,
[out] ::com::sun::star::awt::Size  DefaultSizePixel );

Description
Initializing the rasterizer

This method could also be used to determine, if the provided data is able to be rasterized by the implementation. The implementation should take care of this feature as well as setting the default image size in pixel within the given output parameter.

Parameter DataStream
The input stream of data that should be rasterized
Parameter DPI_X
The horizontal resolution of the callers device in pixel per inch. This value is needed to calculate the correct dimensions of the graphic to be rasterized. If a value of 0 is given, a horizontal default resolution of 72 DPI is used.
Parameter DPI_Y
The vertical resolution of the callers device in pixel per inch. This value is needed to calculate the correct dimensions of the graphic to be rasterized. If a value of 0 is given, a vertical default resolution of 72 DPI is used.
Parameter DefaultSizePixel
The default rendering size in pixel of the underlying graphics data may be available after the call via this output parameter. In case no default size can be determined during initialization, a default pixel size of 0,0 is returned. In this case, the caller needs to assume a default pixel size, appropriate for the calling context.
Returns
A boolean value indicating if rasterizing of the given data is possible at all and if the initialization process happened successfully.
See also
::com::sun::star::io::XInputStream, ::com::sun::star::awt::Size
rasterize
XGraphic
rasterize( [in] unsigned long  Width,
[in] unsigned long  Height,
[in] double  RotateAngle,
[in] double  ShearAngle_X,
[in] double  ShearAngle_Y,
[in] ::com::sun::star::beans::PropertyValues  RasterizeProperties );

Description
Rasterizing the initialized data into a XGraphic container.

The XGraphic container will contain a pixel type graphic after a successful rasterization process

In case of any fault during the rasterization process, the XGraphic container will be empty afterwards and the method will return false

Parameter Width
The width in pixel of the graphic to be rasterized. This parameter is used without taking other transformation values into account.
Parameter Height
The height in pixel of the graphic to be rasterized. This parameter is used without taking other transformation values into account.
Parameter RotateAngle
The rotation angle of the graphic to be rasterized. This parameter is used without taking other transformation values into account. The rotation is applied after scaling and shearing the original image.
Parameter ShearXAngle
The horizontal shear angle of the graphic to be rasterized. This parameter is used without taking other transformation values into account. The shearing is applied after scaling and before rotation of the image.
Parameter ShearYAngle
The vertical shear angle of the graphic to be rasterized. This parameter is used without taking other transformation values into account. The shearing is applied after scaling and before rotation of the image.
Parameter RasterizeProperties
Additional properties for special needs (undefined by now)
Parameter Graphic
An interface to a graphic container into which the given data should be rasterized.
Returns
com::sun::star::graphic::XGraphic An interface to a graphic container that holds the rasterized pixel data
See also
::com::sun::star::beans::PropertyValues, XGraphic
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.