#include <DbSetPlotSettingsPE.h>

Inheritance diagram for OdDbSetPlotSettingsPE:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbSetPlotSettingsPE)

virtual OdResult	setPlotCfgName (OdDbPlotSettings *pPlotSettings, const OdString &plotCfgName)

virtual OdResult	setPlotLayoutFlags (OdDbPlotSettings *pPlotSettings, OdInt16 flags)

virtual OdResult	setMargins (OdDbPlotSettings *pPlotSettings, double left, double Bottom, double right, double top)

virtual OdResult	setPlotPaperSize (OdDbPlotSettings *pPlotSettings, double paperWidth, double paperHeight)

virtual OdResult	setMediaName (OdDbPlotSettings *pPlotSettings, OdString mediaName)

virtual OdResult	setOrigin (OdDbPlotSettings *pPlotSettings, const OdGePoint2d &origin)

virtual OdResult	setPlotPaperUnits (OdDbPlotSettings *pPlotSettings, OdDbPlotSettings::PlotPaperUnits units)

virtual OdResult	setPlotRotation (OdDbPlotSettings *pPlotSettings, OdDbPlotSettings::PlotRotation plotRotation)

virtual OdResult	setPlotType (OdDbPlotSettings *pPlotSettings, OdDbPlotSettings::PlotType plotType)

virtual OdResult	setPlotWindowArea (OdDbPlotSettings *pPlotSettings, double xmin, double ymin, double xmax, double ymax)

virtual OdResult	setPlotView (OdDbPlotSettings *pPlotSettings, OdDbObjectId plotViewId)

virtual OdResult	setPrintScale (OdDbPlotSettings *pPlotSettings, double numerator, double denominator)

virtual OdResult	setStyleSheet (OdDbPlotSettings *pPlotSettings, OdString styleSheet)

virtual OdResult	setScaleType (OdDbPlotSettings *pPlotSettings, OdDbPlotSettings::StdScaleType scaleType)

virtual OdResult	setScaleFactor (OdDbPlotSettings *pPlotSettings, double dScaleFactor)

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 a plot settings protocol extension class. The methods of the OdDbSetPlotSettingsPE provide the direct access to OdDbPlotSettings fields. Unlike the OdDbPlotSettingsValidator class, which can also be used for defining plot settings, OdDbSetPlotSettingsPE allows you to set data without validation. <group OdDb_Classes>

Definition at line 39 of file DbSetPlotSettingsPE.h.

Member Function Documentation

◆ ODRX_DECLARE_MEMBERS()

OdDbSetPlotSettingsPE::ODRX_DECLARE_MEMBERS ( OdDbSetPlotSettingsPE )

◆ setMargins()

virtual OdResult OdDbSetPlotSettingsPE::setMargins	(	OdDbPlotSettings *	pPlotSettings,
		double	left,
		double	Bottom,
		double	right,
		double	top
	)

virtual

Sets the margins of the paper for the specified PlotSettings object.

\param pPlotSettings [in] Pointer to the PlotSettings object.

Parameters

left	[in] Sets the left margin.
Bottom	[in] Sets the bottom margin.
right	[in] Sets the right margin.
top	[in] Sets the top margin.

Remarks

Margins are measured from their respective edges to the plot area and are independent of plot rotation. All distances are returned in millimeters, regardless of the drawing units.

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setMediaName()

virtual OdResult OdDbSetPlotSettingsPE::setMediaName	(	OdDbPlotSettings *	pPlotSettings,
		OdString	mediaName
	)

virtual

Sets the canonical (locale-independent) media name for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
mediaName	[in] Canonical media name (case-sensitive).

Remarks: The canonical media name is locale-independent.

Returns: Returns eOk if successful or an appropriate error code otherwise.

◆ setOrigin()

virtual OdResult OdDbSetPlotSettingsPE::setOrigin	(	OdDbPlotSettings *	pPlotSettings,
		const OdGePoint2d &	origin
	)

virtual

Sets the plot origin for the specified PlotSettings object.

\param pPlotSettings [in] Pointer to the PlotSettings object.

Parameters

origin [in] Plot origin.

Remarks

The plot origin is measured with respect to the plot margin. All distances are returned in millimeters, regardless of the drawing units.

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotCfgName()

virtual OdResult OdDbSetPlotSettingsPE::setPlotCfgName	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	plotCfgName
	)

virtual

Sets the plot device name for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotCfgName	[in] Name of the system printer or plot configuration PC3 file. \returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotLayoutFlags()

virtual OdResult OdDbSetPlotSettingsPE::setPlotLayoutFlags	(	OdDbPlotSettings *	pPlotSettings,
		OdInt16	flags
	)

virtual

Sets plot layout flags for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
flags	[in] Plot layout flags to be set. \returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotPaperSize()

virtual OdResult OdDbSetPlotSettingsPE::setPlotPaperSize	(	OdDbPlotSettings *	pPlotSettings,
		double	paperWidth,
		double	paperHeight
	)

