#include <DbBaseDatabase.h>

Inheritance diagram for OdDbSetBasePlotSettingsPE:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbSetBasePlotSettingsPE)

virtual OdResult	setPlotCfgName (OdRxObject *pPlotSetObj, const OdString &plotCfgName)=0

virtual OdResult	setPlotLayoutFlags (OdRxObject *pPlotSetObj, OdInt16 flags)=0

virtual OdResult	setMargins (OdRxObject *pPlotSetObj, double left, double Bottom, double right, double top)=0

virtual OdResult	setPlotPaperSize (OdRxObject *pPlotSetObj, double paperWidth, double paperHeight)=0

virtual OdResult	setMediaName (OdRxObject *pPlotSetObj, OdString mediaName)=0

virtual OdResult	setOrigin (OdRxObject *pPlotSetObj, const OdGePoint2d &origin)=0

virtual OdResult	setPlotPaperUnits (OdRxObject *pPlotSetObj, OdDbBaseLayoutPE::PlotPaperUnits units)=0

virtual OdResult	setPlotRotation (OdRxObject *pPlotSetObj, OdDbBaseLayoutPE::PlotRotation plotRotation)=0

virtual OdResult	setPlotType (OdRxObject *pPlotSetObj, OdDbBaseLayoutPE::PlotType plotType)=0

virtual OdResult	setPlotWindowArea (OdRxObject *pPlotSetObj, double xmin, double ymin, double xmax, double ymax)=0

virtual OdResult	setPlotView (OdRxObject pPlotSetObj, OdDbStub plotViewId)=0

virtual OdResult	setPrintScale (OdRxObject *pPlotSetObj, double numerator, double denominator)=0

virtual OdResult	setStyleSheet (OdRxObject *pPlotSetObj, OdString styleSheet)=0

virtual OdResult	setStdScaleType (OdRxObject *pPlotSetObj, OdDbBaseLayoutPE::StdScaleType scaleType)=0

virtual OdResult	setScaleFactor (OdRxObject *pPlotSetObj, double dScaleFactor)=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 a base plot settings protocol extension class. <group OdDb_Classes>

Definition at line 1152 of file DbBaseDatabase.h.

Member Function Documentation

◆ ODRX_DECLARE_MEMBERS()

OdDbSetBasePlotSettingsPE::ODRX_DECLARE_MEMBERS ( OdDbSetBasePlotSettingsPE )

◆ setMargins()

virtual OdResult OdDbSetBasePlotSettingsPE::setMargins	(	OdRxObject *	pPlotSetObj,
		double	left,
		double	Bottom,
		double	right,
		double	top
	)

pure 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 OdDbSetBasePlotSettingsPE::setMediaName	(	OdRxObject *	pPlotSetObj,
		OdString	mediaName
	)

pure 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 OdDbSetBasePlotSettingsPE::setOrigin	(	OdRxObject *	pPlotSetObj,
		const OdGePoint2d &	origin
	)

pure virtual

Sets the plot origin for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
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 OdDbSetBasePlotSettingsPE::setPlotCfgName	(	OdRxObject *	pPlotSetObj,
		const OdString &	plotCfgName
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotLayoutFlags	(	OdRxObject *	pPlotSetObj,
		OdInt16	flags
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotPaperSize	(	OdRxObject *	pPlotSetObj,
		double	paperWidth,
		double	paperHeight
	)

pure virtual

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

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
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 OdDbSetBasePlotSettingsPE::setPlotPaperUnits	(	OdRxObject *	pPlotSetObj,
		OdDbBaseLayoutPE::PlotPaperUnits	units
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotRotation	(	OdRxObject *	pPlotSetObj,
		OdDbBaseLayoutPE::PlotRotation	plotRotation
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotType	(	OdRxObject *	pPlotSetObj,
		OdDbBaseLayoutPE::PlotType	plotType
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotView	(	OdRxObject *	pPlotSetObj,
		OdDbStub *	plotViewId
	)

pure 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 OdDbSetBasePlotSettingsPE::setPlotWindowArea	(	OdRxObject *	pPlotSetObj,
		double	xmin,
		double	ymin,
		double	xmax,
		double	ymax
	)

pure 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 OdDbSetBasePlotSettingsPE::setPrintScale	(	OdRxObject *	pPlotSetObj,
		double	numerator,
		double	denominator
	)

pure 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 OdDbSetBasePlotSettingsPE::setScaleFactor	(	OdRxObject *	pPlotSetObj,
		double	dScaleFactor
	)

pure 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.

◆ setStdScaleType()

virtual OdResult OdDbSetBasePlotSettingsPE::setStdScaleType	(	OdRxObject *	pPlotSetObj,
		OdDbBaseLayoutPE::StdScaleType	scaleType
	)

pure 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.

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

◆ setStyleSheet()

virtual OdResult OdDbSetBasePlotSettingsPE::setStyleSheet	(	OdRxObject *	pPlotSetObj,
		OdString	styleSheet
	)

pure 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:

DbBaseDatabase.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()

◆ setStdScaleType()

◆ setStyleSheet()