#include <AbstractViewPE.h>

Inheritance diagram for OdAbstractViewPE:

Public Member Functions
	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 bool	hasViewOffset (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 void	setView (OdRxObject pDestinationView, const OdRxObject pSourceView) 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 void	setUcs (OdRxObject pDestinationView, const OdRxObject pSourceView) 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 bool	applyPlotSettings (OdRxObject pDestinationView, const OdRxObject pSourceView) const

virtual OdDbStub *	annotationScale (const OdRxObject *pViewport) const

virtual OdDbStub *	compatibleCopyObject (const OdRxObject pViewport, OdDbStub pCopyObject) 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 defines the interface for Protocol Extension classes for OdGsView, OdDbViewTableRecord, OdDbViewport and OdDbViewportTableRecord objects.

Note: Only the following objects are supported:

OdGsView OdDbViewTableRecord OdDbViewport OdDbViewportTableRecord Derivatives of one of the above.

Corresponding C++ library: TD_Db

Definition at line 56 of file AbstractViewPE.h.

Member Function Documentation

◆ annotationScale()

virtual OdDbStub* OdAbstractViewPE::annotationScale ( const OdRxObject * pViewport ) const

virtual

Returns annotation scale object ID associated with this Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbViewport.

◆ applyPlotSettings()

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

virtual

Applies plot settings to view.

Parameters

pSourceView	[in] Pointer to the source Viewport object.
pDestinationView	[in] Pointer to the destination Viewport object

Returns: Returns true if plot settings was applied successfully.

Reimplemented in OdDbAbstractViewportData.

◆ backClipDistance()

virtual double OdAbstractViewPE::backClipDistance ( const OdRxObject * pViewport ) const

pure virtual

Returns the back clip distance for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ background()

virtual OdDbStub* OdAbstractViewPE::background ( const OdRxObject * pViewport ) const

pure virtual

Returns background for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ compatibleCopyObject()

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

virtual

Returns compatible visual style or background object for specified viewport.

Parameters

pViewport	[in] Pointer to the Viewport object.
pCopyObject	[in] Input object ID.

Returns: Returns comptaible objectID or null in case if there is no any compatible objects found.

Reimplemented in OdDbAbstractViewportData.

◆ defaultLightingType()

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

virtual

Returns default lighting type.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ direction()

virtual OdGeVector3d OdAbstractViewPE::direction ( const OdRxObject * pViewport ) const

pure virtual

Returns the WCS view direction of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ elevation()

virtual double OdAbstractViewPE::elevation ( const OdRxObject * pViewport ) const

virtual

Returns the elevation for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ eyeToWorld()

virtual OdGeMatrix3d OdAbstractViewPE::eyeToWorld ( const OdRxObject * pViewport ) const

virtual

Returns the transformation matrix from EyeSpace to WCS for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

See also: Coordinate Systems

◆ fieldHeight()

virtual double OdAbstractViewPE::fieldHeight ( const OdRxObject * pViewport ) const

pure virtual

Returns the DCS field height of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

See also: Coordinate Systems

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ fieldWidth()

virtual double OdAbstractViewPE::fieldWidth ( const OdRxObject * pViewport ) const

pure virtual

Returns the DCS field width of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

See also: Coordinate Systems

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ frontClipDistance()

virtual double OdAbstractViewPE::frontClipDistance ( const OdRxObject * pViewport ) const

pure virtual

Returns the front clip distance for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ frozenLayers()

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

virtual

Returns the frozen layers for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
frozenLayers	[out] Receives an array of frozen layer Object IDs.

Reimplemented in OdDbAbstractViewportDataForDbViewport.

◆ getUcs()

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

virtual

Returns the UCS associated with the specified Viewport object.

Parameters

origin	[out] Receives the UCS origin.
xAxis	[out] Receives the UCS X-axis.
yAxis	[out] Receives the UCS Y-axis.

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ hasUcs()

virtual bool OdAbstractViewPE::hasUcs ( const OdRxObject * pViewport ) const

virtual

Returns true if and only if there is a UCS associated with the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ hasViewOffset()

virtual bool OdAbstractViewPE::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] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportData.

◆ hasViewport()

virtual bool OdAbstractViewPE::hasViewport ( const OdRxObject * pViewport ) const

virtual

Returns true if and only if there is a viewport data associated with the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec.

◆ isBackClipOn()

virtual bool OdAbstractViewPE::isBackClipOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if back clipping is on for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ isDefaultLightingOn()

virtual bool OdAbstractViewPE::isDefaultLightingOn ( const OdRxObject * pViewport ) const

virtual

Returns default lighting state.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ isFrontClipAtEyeOn()

