#include <DbAbstractViewportData.h>

Inheritance diagram for OdDbAbstractViewportData:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbAbstractViewportData)

virtual void	setProps (OdRxObject pViewport, const OdRxObject pSourceView) const

	TD_USING (OdAbstractViewPE::setUcs)

virtual void	setUcs (OdRxObject pDestinationView, const OdRxObject pSourceView) const

virtual bool	hasViewOffset (const OdRxObject *pViewport) const

virtual bool	applyPlotSettings (OdRxObject pDestinationView, const OdRxObject pSourceView) const

virtual OdDbStub *	compatibleCopyObject (const OdRxObject pViewport, OdDbStub pCopyObject) const

virtual bool	isUcsSavedWithViewport (const OdRxObject *pViewport) const =0

virtual void	setUcsPerViewport (OdRxObject *pViewport, bool ucsPerViewport) const =0

virtual bool	isUcsFollowModeOn (const OdRxObject *pViewport) const =0

virtual void	setUcsFollowModeOn (OdRxObject *pViewport, bool ucsFollowMode) const =0

virtual OdUInt16	circleSides (const OdRxObject *pViewport) const =0

virtual void	setCircleSides (OdRxObject *pViewport, OdUInt16 circleSides) const =0

virtual bool	isGridOn (const OdRxObject *pViewport) const =0

virtual void	setGridOn (OdRxObject *pViewport, bool gridOn) const =0

virtual OdGeVector2d	gridIncrement (const OdRxObject *pViewport) const =0

virtual void	setGridIncrement (OdRxObject *pViewport, const OdGeVector2d &gridIncrement) const =0

virtual bool	isGridBoundToLimits (const OdRxObject *pViewport) const =0

virtual void	setGridBoundToLimits (OdRxObject *pViewport, bool gridDispFlag) const =0

virtual bool	isGridAdaptive (const OdRxObject *pViewport) const =0

virtual void	setGridAdaptive (OdRxObject *pViewport, bool gridDispFlag) const =0

virtual bool	isGridSubdivisionRestricted (const OdRxObject *pViewport) const =0

virtual void	setGridSubdivisionRestricted (OdRxObject *pViewport, bool gridDispFlag) const =0

virtual bool	isGridFollow (const OdRxObject *pViewport) const =0

virtual void	setGridFollow (OdRxObject *pViewport, bool gridDispFlag) const =0

virtual OdInt16	gridMajor (const OdRxObject *pViewport) const =0

virtual void	setGridMajor (OdRxObject *pViewport, OdInt16 nMajor) const =0

virtual bool	isUcsIconVisible (const OdRxObject *pViewport) const =0

virtual void	setUcsIconVisible (OdRxObject *pViewport, bool iconVisible) const =0

virtual bool	isUcsIconAtOrigin (const OdRxObject *pViewport) const =0

virtual void	setUcsIconAtOrigin (OdRxObject *pViewport, bool atOrigin) const =0

virtual bool	isSnapOn (const OdRxObject *pViewport) const =0

virtual void	setSnapOn (OdRxObject *pViewport, bool snapOn) const =0

virtual bool	isSnapIsometric (const OdRxObject *pViewport) const =0

virtual void	setSnapIsometric (OdRxObject *pViewport, bool snapIsometric) const =0

virtual double	snapAngle (const OdRxObject *pViewport) const =0

virtual void	setSnapAngle (OdRxObject *pViewport, double snapAngle) const =0

virtual OdGePoint2d	snapBase (const OdRxObject *pViewport) const =0

virtual void	setSnapBase (OdRxObject *pViewport, const OdGePoint2d &snapBase) const =0

virtual OdGeVector2d	snapIncrement (const OdRxObject *pViewport) const =0

virtual void	setSnapIncrement (OdRxObject *pViewport, const OdGeVector2d &snapIncrement) const =0

virtual OdUInt16	snapIsoPair (const OdRxObject *pViewport) const =0

virtual void	setSnapIsoPair (OdRxObject *pViewport, OdUInt16 snapIsoPair) const =0

