#include <DbBaseDatabase.h>

Inheritance diagram for OdDbBaseLayoutPE:

Public Types
enum	PlotPaperUnits { kInches = 0 , kMillimeters = 1 , kPixels = 2 }

enum	PlotRotation { k0degrees = 0 , k90degrees = 1 , k180degrees = 2 , k270degrees = 3 }

enum	PlotType { kDisplay = 0 , kExtents = 1 , kLimits = 2 , kView = 3 , kWindow = 4 , kLayout = 5 }

enum	StdScaleType { kScaleToFit = 0 , k1_128in_1ft = 1 , k1_64in_1ft = 2 , k1_32in_1ft = 3 , k1_16in_1ft = 4 , k3_32in_1ft = 5 , k1_8in_1ft = 6 , k3_16in_1ft = 7 , k1_4in_1ft = 8 , k3_8in_1ft = 9 , k1_2in_1ft = 10 , k3_4in_1ft = 11 , k1in_1ft = 12 , k3in_1ft = 13 , k6in_1ft = 14 , k1ft_1ft = 15 , k1_1 = 16 , k1_2 = 17 , k1_4 = 18 , k1_5 = 19 , k1_8 = 20 , k1_10 = 21 , k1_16 = 22 , k1_20 = 23 , k1_30 = 24 , k1_40 = 25 , k1_50 = 26 , k1_100 = 27 , k2_1 = 28 , k4_1 = 29 , k8_1 = 30 , k10_1 = 31 , k100_1 = 32 , k1000_1 = 33 , k1and1_2in_1ft = 34 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbBaseLayoutPE)

virtual OdString	name (const OdRxObject *)=0

virtual bool	isModelLayout (const OdRxObject *)=0

virtual bool	printLineweights (const OdRxObject *)=0

virtual bool	showPlotStyles (const OdRxObject *)=0

virtual OdString	paperName (const OdRxObject *)=0

virtual void	getPaperSize (const OdRxObject *, double &paperWidth, double &paperHeight) const =0

virtual PlotRotation	plotRotation (const OdRxObject *)=0

virtual double	getTopMargin (const OdRxObject *)=0

virtual double	getRightMargin (const OdRxObject *)=0

virtual double	getBottomMargin (const OdRxObject *)=0

virtual double	getLeftMargin (const OdRxObject *)=0

virtual bool	isOverallVPortErased (const OdRxObject *)=0

virtual OdResult	getGeomExtents (const OdRxObject *, OdGeExtents3d &ext)=0

virtual bool	useStandardScale (const OdRxObject *)=0

virtual void	getStdScale (const OdRxObject *, double &scale)=0

virtual void	getCustomPrintScale (const OdRxObject *, double &numerator, double &denominator)=0

virtual int	plotType (const OdRxObject *)=0

virtual OdResult	getPlotType (const OdRxObject *, PlotType &) const =0

virtual OdString	getPlotViewName (const OdRxObject *)=0

virtual void	getPlotWindowArea (const OdRxObject *, double &xmin, double &ymin, double &xmax, double &ymax)=0

virtual void	getPlotOrigin (const OdRxObject *, double &x, double &y)=0

virtual void	getPlotPaperSize (const OdRxObject *, double &paperWidth, double &paperHeight)=0

virtual int	plotPaperUnits (const OdRxObject *)=0

virtual OdResult	getPlotPaperUnits (const OdRxObject *, PlotPaperUnits &) const =0

virtual OdDbStub *	getBlockId (const OdRxObject *) const =0

virtual bool	scalePSLinetypes (const OdRxObject *) const =0

virtual bool	getApproxExtents (const OdRxObject *, OdGePoint3d &extMin, OdGePoint3d &extMax) const =0

virtual OdResult	getStdScaleType (const OdRxObject *, StdScaleType &) const =0

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

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

static OdRxClass *	desc ()

Detailed Description

This class is the protocol extension to be used as a layout abstraction, independent of the underlying database (OdDbDatabase or OdDgDatabase).

