All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDrwPicture

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDrwPicture

Interface to handle a native Drafting Picture object.
Role: You can manage various kind of pictures, whether they are raster or vectorial pictures.

Method Index

o GetCropSize(double&,double&,double&,double&): Gets the crop sizes of the picture in millimeters.
o GetFormat(DrwPictureFormat&,int&,double&): Gets the picture format and gives the picture size on disk as well as its compression ratio.
o GetImage(CATBaseUnknown**): Returns the image on which the picture is based.
o GetOriginalSize(double&,double&): Gets the original size of the picture in millimeters, i.
o GetPosition(double&,double&): Gets the position of the picture in its view.
o GetRatioLock(CATBoolean&): Gets ratio ( original width / original height )lock state.
o GetSize(double&,double&): Gets the current size of the picture in millimeters.
o SetCropSize(double,double,double,double): Sets the crop sizes of the picture in millimeters.
o SetFormat(DrwPictureFormat,int&,double&): Sets the picture format and gives the picture size on disk as well as its compression ratio.
o SetPosition(double,double): Sets the position of the picture in its view.
o SetRatioLock(CATBoolean): Sets ratio ( original width / original height )lock state.
o SetSize(double,double): Sets the current size of the picture in millimeters.

Methods

o GetCropSize

public virtual GetCropSize(		`oTop`,
		`oBottom`,
		`oLeft`,
		`oRight`)

Gets the crop sizes of the picture in millimeters. Crop sizes are given according to the edges of the not-cropped current picture.

Parameters:

oTop: Crop size for top side in mm.
oBottom: Crop size for bottom side in mm.
oLeft: Crop size for left side in mm.
oRight: Crop size for right side in mm.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFormat

public virtual GetFormat(		`oPictureFormat`,
		`oSizeOnDisk`,
		`oRatio`)

Gets the picture format and gives the picture size on disk as well as its compression ratio.

Parameters:

oPictureFormat: Compression format.
oSizeOnDisk: Picture size on disk in bytes.
oRatio: Ratio between the picture size on disk and its uncompressed size in %.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetImage

public virtual GetImage( oImage)

Returns the image on which the picture is based. It can be a CATPixelImage or CATVectorImage.

Parameters:

iTop: Pointer to the image created.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetOriginalSize

public virtual GetOriginalSize(		`oOriginalWidth`,
		`oOriginalHeight`)

Gets the original size of the picture in millimeters, i.e. the size of the picture when it was created. This size is set by the factory of the picture

Parameters:

oWidth: Original width of the picture in mm.
oHeight: Original height of the picture in mm.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetPosition

public virtual GetPosition(		`oXCoordinate`,
		`oYCoordinate`)

Gets the position of the picture in its view.

Parameters:

oXCoordinate: X coordinate in the view.
oYCoordinate: Y coordinate in the view.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetRatioLock

public virtual GetRatioLock( oLock)

Gets ratio ( original width / original height )lock state. If the lock is CATrue, the ratio between width and height must be respected when using the SetSize methode of this interface. If the lock is CATFalse, width and height are not forced to respect the original ratio.

Parameters:

oLock: Lock ratio ( width / height ) yes/no.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSize

public virtual GetSize(		`oWidth`,
		`oHeight`)

Gets the current size of the picture in millimeters.

Parameters:

oWidth: Current width of the picture in mm.
oHeight: Current height of the picture in mm.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetCropSize

public virtual SetCropSize(		`iTop`,
		`iBottom`,
		`iLeft`,
		`iRight`)

Sets the crop sizes of the picture in millimeters. Crop sizes are given according to the edges of the not-cropped current picture.

Parameters:

iTop: Crop size for top side in mm.
iBottom: Crop size for bottom side in mm.
iLeft: Crop size for left side in mm.
iRight: Crop size for right side in mm.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFormat

public virtual SetFormat(	const	`iPictureFormat`,
		`oSizeOnDisk`,
		`oRatio`)

Sets the picture format and gives the picture size on disk as well as its compression ratio.

Parameters:

iPictureFormat: Compression format.
oSizeOnDisk: Picture size on disk in bytes.
oRatio: Ratio between the picture size on disk and its uncompressed size in %.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetPosition

public virtual SetPosition(		`iXCoordinate`,
		`iYCoordinate`)

Sets the position of the picture in its view.

Parameters:

iXCoordinate: X coordinate in the view.
iYCoordinate: Y coordinate in the view.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetRatioLock

public virtual SetRatioLock( iLock)

Sets ratio ( original width / original height )lock state. If the lock is CATrue, the ratio between width and height must be respected when using the SetSize methode of this interface. If the lock is CATFalse, width and height are not forced to respect the original ratio.

Parameters:

iLock: Lock ratio ( width / height ) yes/no.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSize

public virtual SetSize(		`iWidth`,
		`iHeight`)

Sets the current size of the picture in millimeters.

Parameters:

oWidth: Current width of the picture in mm.
oHeight: Current height of the picture in mm.

Returns:

Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

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