#include <PdfPublish2dGeometryReference.h>

Inheritance diagram for OdPdfPublish::Od2dGeometryReference:

Public Member Functions
	ODRX_DECLARE_MEMBERS (Od2dGeometryReference)

	ODRX_HEAP_OPERATORS ()

virtual	~Od2dGeometryReference ()

void	setBorder (bool state)

void	setBorderColor (ODCOLORREF color)

void	getBorder (bool &state) const

void	getBorderColor (ODCOLORREF &color) const

void	setTransform (const OdGeMatrix2d &xfm)

void	getTransform (OdGeMatrix2d &xfm) const

void	setGeometryBlock (const Od2dGeometryBlockPtr &block)

void	getGeometryBlock (Od2dGeometryBlockPtr &block) const

void	setScale (double scale)

void	getScale (double &scale) const

void	setRotation (double rotation=0)

void	getRotation (double &rotation) const

void	setTranslation (const OdGeVector2d &vec)

void	getTranslation (OdGeVector2d &vec) 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
	Od2dGeometryReference ()

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 a reference to the two-dimensional geometry in .pdf documents created with Publish SDK. The geometry options for this reference can be set by setting the transformation matrix, scale, rotation and translation. These options are applied to the rendering of the geometry referenced by the Od2dGeometryReference object.

Remarks: For example, assume that a document has an Od2dGeometryBlock object with size 10x10 units. If you create a reference to it represented with an Od2dGeometryReference object and apply the scale 2.0 to it, Publish will render a block with size 20x20 units.

Definition at line 54 of file PdfPublish2dGeometryReference.h.

Constructor & Destructor Documentation

◆ Od2dGeometryReference()

OdPdfPublish::Od2dGeometryReference::Od2dGeometryReference ( )

protected

◆ ~Od2dGeometryReference()

virtual OdPdfPublish::Od2dGeometryReference::~Od2dGeometryReference ( )

virtual

Destroys the reference to a geometry object.

Member Function Documentation

◆ getBorder()

void OdPdfPublish::Od2dGeometryReference::getBorder ( bool & state ) const

Returns the current value of the border flag for the geometry reference object. The method fills a passed value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the border flag value.

Remarks: If the object has a border, returns true, otherwise returns false.

◆ getBorderColor()

void OdPdfPublish::Od2dGeometryReference::getBorderColor ( ODCOLORREF & color ) const

Returns the current border color for the geometry reference object. The method fills a passed value and returns it to a calling subroutine.

Parameters

color [out] A placeholder for the border color value.

◆ getGeometryBlock()

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

Returns the currently referenced geometry block. The method fills a passed smart pointer object and returns it to a calling subroutine.

Parameters

block [out] A placeholder for a smart pointer to a geometry block object.

◆ getLayer()

void OdPdfPublish::Od2dGeometryReference::getLayer ( Od2dGeometryLayerPtr & layer ) const

Returns the current PDF layer object for the geometry block reference.

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.

◆ getRotation()

void OdPdfPublish::Od2dGeometryReference::getRotation ( double & rotation ) const

Returns the current rotation angle for the geometry block reference. The method fills a passed value and returns it to a calling subroutine.

Parameters

rotation [out] A placeholder for the rotation angle value.

◆ getScale()

void OdPdfPublish::Od2dGeometryReference::getScale ( double & scale ) const

Returns the current scaling value for the geometry block reference. The method fills a passed value and returns it to a calling subroutine.

Parameters

scale [out] A placeholder for the scale value.

◆ getTransform()

void OdPdfPublish::Od2dGeometryReference::getTransform ( OdGeMatrix2d & xfm ) const

Returns the current transformation matrix for the geometry reference object. The method fills a passed matrix object and returns it to a calling subroutine.

Parameters

xfm	[out] A placeholder for the transformation matrix.

◆ getTranslation()

void OdPdfPublish::Od2dGeometryReference::getTranslation ( OdGeVector2d & vec ) const

Returns the current translation vector for the geometry block reference. The method fills a passed value and returns it to a calling subroutine.

Parameters

vec	[out] A placeholder for the translation vector.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::Od2dGeometryReference::ODRX_DECLARE_MEMBERS ( Od2dGeometryReference )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::Od2dGeometryReference::ODRX_HEAP_OPERATORS ( )

◆ setBorder()

void OdPdfPublish::Od2dGeometryReference::setBorder ( bool state )

Sets a new value of the border flag for the geometry object reference.

Parameters

state [in] A new flag value.

Remarks: If the object has a border, the flag value is equal to true, otherwise it is equal to false.

◆ setBorderColor()

void OdPdfPublish::Od2dGeometryReference::setBorderColor ( ODCOLORREF color )

Sets a new color for the geometry reference object.

Parameters

color [in] A new color value to be set.

◆ setGeometryBlock()

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

Sets a new geometry block to be referenced.

Parameters

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

◆ setLayer()

void OdPdfPublish::Od2dGeometryReference::setLayer ( const Od2dGeometryLayerPtr & layer )

Sets a new PDF layer object for the geometry reference 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 reference object doesn't belong to any layer.

◆ setRotation()

void OdPdfPublish::Od2dGeometryReference::setRotation ( double rotation = 0 )

Sets a new rotation angle (in radians) for the geometry reference object.

Parameters

rotation [in] A rotation angle value to be set.

◆ setScale()

void OdPdfPublish::Od2dGeometryReference::setScale ( double scale )

Sets a scale value for the geometry reference object.

Parameters

scale [in] A scale value to be set.

Remarks: If the new scale value is equal to 0, it means that the object is scaled to its rectangle.

◆ setTransform()

void OdPdfPublish::Od2dGeometryReference::setTransform ( const OdGeMatrix2d & xfm )

Sets a new transfomation matrix for the geometry reference object.

Parameters

xfm	[in] A transformation matrix object.

◆ setTranslation()

void OdPdfPublish::Od2dGeometryReference::setTranslation ( const OdGeVector2d & vec )

Sets a new translation vector for the geometry reference object.

Parameters

vec	[in] A translation vector to be set.

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

PdfPublish2dGeometryReference.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Od2dGeometryReference()

◆ ~Od2dGeometryReference()

Member Function Documentation

◆ getBorder()

◆ getBorderColor()

◆ getGeometryBlock()

◆ getLayer()

◆ getRotation()

◆ getScale()

◆ getTransform()

◆ getTranslation()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setBorder()

◆ setBorderColor()

◆ setGeometryBlock()

◆ setLayer()

◆ setRotation()

◆ setScale()

◆ setTransform()

◆ setTranslation()