All Frameworks  Class Hierarchy  This Framework  Indexes   

Print Class CATPrintViewerImage

Usage: you must use this class as is. You should never derive it.


public class CATPrintViewerImage

Class to create an image for viewer printing.


Constructor and Destructor Index


o CATPrintViewerImage(CATViewer*,CAT2DViewpoint*,CATMathPoint2Df&,CATMathPoint2Df&,int,int)
Constructs a print viewer image with two points in pixel coordinates.
o ~CATPrintViewerImage()
o CATPrintViewerImage(CATViewer*,int,int)
Constructs a print viewer image.

Method Index


o Decode(CATPrintGenerator*,CATPrintParameters&)
Computes the print viewer image with the appropriate generator and parameters.
o GetMode(void)
Returns The printing render mode.
o GetSize(float&,float&)
Retrieves the size of the print viewer image.
o GetViewer(void)
Returns the viewer to print.
o GetViewpoint(void)
Returns the 2D-viewpoint.

Constructor and Destructor


o CATPrintViewerImage
public CATPrintViewerImage( iViewer,
i2DViewpoint,
const iBottomLeft,
const iTopRight,
iMode= CATPRINTRENDER_DEFAULT,
iCaptureSize= 0)
Constructs a print viewer image with two points in pixel coordinates.
Parameters:
iViewer
The viewer to print.
i2DViewpoint
The 2D-viewpoint for printing the viewer.
iBottomLeft
The bottom left point. See CATMathPoint2Df.
iTopRight
The top right point. See CATMathPoint2Df.
iMode
The printing render mode.
CATPrintRenderMode.
Legal values: The default is CATPRINTRENDER_DEFAULT.
iCaptureSize
The capture printing size is 0 (model size) or 1 (display size). The default is 0.
o ~CATPrintViewerImage
public virtual ~CATPrintViewerImage()
o CATPrintViewerImage
public CATPrintViewerImage( iViewer,
iMode= CATPRINTRENDER_DEFAULT,
iCaptureSize= 0)
Constructs a print viewer image.
Parameters:
iViewer
The viewer to print.
iMode
The printing render mode.
CATPrintRenderMode.
Legal values: The default is CATPRINTRENDER_DEFAULT.
iCaptureSize
The capture printing size is 0 (model size) or 1 (display size). The default is 0.

Methods


o Decode
public Decode( iGenerator,
const iParameters)
Computes the print viewer image with the appropriate generator and parameters.
Parameters:
iGenerator
The generator.
iParameters
The print parameters.
Returns:
The status of the method.
Legal values: 0 -> KO, 1 -> OK.
o GetMode
public GetMode( )
Returns The printing render mode.
Returns:
The printing render mode. CATPrintRenderMode.
o GetSize
public GetSize( oWidth,
oHeight)
Retrieves the size of the print viewer image.
Parameters:
oWidth
The width of the image.
oHeight
The height of the image.
Returns:
The status of the method.
Legal values: 0 -> KO, 1 -> OK.
o GetViewer
public GetViewer( )
Returns the viewer to print.
Returns:
The viewer to print.
o GetViewpoint
public GetViewpoint( )
Returns the 2D-viewpoint.
Returns:
The 2D-viewpoint.

This object is included in the file: CATPrintViewerImage.h
If needed, your Imakefile.mk should include the module: CATPrint

Copyright © 2003, Dassault Systèmes. All rights reserved.