virtual

Sets the size of the paper for the specified PlotSettings object.

\param pPlotSettings [in] Pointer to the PlotSettings object.

Parameters

paperWidth	[in] Sets the paper width.
paperHeight	[in] Sets the paper height.

Remarks

Paper size is the physical paper size and includes margins. All distances are returned in millimeters, regardless of the drawing units.

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotPaperUnits()

virtual OdResult OdDbSetPlotSettingsPE::setPlotPaperUnits	(	OdDbPlotSettings *	pPlotSettings,
		OdDbPlotSettings::PlotPaperUnits	units
	)

virtual

Sets the plot paper units for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotPaperUnits	[in] Plot paper units.

Remarks: The plot paper units determine the units of the margins, offsets, paper size, and drawing units.

plotPaperUnits must be one of the following:

Value Description kInches 0 Inches kMillimeters 1 Millimeters kPixels 2 Pixels

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotRotation()

virtual OdResult OdDbSetPlotSettingsPE::setPlotRotation	(	OdDbPlotSettings *	pPlotSettings,
		OdDbPlotSettings::PlotRotation	plotRotation
	)

virtual

Sets the plot rotation for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotRotation	[in] Plot rotation.

Remarks: plotRotation must be one of the following:

Value Description k0degrees 0 No rotation k90degrees 1 90� CCW k180degrees 2 Inverted� k270degrees 3 90� CW

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotType()

virtual OdResult OdDbSetPlotSettingsPE::setPlotType	(	OdDbPlotSettings *	pPlotSettings,
		OdDbPlotSettings::PlotType	plotType
	)

virtual

Sets the plot type for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotType	[in] Plot type.

Remarks: plotType must be one of the following:

Value Description kDisplay 0 Display kExtents 1 Extents kLimits 2 Limits kView 3 View kWindow 4 Window kLayout 5 Layout

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotView()

virtual OdResult OdDbSetPlotSettingsPE::setPlotView	(	OdDbPlotSettings *	pPlotSettings,
		OdDbObjectId	plotViewId
	)

virtual

Sets the plot view for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotViewId	[in] Plot view Object Id to set.

Returns: Returns eOk if successful or an appropriate error code otherwise.

◆ setPlotWindowArea()

virtual OdResult OdDbSetPlotSettingsPE::setPlotWindowArea	(	OdDbPlotSettings *	pPlotSettings,
		double	xmin,
		double	ymin,
		double	xmax,
		double	ymax
	)

virtual

Sets the corners of the plot window area for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
xMin	[in] X-coordinate of the lower-left corner.
yMin	[in] Y-coordinate of the lower-left corner.
xMax	[in] X-coordinate of the upper-right corner.
yMax	[in] Y-coordinate of the upper-right corner.

Remarks

The corners define the area to be plotted if and only if plotType == kWindow.

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setPrintScale()

virtual OdResult OdDbSetPlotSettingsPE::setPrintScale	(	OdDbPlotSettings *	pPlotSettings,
		double	numerator,
		double	denominator
	)

virtual

Sets the custom print scale for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
numerator	[in] PaperSpace units.
denominator	[in] Media units.

Remarks

The custom print scale always reflects the scale that this PlotSettings object will use to plot.

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setScaleFactor()

virtual OdResult OdDbSetPlotSettingsPE::setScaleFactor	(	OdDbPlotSettings *	pPlotSettings,
		double	dScaleFactor
	)

virtual

Sets the scale factor, as a floating point value, for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
dScaleFactor	[in] Scale factor.

◆ setScaleType()

virtual OdResult OdDbSetPlotSettingsPE::setScaleType	(	OdDbPlotSettings *	pPlotSettings,
		OdDbPlotSettings::StdScaleType	scaleType
	)

virtual

Sets the standard scale type for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
scaleType	[in] Standard scale type to be set.

Remarks: scaleType must be one 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'

\returns Returns eOk if successful or an appropriate error code otherwise.

◆ setStyleSheet()

virtual OdResult OdDbSetPlotSettingsPE::setStyleSheet	(	OdDbPlotSettings *	pPlotSettings,
		OdString	styleSheet
	)

virtual

Sets the current style sheet for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
styleSheet	[in] Name of current style sheet. \returns Returns eOk if successful or an appropriate error code otherwise.

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

DbSetPlotSettingsPE.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ODRX_DECLARE_MEMBERS()

◆ setMargins()

◆ setMediaName()

◆ setOrigin()

◆ setPlotCfgName()

◆ setPlotLayoutFlags()

◆ setPlotPaperSize()

◆ setPlotPaperUnits()

◆ setPlotRotation()

◆ setPlotType()

◆ setPlotView()

◆ setPlotWindowArea()

◆ setPrintScale()

◆ setScaleFactor()

◆ setScaleType()

◆ setStyleSheet()