virtual bool OdAbstractViewPE::isFrontClipAtEyeOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the front clipping plane passes through the camera for the specified Viewport object.

Remarks: If true, the front clipping plane ignores the front clip distance.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ isFrontClipOn()

virtual bool OdAbstractViewPE::isFrontClipOn ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if front clipping is on for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ isPerspective()

virtual bool OdAbstractViewPE::isPerspective ( const OdRxObject * pViewport ) const

pure virtual

Returns true if and only if the projection type for the specified Viewport object is perspective.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ isPlotting()

virtual bool OdAbstractViewPE::isPlotting ( const OdRxObject * pViewport ) const

virtual

Returns true if and only if viewport is used during plotting.

Parameters

pViewport [in] Pointer to the Viewport object.

◆ lensLength()

virtual double OdAbstractViewPE::lensLength ( const OdRxObject * pViewport ) const

pure virtual

Returns the perspective lens length for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ lowerLeftCorner()

virtual OdGePoint2d OdAbstractViewPE::lowerLeftCorner ( const OdRxObject * pViewport ) const

virtual

Returns the lower-left corner of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Remarks: point == (0.0, 0.0) corresponds to the lower-left corner of the graphics area. point == (1.0, 1.0) corresponds to the upper-right corner of the graphics area.

See also: Coordinate Systems

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec.

◆ ODRX_DECLARE_MEMBERS()

OdAbstractViewPE::ODRX_DECLARE_MEMBERS ( OdAbstractViewPE )

◆ orthoUcs()

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

virtual

Returns orthographic view type of the UCS associated with the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
pDb	[in] Working database. If object is a database resident this parameter is ignored.

Remarks: orthoUcs() returns one of the following:

Value View type OdDb::kNonOrthoView 0 Non-orthographic with respect to the UCS OdDb::kTopView 1 Top view with respect to the UCS OdDb::kBottomView 2 Bottom view with respect to the UCS OdDb::kFrontView 3 Front view with respect to the UCS OdDb::kBackView 4 Back view with respect to the UCS OdDb::kLeftView 5 Left view with respect to the UCS OdDb::kRightView 6 Right view with respect to the UCS

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ plotDataObject()

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

virtual

Returns the plot settings object pointer associated with this Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
bOpenForWrite	[in] Mode in which to open the object.

Remarks: Return OdDbPlotSettings object for OdDbViewportTableRecord Viewport object and OdDbViewport object for OdDbViewport object or OdDbPlotSettings object for overall OdDbViewport. Return Null object pointer for all other cases.

See also: OdDbAbstractPlotData

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ plotExtents()

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

virtual

Returns the eye coordinate system plotting extents of the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
extents	[out] Receives the extents.
bExtendOnly	[in] Only extend exist extents by overall viewport extents.
bExtentsValid	[in] Input extents is valid for extending using overall viewport extents.
pWorldToEye	[in] Optional WCS to ECS transformation for plot extents extending.

Returns: Returns true if and only if the extents are defined.

Note: The components of extents are clipped to the range [-10e100..10e100].

See also: Coordinate Systems

Reimplemented in OdDbAbstractViewportDataForDbViewport.

◆ renderMode()

virtual OdDb::RenderMode OdAbstractViewPE::renderMode ( const OdRxObject * pViewport ) const

pure virtual

Returns the render mode for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Remarks: renderMode() returns one of the following:

Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setBackClipDistance()

virtual void OdAbstractViewPE::setBackClipDistance	(	OdRxObject *	pViewport,
		double	backClipDistance
	)		const

pure virtual

Sets the front clip distance for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
backClipDistance	[in] Back clip distance.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setBackClipOn()

virtual void OdAbstractViewPE::setBackClipOn	(	OdRxObject *	pViewport,
		bool	backClip
	)		const

pure virtual

Controls back clipping for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
backClip	[in] Controls back clip.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setBackground()

virtual void OdAbstractViewPE::setBackground	(	OdRxObject *	pViewport,
		OdDbStub *	backgroundId
	)		const

pure virtual

Sets background for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
backgroundId	[in] Background Object ID.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setDefaultLightingOn()

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

virtual

Sets default lighting state.

Parameters

pViewport	[in] Pointer to the Viewport object.
isOn	[in] New default lighting state.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setDefaultLightingType()

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

virtual

Sets default lighting type.

Parameters

pViewport	[in] Pointer to the Viewport object.
lightingType	[in] New default lighting type.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setElevation()

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

virtual

Sets the elevation for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
elevation	[in] Elevation.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setFrontClipAtEyeOn()