virtual double	brightness (const OdRxObject *pViewport) const =0

virtual void	setBrightness (OdRxObject *pViewport, double brightness) const =0

virtual double	contrast (const OdRxObject *pViewport) const =0

virtual void	setContrast (OdRxObject *pViewport, double contrast) const =0

virtual OdCmColor	ambientLightColor (const OdRxObject *pViewport) const =0

virtual void	setAmbientLightColor (OdRxObject *pViewport, const OdCmColor &color) const =0

virtual OdDbStub *	sunId (const OdRxObject *pViewport) const =0

virtual OdDbStub *	setSun (OdRxObject pViewport, OdRxObject pSun) const =0

virtual void	toneOperatorParameters (const OdRxObject *pViewport, OdGiToneOperatorParameters &params) const =0

virtual void	setToneOperatorParameters (OdRxObject *pViewport, const OdGiToneOperatorParameters &params) const =0

virtual OdGsView *	gsView (const OdRxObject *pViewport) const =0

virtual void	setGsView (OdRxObject pViewport, OdGsView pGsView) const =0

virtual int	navvcubedisplay (const OdRxObject *pViewport) const

virtual OdResult	setNavvcubedisplay (OdRxObject *pViewport, int nVal) const

	TD_USING (OdAbstractViewPE::setView)

virtual void	setView (OdRxObject pDestinationView, const OdRxObject pSourceView) const

Public Member Functions inherited from OdAbstractViewPE
	ODRX_DECLARE_MEMBERS (OdAbstractViewPE)

virtual OdGePoint2d	lowerLeftCorner (const OdRxObject *pViewport) const

virtual OdGePoint2d	upperRightCorner (const OdRxObject *pViewport) const

virtual void	setViewport (OdRxObject *pViewport, const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight) const

virtual bool	hasViewport (const OdRxObject *pViewport) const

virtual OdGePoint3d	target (const OdRxObject *pViewport) const =0

virtual OdGeVector3d	direction (const OdRxObject *pViewport) const =0

virtual OdGeVector3d	upVector (const OdRxObject *pViewport) const =0

virtual double	fieldWidth (const OdRxObject *pViewport) const =0

virtual double	fieldHeight (const OdRxObject *pViewport) const =0

virtual bool	isPerspective (const OdRxObject *pViewport) const =0

virtual OdGeVector2d	viewOffset (const OdRxObject *pViewport) const

virtual double	viewTwist (const OdRxObject *pViewport) const =0

virtual void	setView (OdRxObject *pViewport, const OdGePoint3d &target, const OdGeVector3d &direction, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, bool isPerspective, const OdGeVector2d &viewOffset=OdGeVector2d::kIdentity) const =0

virtual void	setLensLength (OdRxObject *pViewport, double lensLength) const =0

virtual double	lensLength (const OdRxObject *pViewport) const =0

virtual bool	isFrontClipOn (const OdRxObject *pViewport) const =0

virtual void	setFrontClipOn (OdRxObject *pViewport, bool frontClip) const =0

virtual bool	isBackClipOn (const OdRxObject *pViewport) const =0

virtual void	setBackClipOn (OdRxObject *pViewport, bool backClip) const =0

virtual bool	isFrontClipAtEyeOn (const OdRxObject *pViewport) const =0

virtual void	setFrontClipAtEyeOn (OdRxObject *pViewport, bool frontClipAtEye) const =0

virtual double	frontClipDistance (const OdRxObject *pViewport) const =0

virtual void	setFrontClipDistance (OdRxObject *pViewport, double frontClipDistance) const =0

virtual double	backClipDistance (const OdRxObject *pViewport) const =0

virtual void	setBackClipDistance (OdRxObject *pViewport, double backClipDistance) const =0

virtual void	setRenderMode (OdRxObject *pViewport, OdDb::RenderMode renderMode) const =0

virtual OdDb::RenderMode	renderMode (const OdRxObject *pViewport) const =0

