PrintBase CATPrintSupportImageBase

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


public class CATPrintSupportImageBase

Class to create an image for support printing.


Constructor and Destructor Index


o CATPrintSupportImageBase(CATSupport*,CAT2DViewpoint*,int,CATBoolean)
Constructs a print support image.
o CATPrintSupportImageBase(CATSupport*,CAT2DViewpoint*,CATMathPoint2Df&,CATMathPoint2Df&,int,CATBoolean)
Constructs a print support image with two points.
o ~CATPrintSupportImageBase()

Method Index


o Decode(CATPrintGenerator*,CATPrintParameters&)
Computes the print support image with the appropriate generator and parameters.
o GetSize(float&,float&)
Retrieves the size of the print support image.
o GetSupport(void)
Returns the support of the print support image.
o GetViewpoint(void)
Returns the 2D-viewpoint of the print support image.
o SetSelection(CATMathPoint2Df&,CATMathPoint2Df&)
Clips the print support image with two points.

Constructor and Destructor


o CATPrintSupportImageBase
public CATPrintSupportImageBase( iSupport,
i2DViewpoint,
iMode= CATPRINTRENDER_DEFAULT,
const useWBGMode= TRUE)
Constructs a print support image.
Parameters:
iSupport
The support to print.
i2DViewpoint
The 2D-viewpoint for printing the support.
iMode
The printing render mode.
.
Legal values: The default is CATPRINTRENDER_DEFAULT.
useWBGMode
Set to TRUE if a white background must be used for printing.
Legal values: The default is TRUE.
o CATPrintSupportImageBase
public CATPrintSupportImageBase( iSupport,
i2DViewpoint,
const iBottomLeft,
const iTopRight,
iMode= CATPRINTRENDER_DEFAULT,
const useWBGMode= TRUE)
Constructs a print support image with two points.
Parameters:
iSupport
The support to print.
i2DViewpoint
The 2D-viewpoint for printing the support.
iBottomLeft
The bottom left point.
iTopRight
The top right point.
iMode
The printing render mode.
.
Legal values: The default is CATPRINTRENDER_DEFAULT.
useWBGMode
Set to TRUE if a white background must be used for printing.
Legal values: The default is TRUE.
o ~CATPrintSupportImageBase
public virtual ~CATPrintSupportImageBase()

Methods


o Decode
public virtual Decode( iGenerator,
const iParameters)
Computes the print support 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 GetSize
public virtual GetSize( oWidth,
oHeight)
Retrieves the size of the print support image.
Parameters:
oWidth
The width of the image.
oHeight
The height of the image.
Returns:
The status of the method. Always 1.
o GetSupport
public virtual GetSupport( )
Returns the support of the print support image.
Returns:
The support of the image.
o GetViewpoint
public virtual GetViewpoint( )
Returns the 2D-viewpoint of the print support image.
Returns:
The 2D-viewpoint of the image.
o SetSelection
public virtual SetSelection( const iBottomLeft,
const iTopRight)
Clips the print support image with two points.
Parameters:
iBottomLeft
The bottom left point.
iTopRight
The top right point.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.