See also: TD_DbRoot

Definition at line 750 of file DbBaseDatabase.h.

Member Enumeration Documentation

◆ PlotPaperUnits

enum OdDbBaseLayoutPE::PlotPaperUnits

Determines the plot paper units.

Enumerator
kInches	Inches
kMillimeters	Millimeters
kPixels	Pixels

Definition at line 761 of file DbBaseDatabase.h.

◆ PlotRotation

enum OdDbBaseLayoutPE::PlotRotation

Determines the types of plot rotations.

Enumerator
k0degrees	No rotation.
k90degrees	90 CCW.
k180degrees	Inverted.
k270degrees	90 CW.

Definition at line 774 of file DbBaseDatabase.h.

◆ PlotType

enum OdDbBaseLayoutPE::PlotType

Determines the plot types.

Enumerator
kDisplay	Display
kExtents	Extents
kLimits	Limits
kView	View
kWindow	Window
kLayout	Layout

Definition at line 789 of file DbBaseDatabase.h.

◆ StdScaleType

enum OdDbBaseLayoutPE::StdScaleType

Determines standard scale types.

Enumerator
kScaleToFit	Scaled to Fit
k1_128in_1ft	1/128" = 1'
k1_64in_1ft	1/64" = 1'
k1_32in_1ft	1/32" = 1'
k1_16in_1ft	1/16" = 1'
k3_32in_1ft	3/32" = 1'
k1_8in_1ft	1/8" = 1'
k3_16in_1ft	3/16" = 1'
k1_4in_1ft	1/4" = 1'
k3_8in_1ft	3/8" = 1'
k1_2in_1ft	1/2" = 1'
k3_4in_1ft	3/4" = 1'
k1in_1ft	1" = 1'
k3in_1ft	3" = 1'
k6in_1ft	6" = 1'
k1ft_1ft	1' = 1'
k1_1	1:1
k1_2	1:2
k1_4	1:4
k1_5	1:5
k1_8	1:8
k1_10	1:10
k1_16	1:16
k1_20	1:20
k1_30	1:30
k1_40	1:40
k1_50	1:50
k1_100	1:100
k2_1	2:1
k4_1	4:1
k8_1	8:1
k10_1	10:1
k100_1	100:1
k1000_1	1000:1
k1and1_2in_1ft	1.5"= 1'

Definition at line 808 of file DbBaseDatabase.h.

Member Function Documentation

◆ getApproxExtents()

virtual bool OdDbBaseLayoutPE::getApproxExtents	(	const OdRxObject *	,
		OdGePoint3d &	extMin,
		OdGePoint3d &	extMax
	)		const

pure virtual

Returns the approximate extents of a specified layout.

Parameters

[in]	A	pointer to a layout object.
	extMin	[in] A reference to an OdGePoint3d object to store and return the left lower corner of the extents rectangle.
	extMax	[in] A reference to an OdGePoint3d object to store and return the right upper corner of the extents rectangle.

◆ getBlockId()

virtual OdDbStub * OdDbBaseLayoutPE::getBlockId ( const OdRxObject * ) const

pure virtual

Returns the block identifier for a specified layout.

Parameters

[in] A pointer to a layout object.

◆ getBottomMargin()

virtual double OdDbBaseLayoutPE::getBottomMargin ( const OdRxObject * )

pure virtual

Returns the current bottom margin value for a specified layout.

Parameters

[in] A pointer to a layout object.

◆ getCustomPrintScale()

virtual void OdDbBaseLayoutPE::getCustomPrintScale	(	const OdRxObject *	,
		double &	numerator,
		double &	denominator
	)

pure virtual

Returns a custom print scale value for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	numerator	[out] A reference to a double value to store and return the real world units.
	denominator	[out] A reference to a double value to store and return the drawing units.

◆ getGeomExtents()

virtual OdResult OdDbBaseLayoutPE::getGeomExtents	(	const OdRxObject *	,
		OdGeExtents3d &	ext
	)

pure virtual

Returns current geometry extents of a specified layout object.