virtual void	setVisualStyle (OdRxObject pViewport, OdDbStub visualStyleId) const =0

virtual OdDbStub *	visualStyle (const OdRxObject *pViewport) const =0

virtual void	setBackground (OdRxObject pViewport, OdDbStub backgroundId) const =0

virtual OdDbStub *	background (const OdRxObject *pViewport) const =0

virtual bool	isDefaultLightingOn (const OdRxObject *pViewport) const

virtual void	setDefaultLightingOn (OdRxObject *pViewport, bool isOn) const

virtual OdGiViewportTraits::DefaultLightingType	defaultLightingType (const OdRxObject *pViewport) const

virtual void	setDefaultLightingType (OdRxObject *pViewport, OdGiViewportTraits::DefaultLightingType lightingType) const

virtual void	frozenLayers (const OdRxObject *pViewport, OdDbStubPtrArray &frozenLayers) const

virtual void	setFrozenLayers (OdRxObject *pViewport, const OdDbStubPtrArray &frozenLayers) const

virtual bool	hasUcs (const OdRxObject *pViewport) const

virtual OdDb::OrthographicView	orthoUcs (const OdRxObject pViewport, const OdDbBaseDatabase pDb=0) const

virtual bool	setUcs (OdRxObject pViewport, OdDb::OrthographicView orthoUcs, const OdDbBaseDatabase pDb=0) const

virtual OdDbStub *	ucsName (const OdRxObject *pViewport) const

virtual bool	setUcs (OdRxObject pViewport, OdDbStub ucsId) const

virtual void	getUcs (const OdRxObject *pViewport, OdGePoint3d &origin, OdGeVector3d &xAxis, OdGeVector3d &yAxis) const

virtual void	setUcs (OdRxObject *pViewport, const OdGePoint3d &origin, const OdGeVector3d &xAxis, const OdGeVector3d &yAxis) const

virtual double	elevation (const OdRxObject *pViewport) const

virtual void	setElevation (OdRxObject *pViewport, double elevation) const

virtual bool	viewExtents (const OdRxObject *pViewport, OdGeBoundBlock3d &extents) const =0

virtual bool	plotExtents (const OdRxObject pViewport, OdGeBoundBlock3d &extents, bool bExtendOnly=false, bool bExtentsValid=true, const OdGeMatrix3d pWorldToEye=NULL) const

virtual bool	zoomExtents (OdRxObject pViewport, const OdGeBoundBlock3d pExtents=0, double extCoef=1.02) const

virtual OdGeMatrix3d	worldToEye (const OdRxObject *pViewport) const

virtual OdGeMatrix3d	eyeToWorld (const OdRxObject *pViewport) const

virtual bool	isPlotting (const OdRxObject *pViewport) const

virtual OdRxObjectPtr	plotDataObject (const OdRxObject *pViewport, bool bOpenForWrite=false) const

virtual OdDbStub *	annotationScale (const OdRxObject *pViewport) const

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 base class of Protocol Extension classes for OdDbViewport and OdDbViewportTableRecord objects.

Corresponding C++ library: TD_Db

See also: OdDbAbstractViewTableRecord

Remarks: Only the following objects are supported:

OdDbViewport OdDbViewportTableRecord Derivatives of one of the above

Definition at line 48 of file DbAbstractViewportData.h.

Member Function Documentation

◆ ambientLightColor()

virtual OdCmColor OdDbAbstractViewportData::ambientLightColor ( const OdRxObject * pViewport ) const

pure virtual

Returns the ambient light color of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ applyPlotSettings()

virtual bool OdDbAbstractViewportData::applyPlotSettings	(	OdRxObject *	pDestinationView,
		const OdRxObject *	pSourceView
	)		const

virtual

Applies plot settings to the view.

Parameters

pDestinationView	[in] Input pointer to the destination view object.
pSourceView	[in] Input pointer to the source view object.

Returns: Returns true if plot settings were applied successfully.

Reimplemented from OdAbstractViewPE.

◆ brightness()

virtual double OdDbAbstractViewportData::brightness ( const OdRxObject * pViewport ) const

