CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdPdfPublish::OdTilingPattern Class Reference

#include <PdfPublishTilingPattern.h>

Inheritance diagram for OdPdfPublish::OdTilingPattern:
OdPdfPublish::OdObject OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdTilingPattern)
 
 ODRX_HEAP_OPERATORS ()
 
virtual ~OdTilingPattern ()
 
void setGeometryBlock (const Od2dGeometryBlockPtr &block)
 
void setSize (const OdInt32 width, const OdInt32 height)
 
void setXStep (const OdInt32 x_step)
 
void setYStep (const OdInt32 y_step)
 
void getGeometryBlock (Od2dGeometryBlockPtr &block) const
 
void getSize (OdInt32 &width, OdInt32 &height) const
 
void getXStep (OdInt32 &x_step) const
 
void getYStep (OdInt32 &y_step) 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
 

Protected Member Functions

 OdTilingPattern ()
 
- 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 OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

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

Definition at line 54 of file PdfPublishTilingPattern.h.

Constructor & Destructor Documentation

◆ OdTilingPattern()

OdPdfPublish::OdTilingPattern::OdTilingPattern ( )
protected

◆ ~OdTilingPattern()

virtual OdPdfPublish::OdTilingPattern::~OdTilingPattern ( )
virtual

Destroys an tiling pattern object.

Member Function Documentation

◆ getGeometryBlock()

void OdPdfPublish::OdTilingPattern::getGeometryBlock ( Od2dGeometryBlockPtr & block) const

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

Parameters
block[out] A placeholder for the geometry block object.

◆ getSize()

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

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

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

◆ getXStep()

void OdPdfPublish::OdTilingPattern::getXStep ( OdInt32 & x_step) const

Returns the tiling pattern X step in pixels. The method fills the passed integer value representing X step of the tiling pattern and returns it to the calling subroutine.

Parameters
x_step[out] A placeholder for the X step value.

◆ getYStep()

void OdPdfPublish::OdTilingPattern::getYStep ( OdInt32 & y_step) const

Returns the tiling pattern Y step in pixels. The method fills the passed integer value representing Y step of the tiling pattern and returns it to the calling subroutine.

Parameters
y_step[out] A placeholder for the Y step value.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdTilingPattern::ODRX_DECLARE_MEMBERS ( OdTilingPattern )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdTilingPattern::ODRX_HEAP_OPERATORS ( )

◆ setGeometryBlock()

void OdPdfPublish::OdTilingPattern::setGeometryBlock ( const Od2dGeometryBlockPtr & block)

Sets a geometry block object as the source for the tiling pattern.

Parameters
pRasterImage[in] A smart pointer to a geometry block object.

◆ setSize()

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

Sets the tiling pattern size in pixels.

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

◆ setXStep()

void OdPdfPublish::OdTilingPattern::setXStep ( const OdInt32 x_step)

Sets the tiling pattern X step in pixels.

Parameters
x_step[in] A X step value in pixels.

◆ setYStep()

void OdPdfPublish::OdTilingPattern::setYStep ( const OdInt32 y_step)

Sets the tiling pattern Y step in pixels.

Parameters
y_step[in] A Y step value in pixels.

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