All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

Print Class CATVectorImage

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATVectorImage
 

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


public class CATVectorImage

Class to represent a vectorial graphic image in memory.
Role: This object is used to read, visualize, write vectorial images.
The supported vectorial formats are those supported by the CATPrintFileImage.

See also:
CATPrintFileImage


Constructor and Destructor Index


o CATVectorImage()
Builds a default CATVectorImage.
o CATVectorImage(CATPrintFileImage&)
Builds a CATVectorImage from a CATPrintFileImage.
o CATVectorImage(CATPrintFileImage*)
Builds a CATVectorImage from a CATPrintFileImage.
o CATVectorImage(CATVectorImage&)
Copy constructor.
o ~CATVectorImage()

Method Index


o CreateFromFile(CATString&,int)
Returns the vector image from a graphic vector file.
o CreateSubImage(float,float,float,float)
Creates a new CATVectorImage from a region of the image.
o GetFormat()
Returns the format of the vector image.
o GetInitialWidthAndHeight(float&,float&)
Gets the initial width and height of the vector image.
o GetRotation()
Returns the rotation of the vector image.
o GetScale()
Returns the scale of the vector image.
o GetSize(float&,float&)
Retrieves the size of the file image.
o GetWidthAndHeight(float&,float&)
Gets the width and height of the vector image.
o IsValidVectorFile(CATString&)
Returns the vector validity of a graphic file.
o SetRotation(float)
Sets the rotation of the vector image in degres.
o SetScale(float)
Sets the scale of the vector image.
o SetWidthAndHeight(float,float)
Sets the width and height of the vector image.
o operator =(CATVectorImage&)
Assignment operator.

Constructor and Destructor


o CATVectorImage
public CATVectorImage()
Builds a default CATVectorImage.
o CATVectorImage
public CATVectorImage(CATPrintFileImage& iImage)
Builds a CATVectorImage from a CATPrintFileImage.
Parameters:
iImage
The CATPrintFileImage to read.
o CATVectorImage
public CATVectorImage(CATPrintFileImage* iImage)
Builds a CATVectorImage from a CATPrintFileImage.
Parameters:
iImage
The CATPrintFileImage to read.
o CATVectorImage
public CATVectorImage( const CATVectorImage& iVectorImage)
Copy constructor.
Parameters:
iVectorImage
An existing CATVectorImage.
o ~CATVectorImage
public virtual ~CATVectorImage()

Methods


o CreateFromFile
public static CATVectorImage* CreateFromFile( const CATString& iPathName,
const int iCacheMode= 0)
Returns the vector image from a graphic vector file.
Parameters:
iPathName
The path of the graphic vector file.
iCacheMode
The cache mode is used if set to 1. Default is 0.
Returns:
The vector image.
o CreateSubImage
public virtual CATVectorImage* CreateSubImage(float iXmin,
float iYmin,
float iXmax,
float iYmax) const
Creates a new CATVectorImage from a region of the image.
Parameters:
iXmin
The X left coordinate of the region.
iXmax
The X right coordinate of the region.
iYmin
The Y lower coordinate of the region.
iYmax
The Y upper coordinate of the region.
Returns:
A new CATVectorImage.
o GetFormat
public virtual CATString GetFormat()
Returns the format of the vector image.
Returns:
The format of the graphic vector file.
o GetInitialWidthAndHeight
public void GetInitialWidthAndHeight(float& oInitWidth,
float& oInitHeight)
Gets the initial width and height of the vector image.
Parameters:
oInitWidth
The init width of the graphic vector file.
oInitHeight
The init height of the graphic vector file.
o GetRotation
public virtual float GetRotation()const
Returns the rotation of the vector image.
Returns:
The rotation of the graphic vector file.
o GetScale
public virtual float GetScale()const
Returns the scale of the vector image.
Returns:
The scale of the graphic vector file.
o GetSize
public virtual int GetSize(float& oWidth,
float& oHeight)
Retrieves the size of the file 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 GetWidthAndHeight
public virtual void GetWidthAndHeight(float& oWidth,
float& oHeight) const
Gets the width and height of the vector image.
Parameters:
oWidth
The width of the graphic vector file.
oHeight
The height of the graphic vector file.
o IsValidVectorFile
public static int IsValidVectorFile( const CATString& iPathName)
Returns the vector validity of a graphic file.
Parameters:
iPathName
The path of the graphic file.
Returns:
The vector validity.
Legal values: 0 -> KO, 1 -> OK.
o SetRotation
public virtual void SetRotation( const float iRotate)
Sets the rotation of the vector image in degres.
Parameters:
iRotate
The rotation of the graphic vector file.
o SetScale
public virtual void SetScale( const float iScale)
Sets the scale of the vector image.
Parameters:
iScale
The scale of the graphic vector file.
o SetWidthAndHeight
public virtual void SetWidthAndHeight( const float iWidth,
const float iHeight)
Sets the width and height of the vector image.
Parameters:
iWidth
The width of the graphic vector file.
iHeight
The height of the graphic vector file.
o operator =
public CATVectorImage & operator =( const CATVectorImage& iVectorImage)
Assignment operator.
Parameters:
iVectorImage
An existing CATVectorImage.

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

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