pure virtual

Returns the brightness value of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ circleSides()

virtual OdUInt16 OdDbAbstractViewportData::circleSides ( const OdRxObject * pViewport ) const

pure virtual

Returns the circle zoom percent for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Returns: Returns a value in the range [1..20000].

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ compatibleCopyObject()

virtual OdDbStub* OdDbAbstractViewportData::compatibleCopyObject	(	const OdRxObject *	pViewport,
		OdDbStub *	pCopyObject
	)		const

virtual

Returns compatible visual style or background object for the specified viewport.

Parameters

pViewport	[in] Input pointer to the viewport object.
pCopyObject	[in] Input object ID.

Returns: Returns compatible objectID or null if no compatible objects are found.

Reimplemented from OdAbstractViewPE.

◆ contrast()

virtual double OdDbAbstractViewportData::contrast ( const OdRxObject * pViewport ) const

pure virtual

Returns the contrast value of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ gridIncrement()

virtual OdGeVector2d OdDbAbstractViewportData::gridIncrement ( const OdRxObject * pViewport ) const

pure virtual

Returns the grid increment for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ gridMajor()

virtual OdInt16 OdDbAbstractViewportData::gridMajor ( const OdRxObject * pViewport ) const

pure virtual

Returns the major grid lines frequency for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ gsView()

virtual OdGsView* OdDbAbstractViewportData::gsView ( const OdRxObject * pViewport ) const

pure virtual

Returns the gsView associated with the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ hasViewOffset()

virtual bool OdDbAbstractViewportData::hasViewOffset ( const OdRxObject * pViewport ) const

virtual

Returns true if and only if there is a view offset associated with the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Reimplemented from OdAbstractViewPE.

◆ isGridAdaptive()

virtual bool OdDbAbstractViewportData::isGridAdaptive ( const OdRxObject * pViewport ) const

pure virtual

Returns the adaptive grid flag for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isGridBoundToLimits()

virtual bool OdDbAbstractViewportData::isGridBoundToLimits ( const OdRxObject * pViewport ) const

pure virtual

Returns whether the grid is bound to limits for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isGridFollow()

virtual bool OdDbAbstractViewportData::isGridFollow ( const OdRxObject * pViewport ) const

pure virtual

Returns the grid follow flag for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isGridOn()

virtual bool OdDbAbstractViewportData::isGridOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the grid is on for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isGridSubdivisionRestricted()

virtual bool OdDbAbstractViewportData::isGridSubdivisionRestricted ( const OdRxObject * pViewport ) const

pure virtual

Returns wheether grid subdivision is restricted for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isSnapIsometric()

virtual bool OdDbAbstractViewportData::isSnapIsometric ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if isometric snap style is on for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isSnapOn()

virtual bool OdDbAbstractViewportData::isSnapOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the snap mode is on for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isUcsFollowModeOn()

virtual bool OdDbAbstractViewportData::isUcsFollowModeOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if UCS follow mode is on for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isUcsIconAtOrigin()

virtual bool OdDbAbstractViewportData::isUcsIconAtOrigin ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the UCS icon is at the UCS orgin for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isUcsIconVisible()

virtual bool OdDbAbstractViewportData::isUcsIconVisible ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the UCS icon is visible for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ isUcsSavedWithViewport()

virtual bool OdDbAbstractViewportData::isUcsSavedWithViewport ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the UCS that is associated with the specified viewport object will become active with activation of the viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ navvcubedisplay()

virtual int OdDbAbstractViewportData::navvcubedisplay ( const OdRxObject * pViewport ) const

virtual

Returns the type of the viewcube display of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

◆ ODRX_DECLARE_MEMBERS()

OdDbAbstractViewportData::ODRX_DECLARE_MEMBERS ( OdDbAbstractViewportData )

◆ setAmbientLightColor()

virtual void OdDbAbstractViewportData::setAmbientLightColor	(	OdRxObject *	pViewport,
		const OdCmColor &	color
	)		const

