OdPdfPublish::Od2dGeometryBlock Class Reference

#include <PdfPublish2dGeometryBlock.h>

Inheritance diagram for OdPdfPublish::Od2dGeometryBlock:

Public Member Functions
	ODRX_DECLARE_MEMBERS (Od2dGeometryBlock)
	ODRX_HEAP_OPERATORS ()
virtual	~Od2dGeometryBlock ()
void	setOrigin (const OdGePoint2d &origin)
void	addLine (const OdGePoint2dArray &points)
void	addLine (const OdGePoint2d &start, const OdGePoint2d &end)
void	addLine (OdUInt32 nPoints, const OdGePoint2d *pPoints)
void	addCircle (const OdGeCircArc2d &circle)
void	addEllipse (const OdGeEllipArc2d &ellipse)
void	addCurve (const OdGeNurbCurve2d &nurb)
void	putColor (ODCOLORREF color)
void	putTilingPattern (OdTilingPatternPtr &pattern)
void	putLineWeight (double lw)
void	putLineCap (Geometry::PDFLineCap lineCap)
void	putLineJoin (Geometry::PDFLineJoin lineJoin)
void	putTransform (const OdGeMatrix2d &transform)
void	startContour ()
void	finishContour (Geometry::PDFFinishRule rule)
void	addText (const OdTextPtr &text, const OdRect &location)
void	addImage (const OdImagePtr &image, const OdRect &location)
void	addGeometryReference (const Od2dGeometryReferencePtr &reference, const OdRect &location)
void	startLayer (Od2dGeometryLayerPtr &layer)
void	finishLayer ()
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
	Od2dGeometryBlock ()
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 ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

This class implements two-dimensional geometry data (a geometry block) in PDF documents created with Publish SDK.

Definition at line 65 of file PdfPublish2dGeometryBlock.h.

Constructor & Destructor Documentation

Od2dGeometryBlock()

OdPdfPublish::Od2dGeometryBlock::Od2dGeometryBlock ( )

protected

~Od2dGeometryBlock()

virtual OdPdfPublish::Od2dGeometryBlock::~Od2dGeometryBlock ( )

virtual

Destroys the 2D geometry block object.

Member Function Documentation

addCircle()

void OdPdfPublish::Od2dGeometryBlock::addCircle

(

const OdGeCircArc2d &

circle

)

Adds a new circle or arc to the geometry block object.

Parameters

circle

[in] A circle that should be added.

addCurve()

void OdPdfPublish::Od2dGeometryBlock::addCurve

(

const OdGeNurbCurve2d &

nurb

)

Adds a new NURBS curve to the geometry block object.

Parameters

nurb	[in] A NURBS curve that should be added.

addEllipse()

void OdPdfPublish::Od2dGeometryBlock::addEllipse

(

const OdGeEllipArc2d &

ellipse

)

Adds a new ellipse to the geometry block object.

Parameters

ellipse

[in] An ellipse that should be added.

addGeometryReference()

void OdPdfPublish::Od2dGeometryBlock::addGeometryReference	(	const Od2dGeometryReferencePtr &	reference,
		const OdRect &	location )

Adds a new geometry reference to the geometry block object.

Parameters

reference	[in] An geometry reference that should be added.
location	[in] A rectangle that specifies the image location.

addImage()

void OdPdfPublish::Od2dGeometryBlock::addImage	(	const OdImagePtr &	image,
		const OdRect &	location )

Adds a new image to the geometry block object.

Parameters

image	[in] An image that should be added.
location	[in] A rectangle that specifies the image location.

addLine() [1/3]

void OdPdfPublish::Od2dGeometryBlock::addLine	(	const OdGePoint2d &	start,
		const OdGePoint2d &	end )

Adds a new line to the geometry block object.

Parameters

start	[in] A starting point of the line.
end	[in] An ending point of the line.

Remarks

Any line can be defined with its two points (passed through start and end parameters).

addLine() [2/3]

void OdPdfPublish::Od2dGeometryBlock::addLine

(

const OdGePoint2dArray &

points

)

Adds a new line to the geometry block object.

Parameters

points

[in] An array of OdGePoint objects that determine the line.

addLine() [3/3]

void OdPdfPublish::Od2dGeometryBlock::addLine	(	OdUInt32	nPoints,
		const OdGePoint2d *	pPoints )

Adds a new line to the geometry block object.

Parameters

nPoints	[in] A quantity of points in the array.
pPoints	[in] A pointer to the point array.

addText()

void OdPdfPublish::Od2dGeometryBlock::addText	(	const OdTextPtr &	text,
		const OdRect &	location )

Adds a new text label to the geometry block object.

Parameters

text	[in] An instance of a text label.
location	[in] A rectangle that specifies the text label location.

finishContour()

void OdPdfPublish::Od2dGeometryBlock::finishContour

(

Geometry::PDFFinishRule

rule

)

Finishes a new drawing contour for the geometry block object.

Parameters

rule	[in] A finish rule for the contour.

finishLayer()

void OdPdfPublish::Od2dGeometryBlock::finishLayer

(

)

Finishes use of the PDF layer previously started with a startLayer() method call for the geometry block object.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::Od2dGeometryBlock::ODRX_DECLARE_MEMBERS

(

Od2dGeometryBlock

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::Od2dGeometryBlock::ODRX_HEAP_OPERATORS

(

)

putColor()

void OdPdfPublish::Od2dGeometryBlock::putColor

(

ODCOLORREF

color

)

Sets the geometry block object's color.

Parameters

color

[in] A new color value to be set.

putLineCap()

void OdPdfPublish::Od2dGeometryBlock::putLineCap

(

Geometry::PDFLineCap

lineCap

)

Sets the geometry block object's line cap.

Parameters

lineCap

[in] A new line cap value to be set.

putLineJoin()

void OdPdfPublish::Od2dGeometryBlock::putLineJoin

(

Geometry::PDFLineJoin

lineJoin

)

Sets the geometry block object's line join value.

Parameters

lineJoin

[in] A new join value to be set.

putLineWeight()

void OdPdfPublish::Od2dGeometryBlock::putLineWeight

(

double

lw

)

Sets the geometry block object's lineweight.

Parameters

lw	[in] A new lineweight value to be set.

putTilingPattern()

void OdPdfPublish::Od2dGeometryBlock::putTilingPattern

(

OdTilingPatternPtr &

pattern

)

Sets the geometry block object's tiling pattern.

Parameters

pattern

[in] A new tiling pattern value to be set.

putTransform()

void OdPdfPublish::Od2dGeometryBlock::putTransform

(

const OdGeMatrix2d &

transform

)

Sets a new transformation matrix for the geometry block object.

Parameters

transform

[in] A new matrix object represented with an OdGeMatrix2d object.

setOrigin()

void OdPdfPublish::Od2dGeometryBlock::setOrigin

(

const OdGePoint2d &

origin

)

Sets a new origin point for the geometry block object.

Parameters

origin

[in] An OdGePoint class instance that represents the new origin point.

startContour()

void OdPdfPublish::Od2dGeometryBlock::startContour

(

)

Starts a new drawing contour for the geometry block object.

startLayer()

void OdPdfPublish::Od2dGeometryBlock::startLayer

(

Od2dGeometryLayerPtr &

layer

)

Starts use of a specified PDF layer within the geometry block object.

Parameters

layer

[out] A smart pointer to the layer object that is created by the method.

Remarks

The method accepts a smart pointer object that refers to the layer object to be created.

---

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

• PdfPublish2dGeometryBlock.h