CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdPdfPublish::OdImage Class Reference

#include <PdfPublishImage.h>

Inheritance diagram for OdPdfPublish::OdImage:
OdPdfPublish::OdObject OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdImage)
 
 ODRX_HEAP_OPERATORS ()
 
 OdImage ()
 
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
 
- 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdPdfPublish::OdObject
 OdObject (OdPublishObjectImpl *pImpl)
 

Detailed Description

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

Definition at line 45 of file PdfPublishImage.h.

Constructor & Destructor Documentation

◆ OdImage()

OdPdfPublish::OdImage::OdImage ( )

Creates an image object.

◆ ~OdImage()

virtual OdPdfPublish::OdImage::~OdImage ( )
virtual

Destroys an image object.

Member Function Documentation

◆ getFile()

void OdPdfPublish::OdImage::getFile ( OdString out_filename) const

Returns 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

◆ getSize()

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

Returns current image size (width and height in pixels). The method fills 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 a 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)

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