Parameters

[in]	A	pointer to a layout object.
	ext	[out] A reference to an OdGeExtents3d object to store and retrieve the layout's geometry extents.

◆ getLeftMargin()

virtual double OdDbBaseLayoutPE::getLeftMargin ( const OdRxObject * )

pure virtual

Returns the current left margin value for a specified layout.

Parameters

[in] A pointer to a layout object.

◆ getPaperSize()

virtual void OdDbBaseLayoutPE::getPaperSize	(	const OdRxObject *	,
		double &	paperWidth,
		double &	paperHeight
	)		const

pure virtual

Returns the current paper size for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	paperWidth	[out] A reference for storing and retrieving paper width value.
	paperHeight	[out] A reference for storing and retrieving paper height value.

◆ getPlotOrigin()

virtual void OdDbBaseLayoutPE::getPlotOrigin	(	const OdRxObject *	,
		double &	x,
		double &	y
	)

pure virtual

Returns the current origin plot for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	x	[out] A reference to be used for returning the X coordinate of the layout's plot origin.
	y	[out] A reference to be used for returning the Y coordinate of the layout's plot origin.

◆ getPlotPaperSize()

virtual void OdDbBaseLayoutPE::getPlotPaperSize	(	const OdRxObject *	,
		double &	paperWidth,
		double &	paperHeight
	)

pure virtual

Returns the current paper size for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	x	[out] A reference to be used for returning the paper width value.
	y	[out] A reference to be used for returning the paper height value.

◆ getPlotPaperUnits()

virtual OdResult OdDbBaseLayoutPE::getPlotPaperUnits	(	const OdRxObject *	,
		PlotPaperUnits &
	)		const

pure virtual

◆ getPlotType()

virtual OdResult OdDbBaseLayoutPE::getPlotType	(	const OdRxObject *	,
		PlotType &
	)		const

pure virtual

◆ getPlotViewName()

virtual OdString OdDbBaseLayoutPE::getPlotViewName ( const OdRxObject * )

pure virtual

Returns a plot viewport name for a specified layout.

Parameters

A	pointer to a layout object.

◆ getPlotWindowArea()

virtual void OdDbBaseLayoutPE::getPlotWindowArea	(	const OdRxObject *	,
		double &	xmin,
		double &	ymin,
		double &	xmax,
		double &	ymax
	)

pure virtual

Returns the current information about the plot window area for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	xmin	[out] A reference to be used for returning the X coordinate of the window area's lower left corner.
	ymin	[out] A reference to be used for returning the Y coordinate of the window area's lower left corner.
	xmax	[out] A reference to be used for returning the X coordinate of the window area's upper right corner.
	ymax	[out] A reference to be used for returning the Y coordinate of the window area's upper right corner.

◆ getRightMargin()

virtual double OdDbBaseLayoutPE::getRightMargin ( const OdRxObject * )

pure virtual

Returns the current right margin value for a specified layout.

Parameters

[in] A pointer to a layout object.

◆ getStdScale()

virtual void OdDbBaseLayoutPE::getStdScale	(	const OdRxObject *	,
		double &	scale
	)

pure virtual

Returns the standard scale value for a specified layout.

Parameters

[in]	A	pointer to a layout object.
	scale	[out] A reference to a double value to store and return the scale value.

◆ getStdScaleType()

virtual OdResult OdDbBaseLayoutPE::getStdScaleType	(	const OdRxObject *	,
		StdScaleType &
	)		const

pure virtual

Returns the standard scale type for this PlotSettings object (DXF 75).

Remarks: stdScaleType() returns one of the of the following

