PrintBase 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:


Constructor and Destructor Index


o CATVectorImage()
Builds a default CATVectorImage.
o CATVectorImage(CATRep*)
Builds a CATVectorImage from a Rep.
o CATVectorImage(CATPrintFileImage*)
Builds a CATVectorImage from a CATPrintFileImage.
o CATVectorImage(CATVectorImage&)
Copy constructor.
o CATVectorImage(CATPrintFileImage&)
Builds a CATVectorImage from a CATPrintFileImage.
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 GetRep()
Returns the Rep from which vector image is created.
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( iRep)
Builds a CATVectorImage from a Rep.
Parameters:
iRep
The CATRep to Read.
o CATVectorImage
public CATVectorImage( iImage)
Builds a CATVectorImage from a CATPrintFileImage.
Parameters:
iImage
The CATPrintFileImage to read.
o CATVectorImage
public CATVectorImage( const iVectorImage)
Copy constructor.
Parameters:
iVectorImage
An existing CATVectorImage.
o CATVectorImage
public CATVectorImage( iImage)
Builds a CATVectorImage from a CATPrintFileImage.
Parameters:
iImage
The CATPrintFileImage to read.
o ~CATVectorImage
public virtual ~CATVectorImage()

Methods


o CreateFromFile
public static CreateFromFile( const iPathName,
const 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 CreateSubImage( iXmin,
iYmin,
iXmax,
iYmax)
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 GetFormat()
Returns the format of the vector image.
Returns:
The format of the graphic vector file.
o GetInitialWidthAndHeight
public GetInitialWidthAndHeight( oInitWidth,
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 GetRep
public GetRep()
Returns the Rep from which vector image is created.
Returns:
The Rep from which vector image is created.
o GetRotation
public virtual GetRotation()
Returns the rotation of the vector image.
Returns:
The rotation of the graphic vector file.
o GetScale
public virtual GetScale()
Returns the scale of the vector image.
Returns:
The scale of the graphic vector file.
o GetSize
public virtual GetSize( oWidth,
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 GetWidthAndHeight( oWidth,
oHeight)
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 IsValidVectorFile( const 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 SetRotation( const iRotate)
Sets the rotation of the vector image in degres.
Parameters:
iRotate
The rotation of the graphic vector file.
o SetScale
public virtual SetScale( const iScale)
Sets the scale of the vector image.
Parameters:
iScale
The scale of the graphic vector file.
o SetWidthAndHeight
public virtual SetWidthAndHeight( const iWidth,
const 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 operator =( const 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: CATPrintBase

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