pure virtual

Sets the ambient light color to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
color	[in] Input ambient light color.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setBrightness()

virtual void OdDbAbstractViewportData::setBrightness	(	OdRxObject *	pViewport,
		double	brightness
	)		const

pure virtual

Sets the brightness value to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
brightness	[in] Input brightness value.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setCircleSides()

virtual void OdDbAbstractViewportData::setCircleSides	(	OdRxObject *	pViewport,
		OdUInt16	circleSides
	)		const

pure virtual

Sets circle zoom percent for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
circleSides	[in] Input circle zoom percent. [1..20000]

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setContrast()

virtual void OdDbAbstractViewportData::setContrast	(	OdRxObject *	pViewport,
		double	contrast
	)		const

pure virtual

Sets the contrast value to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
contrast	[in] Input brightness value.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setGridAdaptive()

virtual void OdDbAbstractViewportData::setGridAdaptive	(	OdRxObject *	pViewport,
		bool	gridDispFlag
	)		const

pure virtual

Controls the adaptive grid flag for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridDispFlag	[in] Input adaptive grid flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridBoundToLimits()

virtual void OdDbAbstractViewportData::setGridBoundToLimits	(	OdRxObject *	pViewport,
		bool	gridDispFlag
	)		const

pure virtual

Controls whether the grid is bound to limits for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridDispFlag	[in] Input flag for whether the grid is bound to limits.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridFollow()

virtual void OdDbAbstractViewportData::setGridFollow	(	OdRxObject *	pViewport,
		bool	gridDispFlag
	)		const

pure virtual

Controls the grid follow flag for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridDispFlag	[in] Input grid follow flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridIncrement()

virtual void OdDbAbstractViewportData::setGridIncrement	(	OdRxObject *	pViewport,
		const OdGeVector2d &	gridIncrement
	)		const

pure virtual

Sets the grid increment for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridIncrement	[in] Input grid increment.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridMajor()

virtual void OdDbAbstractViewportData::setGridMajor	(	OdRxObject *	pViewport,
		OdInt16	nMajor
	)		const

pure virtual

Sets the major grid lines frequency for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
nMajor	[in] Input major grid lines frequency.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridOn()

virtual void OdDbAbstractViewportData::setGridOn	(	OdRxObject *	pViewport,
		bool	gridOn
	)		const

pure virtual

Controls the grid for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridOn	[in] Input grid usage flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGridSubdivisionRestricted()

virtual void OdDbAbstractViewportData::setGridSubdivisionRestricted	(	OdRxObject *	pViewport,
		bool	gridDispFlag
	)		const

pure virtual

Controls whether grid subdivision is restricted for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
gridDispFlag	[in] Input flag for whether grid subdivision is restricted.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setGsView()

virtual void OdDbAbstractViewportData::setGsView	(	OdRxObject *	pViewport,
		OdGsView *	pGsView
	)		const

pure virtual

Sets the gsView to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
pGsView	[in] Input pointer to the gsView object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setNavvcubedisplay()

virtual OdResult OdDbAbstractViewportData::setNavvcubedisplay	(	OdRxObject *	pViewport,
		int	nVal
	)		const

virtual

Sets the type of the viewcube display to the specifiedvViewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
nVal	[in] Input type of the viewcube display.

◆ setProps()

virtual void OdDbAbstractViewportData::setProps	(	OdRxObject *	pViewport,
		const OdRxObject *	pSourceView
	)		const

virtual

Sets the parameters for the specified viewport object according to the arguments.

Parameters

pViewport	[in] Input pointer to the destination viewport object.
pSourceView	[in] Input pointer to the source viewport object.

◆ setSnapAngle()

virtual void OdDbAbstractViewportData::setSnapAngle	(	OdRxObject *	pViewport,
		double	snapAngle
	)		const

pure virtual

Sets the UCS snap angle for the specified viewport object (DXF 50).

Parameters

pViewport	[in] Input pointer to the viewport object.
snapAngle	[in] Input snap angle.