Value Scale kScaleToFit 0 Scaled to Fit k1_128in_1ft 1 1/128=1' k1_64in_1ft 2 1/64=1' k1_32in_1ft 3 1/32=1' k1_16in_1ft 4 1/16=1' k3_32in_1ft 5 3/32=1' k1_8in_1ft 6 1/8=1' k3_16in_1ft 7 3/16=1' k1_4in_1ft 8 1/4=1' k3_8in_1ft 9 3/8=1' k1_2in_1ft 10 1/2=1' k3_4in_1ft 11 3/4=1' k1in_1ft 12 1=1' k3in_1ft 13 3=1' k6in_1ft 14 6=1' k1ft_1ft 15 1'=1' k1_1 16 1:1 k1_2 17 1:2 k1_4 18 1:4 k1_5 19 1:5 k1_8 20 1:8 k1_10 21 1:10 k1_16 22 1:16 k1_20 23 1:20 k1_30 24 1:30 k1_40 25 1:40 k1_50 26 1:50 k1_100 27 1:100 k2_1 28 2:1 k4_1 29 4:1 k8_1 30 8:1 k10_1 31 10:1 k100_1 32 100:1 k1000_1 33 1000:1 k1and1_2in_1ft 34 1.5"=1'

◆ getTopMargin()

virtual double OdDbBaseLayoutPE::getTopMargin ( const OdRxObject * )

pure virtual

Returns the current top margin value for a specified layout.

Parameters

[in] A pointer to a layout object.

◆ isModelLayout()

virtual bool OdDbBaseLayoutPE::isModelLayout ( const OdRxObject * )

pure virtual

Determines whether a specified layout belongs to model space.

Parameters

[in] A pointer to a layout object.

Returns: Returns true if the layout belongs to model space, otherwise returns false.

◆ isOverallVPortErased()

virtual bool OdDbBaseLayoutPE::isOverallVPortErased ( const OdRxObject * )

pure virtual

Determines whether the overall viewport of a layout is erased.

Parameters

[in] A pointer to a layout object.

Returns: Returns true if the overall viewport of the layout is erased, otherwise returns false.

◆ name()

virtual OdString OdDbBaseLayoutPE::name ( const OdRxObject * )

pure virtual

virtual bool OdDbBaseLayoutPE::printLineweights ( const OdRxObject * )

pure virtual

Determines whether lineweights should be printed for a specified layout.

Parameters

[in] A pointer to a layout object.

Returns: Returns true if lineweights should be printed, otherwise returns false.

◆ scalePSLinetypes()

virtual bool OdDbBaseLayoutPE::scalePSLinetypes ( const OdRxObject * ) const

pure virtual

Determines whether generation of linetypes for polylines is used in paper space for the specified layout.

Parameters

[in] A pointer to a layout object.

◆ showPlotStyles()

virtual bool OdDbBaseLayoutPE::showPlotStyles ( const OdRxObject * )

pure virtual

Determines whether plot styles should be shown for a specified layout.

Parameters

[in] A pointer to a layout object.

Returns: Returns true if plot styles should be shown, otherwise returns false.

◆ useStandardScale()

virtual bool OdDbBaseLayoutPE::useStandardScale ( const OdRxObject * )

pure virtual

Determines whether a standard scale is used for a specified layout.

Parameters

[in] A pointer to a layout object.

Returns: Returns true if a standard scale is used for the layout, otherwise returns false.

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

DbBaseDatabase.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PlotPaperUnits

◆ PlotRotation

◆ PlotType

◆ StdScaleType

Member Function Documentation

◆ getApproxExtents()

◆ getBlockId()

◆ getBottomMargin()

◆ getCustomPrintScale()

◆ getGeomExtents()

◆ getLeftMargin()

◆ getPaperSize()

◆ getPlotOrigin()

◆ getPlotPaperSize()

◆ getPlotPaperUnits()

◆ getPlotType()

◆ getPlotViewName()

◆ getPlotWindowArea()

◆ getRightMargin()

◆ getStdScale()

◆ getStdScaleType()

◆ getTopMargin()

◆ isModelLayout()

◆ isOverallVPortErased()

◆ name()

◆ ODRX_DECLARE_MEMBERS()

◆ paperName()

◆ plotPaperUnits()

◆ plotRotation()

◆ plotType()

◆ printLineweights()

◆ scalePSLinetypes()

◆ showPlotStyles()

◆ useStandardScale()