virtual void OdAbstractViewPE::setFrontClipAtEyeOn	(	OdRxObject *	pViewport,
		bool	frontClipAtEye
	)		const

pure virtual

Controls the front clipping plane's passing through the camera for the specified Viewport object.

Remarks: If and only if frontClipAtEye is true, the front clipping plane ignores the front clip distance.

Parameters

pViewport	[in] Pointer to the Viewport object.
frontClipAtEye	[in] Controls FrontClipAtEye.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setFrontClipDistance()

virtual void OdAbstractViewPE::setFrontClipDistance	(	OdRxObject *	pViewport,
		double	frontClipDistance
	)		const

pure virtual

Sets the front clip distance for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
frontClipDistance	[in] Front clip distance.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setFrontClipOn()

virtual void OdAbstractViewPE::setFrontClipOn	(	OdRxObject *	pViewport,
		bool	frontClip
	)		const

pure virtual

Controls front clipping for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
frontClip	[in] Controls front clip.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setFrozenLayers()

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

virtual

Sets the frozen layers for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
frozenLayers	[in] Array of frozen layer Object IDs.

Reimplemented in OdDbAbstractViewportDataForDbViewport.

◆ setLensLength()

virtual void OdAbstractViewPE::setLensLength	(	OdRxObject *	pViewport,
		double	lensLength
	)		const

pure virtual

Sets the perspective lens length for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
lensLength	[in] Perspective lens length.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setRenderMode()

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

pure virtual

Sets the render mode for the specified Viewport object.

Parameters

renderMode	[in] Render mode.
pViewport	[in] Pointer to the Viewport object.

Remarks: renderMode must be one of the following:

Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.

Implemented in OdDbAbstractViewportDataForAbstractViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ setUcs() [1/4]

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

virtual

Sets the UCS associated with the specified Viewport object.

\param pDestinationView [in]  Pointer to the destination Viewport object

Parameters

pSourceView [in] Pointer to the source Viewport object.

Reimplemented in OdDbAbstractViewportData.

◆ setUcs() [2/4]

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

virtual

Sets the UCS associated with the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
origin	[in] The UCS origin.
xAxis	[in] The UCS X-axis.
yAxis	[in] The UCS Y-axis.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setUcs() [3/4]

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

virtual

Sets the UCS associated with the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
orthoUcs	[in] Orthographic view type.
pDb	[in] Working database. If object is a database resident this parameter is ignored.

Remarks: orthoUcs must be one of the following:

Value View type OdDb::kNonOrthoView 0 Non-orthographic with respect to the UCS OdDb::kTopView 1 Top view with respect to the UCS OdDb::kBottomView 2 Bottom view with respect to the UCS OdDb::kFrontView 3 Front view with respect to the UCS OdDb::kBackView 4 Back view with respect to the UCS OdDb::kLeftView 5 Left view with respect to the UCS OdDb::kRightView 6 Right view with respect to the UCS

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setUcs() [4/4]

virtual bool OdAbstractViewPE::setUcs	(	OdRxObject *	pViewport,
		OdDbStub *	ucsId
	)		const

virtual

Sets the UCS associated with the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
ucsId	[in] Object ID of UCS.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setView() [1/2]

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

virtual

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

Parameters

pDestinationView	[in] Pointer to the destination Viewport object
pSourceView	[in] Pointer to the source Viewport object.

See also: Coordinate Systems

Reimplemented in OdDbAbstractViewportData.

◆ setView() [2/2]

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

pure virtual

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

Parameters

pViewport	[in] Pointer to the Viewport object.
target	[in] WCS view target.
direction	[in] WCS view direction.
upVector	[in] WCS Up vector.
fieldWidth	[in] DCS field width.
fieldHeight	[in] DCS field height.
isPerspective	[in] Controls perspective.
viewOffset	[in] View offset vector.

See also: Coordinate Systems

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ setViewport()

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

virtual

Sets the corners of the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
lowerLeft	[in] Lower-left corner.
upperRight	[in] Upper-right corner.

Remarks: point == (0.0, 0.0) corresponds to the lower-left corner of the graphics area. point == (1.0, 1.0) corresponds to the upper-right corner of the graphics area.

See also: Coordinate Systems

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec.

◆ setVisualStyle()

virtual void OdAbstractViewPE::setVisualStyle	(	OdRxObject *	pViewport,
		OdDbStub *	visualStyleId
	)		const

pure virtual

Sets visual style for the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
visualStyleId	[in] Visual style Object ID.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ target()

virtual OdGePoint3d OdAbstractViewPE::target ( const OdRxObject * pViewport ) const

pure virtual

Returns the WCS view target of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ ucsName()