Remarks: All angles are expressed in radians.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setSnapBase()

virtual void OdDbAbstractViewportData::setSnapBase	(	OdRxObject *	pViewport,
		const OdGePoint2d &	snapBase
	)		const

pure virtual

Sets the UCS snap base point of the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
snapBase	[in] Input snap base.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setSnapIncrement()

virtual void OdDbAbstractViewportData::setSnapIncrement	(	OdRxObject *	pViewport,
		const OdGeVector2d &	snapIncrement
	)		const

pure virtual

Sets the snap increment of the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
snapIncrement	[in] Input snap increment.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setSnapIsometric()

virtual void OdDbAbstractViewportData::setSnapIsometric	(	OdRxObject *	pViewport,
		bool	snapIsometric
	)		const

pure virtual

Controls the isometric snap style for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
snapIsometric	[in] Input isometric snap style flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setSnapIsoPair()

virtual void OdDbAbstractViewportData::setSnapIsoPair	(	OdRxObject *	pViewport,
		OdUInt16	snapIsoPair
	)		const

pure virtual

Sets the snap IsoPair of this viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
snapIsoPair	[in] Input snap IsoPair.

Remarks: snapIsoPair must be one of the following:

Description 0 Left isoplane 1 Top isoplane 2 Right isoplane

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForDbViewTabRec.

◆ setSnapOn()

virtual void OdDbAbstractViewportData::setSnapOn	(	OdRxObject *	pViewport,
		bool	snapOn
	)		const

pure virtual

Controls the snap mode for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
snapOn	[in] Input snap mode flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForDbViewTabRec.

◆ setSun()

virtual OdDbStub* OdDbAbstractViewportData::setSun	(	OdRxObject *	pViewport,
		OdRxObject *	pSun
	)		const

pure virtual

Sets the sun object to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
pSun	[in] Input pointer to the sun object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setToneOperatorParameters()

virtual void OdDbAbstractViewportData::setToneOperatorParameters	(	OdRxObject *	pViewport,
		const OdGiToneOperatorParameters &	params
	)		const

pure virtual

Sets the tone operator parameters to the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
params	[in] Input tone operator parameters.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setUcs()

virtual void OdDbAbstractViewportData::setUcs	(	OdRxObject *	pDestinationView,
		const OdRxObject *	pSourceView
	)		const

virtual

Sets the parameters for the specified view object according to the arguments.

Parameters

pSourceView	[in] Input pointer to the source view object.
pDestinationView	[in] Input pointer to the destination view object.

Reimplemented from OdAbstractViewPE.

◆ setUcsFollowModeOn()

virtual void OdDbAbstractViewportData::setUcsFollowModeOn	(	OdRxObject *	pViewport,
		bool	ucsFollowMode
	)		const

pure virtual

Controls UCS follow mode for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
ucsFollowMode	[in] Input UCS follow mode flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setUcsIconAtOrigin()

virtual void OdDbAbstractViewportData::setUcsIconAtOrigin	(	OdRxObject *	pViewport,
		bool	atOrigin
	)		const

pure virtual

Controls the UCS icon display at the UCS orgin for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
atOrigin	[in] Input UCS icon flag.

Remarks: If atOrigin is true, the UCS icon is at the UCS origin for this viewport object. If false, it is at the corner for this viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForDbViewTabRec.

◆ setUcsIconVisible()

virtual void OdDbAbstractViewportData::setUcsIconVisible	(	OdRxObject *	pViewport,
		bool	iconVisible
	)		const

pure virtual

Controls the UCS icon visibility for the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
iconVisible	[in] Input visibility flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setUcsPerViewport()

virtual void OdDbAbstractViewportData::setUcsPerViewport	(	OdRxObject *	pViewport,
		bool	ucsPerViewport
	)		const

pure virtual

Controls activation of the UCS that is associated with the specified viewport object when the viewport object is activated.

Parameters

pViewport	[in] Input pointer to the viewport object.
ucsPerViewport	[in] Input activation of the UCS flag.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setView()

