OdPdfPublish::OdImage Class Reference

#include <PdfPublishImage.h>

Inheritance diagram for OdPdfPublish::OdImage:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdImage)
	ODRX_HEAP_OPERATORS ()
virtual	~OdImage ()
void	setFile (const OdString &filename)
void	setImage (const OdGiRasterImagePtr &pRasterImage)
void	setSize (const OdInt32 width, const OdInt32 height)
void	getFile (OdString &out_filename) const
void	getImage (OdGiRasterImagePtr &pOutRasterImage) const
void	getSize (OdInt32 &width, OdInt32 &height) const
void	setLayer (const Od2dGeometryLayerPtr &layer)
void	getLayer (Od2dGeometryLayerPtr &layer) const
Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)
	ODRX_HEAP_OPERATORS ()
virtual	~OdObject ()
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	clear ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdImage ()
Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class implements an image entity in .pdf documents created with Publish SDK.

Definition at line 47 of file PdfPublishImage.h.

Constructor & Destructor Documentation

OdImage()

OdPdfPublish::OdImage::OdImage ( )

protected

~OdImage()

virtual OdPdfPublish::OdImage::~OdImage ( )

virtual

Destroys an image object.

Member Function Documentation

getFile()

void OdPdfPublish::OdImage::getFile

(

OdString &

out_filename

)

const

Returns the current image full filename. The method fills a passed string object and returns it to the calling subroutine.

Parameters

out_filename

[out] A placeholder for the full filename.

getImage()

void OdPdfPublish::OdImage::getImage

(

OdGiRasterImagePtr &

pOutRasterImage

)

const

Returns the current raster image object. The method fills a passed raster image object and returns it to the calling subroutine.

Parameters

pOutRasterImage

[out] A placeholder for the raster image object.

getLayer()

void OdPdfPublish::OdImage::getLayer

(

Od2dGeometryLayerPtr &

layer

)

const

Returns the current PDF layer object for the image object.

Parameters

layer

[out] A placeholder for a smart pointer to PDF layer object.

Remarks

The method fills a passed value and returns it to a calling subroutine.

getSize()

void OdPdfPublish::OdImage::getSize	(	OdInt32 &	width,
		OdInt32 &	height
	)		const

Returns the current image size (width and height in pixels). The method fills the passed integer values representing width and height of the image and returns them to the calling subroutine.

Parameters

width	[out] A placeholder for the width value.
height	[out] A placeholder for the height value.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdImage::ODRX_DECLARE_MEMBERS

(

OdImage

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdImage::ODRX_HEAP_OPERATORS

(

)

setFile()

void OdPdfPublish::OdImage::setFile

(

const OdString &

filename

)

Sets the full filename of the image. Use IsValid() to check the status of the operation.

Parameters

filename

[in] A new filename value.

setImage()

void OdPdfPublish::OdImage::setImage

(

const OdGiRasterImagePtr &

pRasterImage

)

Sets a raster image object as the source for the image.

Parameters

pRasterImage

[in] A smart pointer to a raster image object.

setLayer()

void OdPdfPublish::OdImage::setLayer

(

const Od2dGeometryLayerPtr &

layer

)

Sets the new PDF layer object for the image object.

Parameters

layer

[in] A smart pointer to a PDF layer object.

Remarks

If the smart pointer to a PDF layer object is null, it means that the image object doesn't belong to any layer.

setSize()

void OdPdfPublish::OdImage::setSize	(	const OdInt32	width,
		const OdInt32	height
	)

Sets the image size in pixels.

Parameters

width	[in] A width value in pixels.
height	[in] A height value in pixels.

---

The documentation for this class was generated from the following file:

• PdfPublishImage.h