virtual OdDbStub* OdAbstractViewPE::ucsName ( const OdRxObject * pViewport ) const

virtual

Returns the Object ID of the UCS name associated with the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ upperRightCorner()

virtual OdGePoint2d OdAbstractViewPE::upperRightCorner ( const OdRxObject * pViewport ) const

virtual

Returns the upper-right corner of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Remarks: point == (0.0, 0.0) corresponds to the lower-left corner of the graphics area. point == (1.0, 1.0) corresponds to the upper-right corner of the graphics area.

See also: Coordinate Systems

Reimplemented in OdDbAbstractViewportDataForDbVpTabRec.

◆ upVector()

virtual OdGeVector3d OdAbstractViewPE::upVector ( const OdRxObject * pViewport ) const

pure virtual

Returns the WCS Up vector of the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ viewExtents()

virtual bool OdAbstractViewPE::viewExtents	(	const OdRxObject *	pViewport,
		OdGeBoundBlock3d &	extents
	)		const

pure virtual

Returns the eye coordinate system extents of the specified Viewport object.

Parameters

pViewport	[in] Pointer to the Viewport object.
extents	[out] Receives the extents.

Returns: Returns true if and only if the extents are defined.

Note: The components of extents are clipped to the range [-10e100..10e100].

See also: Coordinate Systems

Implemented in OdDbAbstractViewportDataForDbVpTabRec, OdDbAbstractViewportDataForDbViewTabRec, and OdDbAbstractViewportDataForDbViewport.

◆ viewOffset()

virtual OdGeVector2d OdAbstractViewPE::viewOffset ( const OdRxObject * pViewport ) const

virtual

Returns the view offset vector for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Reimplemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ viewTwist()

virtual double OdAbstractViewPE::viewTwist ( const OdRxObject * pViewport ) const

pure virtual

Returns the view DCS twist angle for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ visualStyle()

virtual OdDbStub* OdAbstractViewPE::visualStyle ( const OdRxObject * pViewport ) const

pure virtual

Returns visual style for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

Implemented in OdDbAbstractViewportDataForDbViewport, and OdDbAbstractViewportDataForAbstractViewTabRec.

◆ worldToEye()

virtual OdGeMatrix3d OdAbstractViewPE::worldToEye ( const OdRxObject * pViewport ) const

virtual

Returns the transformation matrix from WCS to EyeSpace for the specified Viewport object.

Parameters

pViewport [in] Pointer to the Viewport object.

See also: Coordinate Systems

◆ zoomExtents()

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

virtual

Modifies the specified Viewport object to fit the specified eye coordinate system extents.

Parameters

pViewport	[in] Pointer to the Viewport object.
pExtents	[in] Pointer to the extents.
extCoef	[in] Optional extents multiplier.

Returns: Returns true if and only if the extents are defined.

Remarks: If pExtents is null, this function calls viewExtents() to determine the extents.

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

AbstractViewPE.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ annotationScale()

◆ applyPlotSettings()

◆ backClipDistance()

◆ background()

◆ compatibleCopyObject()

◆ defaultLightingType()

◆ direction()

◆ elevation()

◆ eyeToWorld()

◆ fieldHeight()

◆ fieldWidth()

◆ frontClipDistance()

◆ frozenLayers()

◆ getUcs()

◆ hasUcs()

◆ hasViewOffset()

◆ hasViewport()

◆ isBackClipOn()

◆ isDefaultLightingOn()

◆ isFrontClipAtEyeOn()

◆ isFrontClipOn()

◆ isPerspective()

◆ isPlotting()

◆ lensLength()

◆ lowerLeftCorner()

◆ ODRX_DECLARE_MEMBERS()

◆ orthoUcs()

◆ plotDataObject()

◆ plotExtents()

◆ renderMode()

◆ setBackClipDistance()

◆ setBackClipOn()

◆ setBackground()

◆ setDefaultLightingOn()

◆ setDefaultLightingType()

◆ setElevation()

◆ setFrontClipAtEyeOn()

◆ setFrontClipDistance()

◆ setFrontClipOn()

◆ setFrozenLayers()

◆ setLensLength()

◆ setRenderMode()

◆ setUcs() [1/4]

◆ setUcs() [2/4]

◆ setUcs() [3/4]

◆ setUcs() [4/4]

◆ setView() [1/2]

◆ setView() [2/2]

◆ setViewport()

◆ setVisualStyle()

◆ target()

◆ ucsName()

◆ upperRightCorner()

◆ upVector()

◆ viewExtents()

◆ viewOffset()

◆ viewTwist()

◆ visualStyle()

◆ worldToEye()

◆ zoomExtents()