virtual void OdDbAbstractViewportData::setView	(	OdRxObject *	pDestinationView,
		const OdRxObject *	pSourceView
	)		const

virtual

Applies data from one view to another view.

Parameters

pDestinationView	[in] Input pointer to the destination view object.
pSourceView	[in] Input pointer to the source view object.

Reimplemented from OdAbstractViewPE.

◆ snapAngle()

virtual double OdDbAbstractViewportData::snapAngle ( const OdRxObject * pViewport ) const

pure virtual

Returns the UCS snap angle for the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ snapBase()

virtual OdGePoint2d OdDbAbstractViewportData::snapBase ( const OdRxObject * pViewport ) const

pure virtual

Returns the UCS snap base point of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ snapIncrement()

virtual OdGeVector2d OdDbAbstractViewportData::snapIncrement ( const OdRxObject * pViewport ) const

pure virtual

Returns the snap increment of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ snapIsoPair()

virtual OdUInt16 OdDbAbstractViewportData::snapIsoPair ( const OdRxObject * pViewport ) const

pure virtual

Returns the snap IsoPair of this viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Remarks: snapIsoPair() returns one of the following:

Description 0 Left isoplane 1 Top isoplane 2 Right isoplane

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ sunId()

virtual OdDbStub* OdDbAbstractViewportData::sunId ( const OdRxObject * pViewport ) const

pure virtual

Returns the sun ID of the specified viewport object.

Parameters

pViewport [in] Input pointer to the viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ TD_USING() [1/2]

OdDbAbstractViewportData::TD_USING ( OdAbstractViewPE::setUcs )

◆ TD_USING() [2/2]

OdDbAbstractViewportData::TD_USING ( OdAbstractViewPE::setView )

◆ toneOperatorParameters()

virtual void OdDbAbstractViewportData::toneOperatorParameters	(	const OdRxObject *	pViewport,
		OdGiToneOperatorParameters &	params
	)		const

pure virtual

Returns the tone operator parameters of the specified viewport object.

Parameters

pViewport	[in] Input pointer to the viewport object.
params	[out] Output tone operator parameters.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

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

DbAbstractViewportData.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ambientLightColor()

◆ applyPlotSettings()

◆ brightness()

◆ circleSides()

◆ compatibleCopyObject()

◆ contrast()

◆ gridIncrement()

◆ gridMajor()

◆ gsView()

◆ hasViewOffset()

◆ isGridAdaptive()

◆ isGridBoundToLimits()

◆ isGridFollow()

◆ isGridOn()

◆ isGridSubdivisionRestricted()

◆ isSnapIsometric()

◆ isSnapOn()

◆ isUcsFollowModeOn()

◆ isUcsIconAtOrigin()

◆ isUcsIconVisible()

◆ isUcsSavedWithViewport()

◆ navvcubedisplay()

◆ ODRX_DECLARE_MEMBERS()

◆ setAmbientLightColor()

◆ setBrightness()

◆ setCircleSides()

◆ setContrast()

◆ setGridAdaptive()

◆ setGridBoundToLimits()

◆ setGridFollow()

◆ setGridIncrement()

◆ setGridMajor()

◆ setGridOn()

◆ setGridSubdivisionRestricted()

◆ setGsView()

◆ setNavvcubedisplay()

◆ setProps()

◆ setSnapAngle()

◆ setSnapBase()

◆ setSnapIncrement()

◆ setSnapIsometric()

◆ setSnapIsoPair()

◆ setSnapOn()

◆ setSun()

◆ setToneOperatorParameters()

◆ setUcs()

◆ setUcsFollowModeOn()

◆ setUcsIconAtOrigin()

◆ setUcsIconVisible()

◆ setUcsPerViewport()

◆ setView()

◆ snapAngle()

◆ snapBase()

◆ snapIncrement()

◆ snapIsoPair()

◆ sunId()

◆ TD_USING() [1/2]

◆ TD_USING() [2/2]

◆ toneOperatorParameters()