All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Print Class CATPrintSupportImage

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---PrintBase.CATPrintImage
        |
        +---CATPrintSupportImage
 

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


public class CATPrintSupportImage

Class to create an image for support printing.


Constructor and Destructor Index


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

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 CATPrintSupportImage
public CATPrintSupportImage(CATSupport* iSupport,
CAT2DViewpoint* i2DViewpoint,
const CATMathPoint2Df& iBottomLeft,
const CATMathPoint2Df& iTopRight,
int iMode= CATPRINTRENDER_DEFAULT)
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.
CATPrintRenderMode.
Legal values: The default is CATPRINTRENDER_DEFAULT.
o CATPrintSupportImage
public CATPrintSupportImage(CATSupport* iSupport,
CAT2DViewpoint* i2DViewpoint,
int iMode= CATPRINTRENDER_DEFAULT)
Constructs a print support image.
Parameters:
iSupport
The support to print.
i2DViewpoint
The 2D-viewpoint for printing the support.
iMode
The printing render mode.
CATPrintRenderMode.
Legal values: The default is CATPRINTRENDER_DEFAULT.
o ~CATPrintSupportImage
public virtual ~CATPrintSupportImage()

Methods


o Decode
public virtual int Decode(CATPrintGenerator* iGenerator,
const CATPrintParameters& 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 int GetSize(float& oWidth,
float& 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 CATSupport* GetSupport(void )
Returns the support of the print support image.
Returns:
The support of the image.
o GetViewpoint
public virtual CAT2DViewpoint* GetViewpoint(void )
Returns the 2D-viewpoint of the print support image.
Returns:
The 2D-viewpoint of the image.
o SetSelection
public virtual void SetSelection( const CATMathPoint2Df& iBottomLeft,
const CATMathPoint2Df& 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: CATPrintSupportImage.h
If needed, your Imakefile.mk should include the module: CATPrint

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