#include <GsViewImpl.h>

Inheritance diagram for OdGsViewImpl:

Classes
struct	GsViewOverlayData

class	GsViewOverlayDataContainer

Public Types
enum	ProjectionMatrixFlags { kProjectionIncludeDept = (1 << 0) , kProjectionIncludeClip = (1 << 1) , kProjectionIncludePerspective = (1 << 2) , kProjectionIncludeRotation = (1 << 3) , kProjectionIncludeAll = 0x0F , kProjectionIncludeAllNoDept = kProjectionIncludeAll & ~kProjectionIncludeDept }

Public Types inherited from OdGsView
enum	RenderMode { kBoundingBox = -1 , k2DOptimized = 0 , kWireframe = 1 , kHiddenLine = 2 , kFlatShaded = 3 , kGouraudShaded = 4 , kFlatShadedWithWireframe = 5 , kGouraudShadedWithWireframe = 6 , kNone }

enum	Projection { kParallel = 0 , kPerspective = 1 }

enum	SelectionMode { kWindow = 0 , kCrossing = 1 , kFence = 2 , kWPoly = 3 , kCPoly = 4 , kPoint = 16 , kPointLast = 17 }

enum	DefaultLightingType { kOneLight = 0 , kTwoLights , kBackLight }

enum	ViewUpdateFlags { kCameraChanged = 1 }

enum	ClearColor { kTransparent , kDeviceBackground , kPaletteBackground }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsViewImpl)

	OdGsViewImpl ()

	~OdGsViewImpl ()

virtual void	init (OdGsBaseVectorizeDevice pDevice, const OdGsClientViewInfo pViewInfo=0, bool enableLayerVisibilityPerView=false)

virtual OdGsDevice *	device () const

virtual void	clientViewInfo (OdGsClientViewInfo &viewInfo) const

virtual RenderMode	mode () const

bool	setModeOverride (RenderMode mode)

virtual void	setMode (RenderMode mode)

virtual void	freezeLayer (OdDbStub *layerID)

virtual void	thawLayer (OdDbStub *layerID)

virtual void	clearFrozenLayers ()

virtual void	setViewportBorderProperties (ODCOLORREF color, int width)

virtual void	getViewportBorderProperties (ODCOLORREF &color, int &width) const

virtual void	setViewportBorderVisibility (bool visible)

virtual bool	isViewportBorderVisible () const

virtual void	setEnableFrontClip (bool enable)

virtual bool	isFrontClipped () const

virtual void	setFrontClip (double distance)

virtual double	frontClip () const

virtual void	setEnableBackClip (bool enable)

virtual bool	isBackClipped () const

virtual void	setBackClip (double distance)

virtual double	backClip () const

virtual OdGePoint3d	position () const

virtual OdGePoint3d	target () const

virtual OdGeVector3d	upVector () const

virtual double	fieldWidth () const

virtual double	fieldHeight () const

double	windowAspect () const

virtual double	lensLength () const

virtual void	setLensLength (double lensLength)

virtual bool	isPerspective () const

virtual void	beginInteractivity (double frameRateInHz)

virtual bool	isInInteractivity () const

virtual double	interactivityFrameRate () const

virtual void	endInteractivity ()

virtual void	flush ()

virtual void	hide ()

virtual void	show ()

virtual bool	isVisible ()

virtual OdGsViewPtr	cloneView (bool cloneViewParameters=true, bool cloneGeometry=false)

virtual bool	exceededBounds ()

virtual void	enableStereo (bool enabled)

virtual bool	isStereoEnabled () const

virtual void	setStereoParameters (double magnitude, double parallax)

virtual void	getStereoParameters (double &magnitude, double &parallax) const

virtual void	initLights (OdRxIterator *pLightsIterator)

virtual void	getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)

virtual void	setViewport (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)

virtual void	setViewport (const OdGsDCRect &screenRect)

virtual void	setViewport (const OdGsDCRectDouble &screenRec)

virtual void	getViewport (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const

virtual void	getViewport (OdGsDCRect &screenRect) const

virtual void	getViewport (OdGsDCRectDouble &screenRec) const

virtual OdGeMatrix3d	screenMatrix () const

virtual OdGeMatrix3d	worldToDeviceMatrix () const

virtual OdGeMatrix3d	objectToDeviceMatrix () const

virtual OdGeMatrix3d	viewingMatrix () const

virtual OdGeMatrix3d	projectionMatrix () const

virtual void	viewParameters (OdGsView *pView) const

virtual double	lineweightToDcScale () const

virtual void	setLineweightToDcScale (double scale)

virtual void	setLineweightEnum (int numLineweights, const OdUInt8 lineweights, const OdUInt16 altSourceLwds)

virtual void	setLinetypeScaleMultiplier (double linetypeScaleMultiplier)

virtual void	setAlternateLinetypeScaleMultiplier (double linetypeAlternateScaleMultiplier)

virtual double	linetypeScaleMultiplier () const

virtual void	dolly (const OdGeVector3d &dollyVector)

virtual void	dolly (double xDolly, double yDolly, double zDolly)

virtual void	roll (double rollAngle)

virtual void	orbit (double xOrbit, double yOrbit)

virtual void	zoom (double zoomFactor)

virtual void	pan (double xPan, double yPan)

virtual void	setView (const OdGePoint3d &position, const OdGePoint3d &target, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, Projection projection=kParallel)

virtual void	zoomExtents (const OdGePoint3d &minPt, const OdGePoint3d &maxPt)

virtual void	zoomWindow (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)

virtual bool	pointInView (const OdGePoint3d &pt) const

virtual bool	extentsInView (const OdGePoint3d &minPt, const OdGePoint3d &maxPt) const

virtual void	viewportClipRegion (OdIntArray &counts, OdGePoint2dArray &vertices) const

virtual void	viewportClipRegion (OdIntArray &counts, OdGsDCPointArray &dcPts) const

virtual void	setViewportClipRegion (int numContours, const int numVertices, const OdGePoint2d vertices)

virtual void	setViewportClipRegion (int numContours, int const numVertices, OdGsDCPoint const vertices)

bool	isDependentViewportView () const

bool	isDependentGeometryView () const

bool	isHelperView () const

const OdGsBaseModule *	getGsModulePtr () const

const OdGiContextualColors *	contextualColors () const

void	setContextualColors (OdGiContextualColors *pColors)

virtual bool	pointInViewport (const OdGePoint2d &screenPoint) const

virtual void	setClearColor (ClearColor color)

virtual void	invalidate ()

virtual void	invalidate (const OdGsDCRect &rect)

virtual void	invalidateCachedViewportGeometry ()

virtual void	select (const OdGsDCPoint points, int numPoints, OdGsSelectionReactor pReactor, SelectionMode mode=kCrossing)

virtual bool	add (OdGiDrawable sceneGraph, OdGsModel model)

virtual int	numRootDrawables () const

virtual OdDbStub *	rootDrawableIdAt (int i, OdGsModelPtr *pModelReturn=0) const

virtual OdGiDrawablePtr	rootDrawableAt (int i, OdGsModelPtr *pModelReturn=0) const

virtual bool	erase (OdGiDrawable *sceneGraph)

virtual void	eraseAll ()

virtual OdGsModel *	getModel (const OdGiDrawable *pDrawable) const

virtual OdGsModelArray	getModelList () const

virtual bool	isValid () const

virtual void	getNumPixelsInUnitSquare (const OdGePoint3d &givenWorldpt, OdGePoint2d &pixelArea, bool includePerspective=true) const

virtual void	setBackground (OdDbStub *backgroundId)

virtual OdDbStub *	background () const

virtual void	setVisualStyle (OdDbStub *visualStyleId)

virtual OdDbStub *	visualStyle () const

virtual void	setVisualStyle (const OdGiVisualStyle &visualStyle)

virtual bool	visualStyle (OdGiVisualStyle &vs) const

virtual void	enableDefaultLighting (bool bEnable, DefaultLightingType lightType=kTwoLights)

bool	defaultLightingEnabled () const

DefaultLightingType	defaultLightingType () const

OdUInt32	viewportId () const

bool	isValidViewportId (const OdUInt32 vpId) const

OdDbStub *	getViewportObjectId () const

OdGsBaseVectorizeDevice *	baseDevice ()

const OdGsBaseVectorizeDevice *	baseDevice () const

OdDbStub *	annotationScaleId () const

OdIntPtr	drawablesFilterFunction () const

virtual bool	viewExtents (OdGeBoundBlock3d &extents) const =0

virtual void	select (const OdGePoint2d aPtDc, int numPoints, OdGsSelectionReactor pReactor, SelectionMode mode=kCrossing)=0

bool	isSnapping () const

void	setSnapping (bool val)

bool	isRegenOnDrawForbidden () const

void	setRegenOnDrawForbidden (bool val)

bool	isAccumulateVpChanges () const

virtual void	clearLinetypeCache ()=0

double	linetypeAlternateScaleMultiplier () const

virtual bool	isSupportLegacyWireframeMode () const

virtual bool	isLegacyWireframeMode () const

virtual void	setLegacyWireframeMode (bool bSet)

virtual bool	isSupportLegacyHiddenMode () const

virtual bool	isLegacyHiddenMode () const

virtual void	setLegacyHiddenMode (bool bSet)

bool	isSupportPlotStyles () const

virtual bool	isPlotTransparency () const

virtual void	setPlotTransparency (bool bSet)

OdUInt32	frozenLayers () const

void	frozenLayers (OdDbStubPtrArray &frozenLayers) const

bool	isLayerVisible (OdDbStub *layerId) const

void	includeFrozenLayersVisibilityInViewExtents (bool bEnable)

bool	isFrozenLayersVisibilityIncludedInViewExtents () const

int	lineweightToPixels (OdDb::LineWeight lineweight) const

double	lineweightToPixels (double lineweight) const

void	screenRect (OdGsDCPoint &lowerLeft, OdGsDCPoint &upperRight) const

void	screenRect (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const

void	screenRectNorm (OdGsDCRect &normalizedRect) const

void	viewportDcCorners (OdGePoint2d &lower_left, OdGePoint2d &upper_right) const

bool	doPerspectivePt (OdGePoint3d &point) const

bool	doInversePerspectivePt (OdGePoint3d &point) const

const OdGeMatrix3d &	eyeToWorldMatrix () const

const OdGeMatrix3d &	worldToEyeMatrix () const

OdGeMatrix3d	eyeToScreenMatrix (OdGsOverlayId nOverlay=kGsMainOverlay) const

OdGeMatrix3d	worldToDeviceMatrix (OdGsOverlayId nOverlay) const

OdGeMatrix3d	objectToDeviceMatrix (OdGsOverlayId nOverlay) const

OdGeMatrix3d	projectionMatrix (OdUInt32 nIncludes, OdGsOverlayId nOverlay=kGsMainOverlay) const

ClearColor	clearColor () const

OdGsOverlayId	extentsToPixels (OdGsDCRect &rc, const OdGeExtents3d &worldExt, const OdGsBaseModel *pModel, OdDb::LineWeight extendByLineweight=OdDb::kLnWt000) const

virtual void	invalidate (const OdGeExtents3d &worldExt, const OdGsBaseModel *pModel, OdDb::LineWeight extendByLineweight=OdDb::kLnWt000)

void	invalidate (const OdGsUpdateExtents &extents, const OdGsBaseModel *pModel)

void	invalidateRegion (const OdGiPathNode &path)

OdGsDCRectArray	invalidRects (OdGsOverlayId nOverlay=kGsMainOverlay) const

bool	isViewportOnScreen () const

bool	isCompletelyVisible () const

void	setCompletelyVisible (bool val)

void	setInversion (bool invertedX, bool invertedY)

virtual OdGiRegenType	getRegenType () const

double	focalLength () const

const OdGeVector3d &	eyeVector () const

const OdGeVector3d &	xVector () const

const OdGeVector3d &	getUpVector () const

double	getLinetypeScaleMultiplier () const

double	getLinetypeGenerationCriteria () const

virtual double	getDeviation (const OdGiDeviationType deviationType, const OdGePoint3d &pointOnCurve, bool bRecalculate=false) const

void	initDeviation ()

int	cachedDrawables () const

OdUInt32	localViewportId (const OdGsBaseModel *pModel) const

virtual bool	isLocalViewportIdCompatible (const OdGsViewImpl *pView) const

OdGsViewLocalId &	getViewLocalId ()

virtual bool	isViewRegenerated () const

const OdGePoint2d &	center () const

void	setCenter (const OdGePoint2d &center)

OdGePoint3d	focusPoint () const

bool	isNonRectClipped () const

bool	hasLweights () const

OdUInt32	numLweights () const

OdUInt32	getLweight (int nLineweight) const

const OdUInt8Array &	getLweightsEnum () const

const OdUInt16Array &	getLweightsEnum2 () const

const OdGePoint2d &	dcScreenMin () const

const OdGePoint2d &	dcScreenMax () const

const OdGePoint2d &	dcLowerLeft () const

const OdGePoint2d &	dcUpperRight () const

OdGeMatrix3d	perspectiveMatrix () const

void	invalidateCachedViewportGeometry (OdUInt32 mask)

virtual void	registerOverlay (const OdGsModel *pModel)

virtual void	unregisterOverlay (const OdGsModel *pModel)

virtual int	partialUpdateExtentsEnlargement () const

double	calcDeviation (const OdGiDeviationType type, const OdGePoint3d &pt) const

OdGsPropertiesPtr	getViewportPropertiesRoot () const

bool	updateViewportProperties (OdUInt32 incFlags)

OdGsPropertiesPtr	getViewportPropertiesForType (OdGsProperties::PropertiesType type) const

const OdGeMatrix3d &	rotationMatrix () const

short	viewportRotation () const

bool	isRotated () const

double	unrotatedFieldHeight () const

double	unrotatedFieldWidth () const

double	actualFieldWidth () const

double	actualFieldHeight () const

virtual void	initCullingVolume ()

void	setCullingVolume (OdGsCullingVolumePtr newVol)

OdGsCullingVolumePtr	cullingVolume () const

virtual bool	isCullingVolumeInitialized () const

virtual bool	cullingVolumeIntersectWithOpt (const OdGsCullingPrimitive &prim) const

virtual OdGsCullingVolume::IntersectionStatus	cullingVolumeIntersectWith (const OdGsCullingPrimitive &prim) const

virtual void	cullingVolumeTransformBy (const OdGeMatrix3d &xfm)

virtual void	setViewport3dClipping (const OdGiClipBoundary pBoundary, const OdGiAbstractClipBoundary pClipInfo=NULL)

virtual const OdGiClipBoundary *	viewport3dClipping (const OdGiAbstractClipBoundary **ppClipInfo=NULL) const

OdGiClipBoundaryWithAbstractData *	viewport3dClippingObject ()

bool	hasViewport3dClipping () const

virtual bool	saveViewState (OdGsFiler *pFiler) const

virtual bool	loadViewState (OdGsFiler *pFiler)

virtual bool	saveClientViewState (OdGsFiler *pFiler) const

virtual bool	loadClientViewState (OdGsFiler *pFiler)

virtual const OdDbStubPtrArray &	getFrozenLayersDiff () const

virtual void	enableAntiAliasing (OdUInt32 nMode)

virtual OdUInt32	antiAliasingMode () const

virtual void	enableSSAO (bool bEnable) ODRX_OVERRIDE

virtual bool	ssaoMode () const ODRX_OVERRIDE

void	addClippingShape (const OdSiShape *)

void	removeClippingShape (const OdSiShape *)

const OdSiShapeConstPtrArray &	clippingShapes () const

void	setClippingShapes (const OdSiShapeConstPtrArray &s)

virtual bool	isShowFrozenLayers ()

virtual void	setShowFrozenLayers (bool bSet)

Public Member Functions inherited from OdGsView
	ODRX_DECLARE_MEMBERS (OdGsView)

virtual OdGiContext *	userGiContext () const =0

virtual void	setUserGiContext (OdGiContext *pUserGiContext)=0

void	removeViewportClipRegion ()

void	removeViewport3dClipping ()

virtual void	update ()=0

virtual void	collide (OdGiPathNode const const pInputList, OdUInt32 nInputListSize, OdGsCollisionDetectionReactor pReactor, OdGiPathNode const const pCollisionWithList=NULL, OdUInt32 nCollisionWithListSize=0, const OdGsCollisionDetectionContext pCtx=NULL)=0

virtual void	rayTrace (const OdGePoint3d &rayOrigin, const OdGeVector3d &rayDirection, OdGsRayTraceReactor pReactor, bool bSortedSelection=false, OdGiPathNode const const *pObjectList=NULL, OdUInt32 nObjectListSize=0)=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

Static Public Member Functions
static OdGsViewImpl *	safeCast (OdGsView *pView)

static const OdGsViewImpl *	safeCast (const OdGsView *pView)

static double	lensLengthToFOV (double lensLength)

static double	lensLengthFromFOV (double fovAngle)

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

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Protected Member Functions
void	getUnrotatedFieldSize (double &fieldWidth, double &fieldHeight) const

void	getClippingPlanes (double &nearClipPlaneDist, double &farClipPlaneDist, OdGsOverlayId overlayId, OdUInt32 projectionFlags) const

OdGeMatrix3d	projectionMatrix (double nearClipPlaneDist, double farClipPlaneDist, OdUInt32 projectionFlags) const

OdGeMatrix3d	eyeToScreenMatrix (double nearClipPlaneDist, double farClipPlaneDist, OdGsOverlayId overlayId) const

OdGeMatrix3d	screenMatrix (double nearClipPlaneDist, double farClipPlaneDist) const

virtual bool	sceneDept (double &zNear, double &zFar, OdGsOverlayId nOverlay) const

virtual bool	sceneDept (double &zNear, double &zFar) const

virtual bool	usesDept (double pMinDeptSupported=0, double pMaxDeptSupported=0) const

void	onWorldToEyeChanged ()

void	onFinalRelease ()

virtual void	updateViewProps (bool bFullUpdate=true)

bool	isCheckValid () const

void	setCheckValid (bool bValue) const

bool	isInvalid () const

void	setInvalid (bool bValue) const

void	setPerspectiveEnabled (bool bValue) const

void	setAccumulateVpChanges (bool bSet)

OdGiDrawablePtr	drawableAt (DrawableHolder &drawableHolder)

OdGsNode *	getRootNode (DrawableHolder &holder)

virtual void	propagateInvalidVpFlag ()

virtual void	propagateLayersChanges ()

Protected Attributes
OdDbStubPtrArray	m_lastFrozenLayers

OdGsBaseModulePtr	m_pModule

OdDbStubPtrArray	m_frozenLayersDiff

OdUInt32	m_gsViewImplFlags

ODCOLORREF	m_borderColor

int	m_borderWeight

double	m_frontClipDist

double	m_backClipDist

bool	m_screenInvertedX

bool	m_screenInvertedY

OdGePoint2d	m_dcScreenMin

OdGePoint2d	m_dcScreenMax

OdGePoint2d	m_dcLowerLeft

OdGePoint2d	m_dcUpperRight

double	m_fieldWidth

double	m_fieldHeight

double	m_lensLength

double	m_eyeVecLength

OdGePoint3d	m_position

OdGePoint3d	m_target

OdGeVector3d	m_upVector

OdGeVector3d	m_eyeVector

OdGeVector3d	m_xVector

OdGePoint2d	m_center

OdGeMatrix3d	m_eyeToWorld

OdGeMatrix3d	m_worldToEye

OdIntArray	m_nrcCounts

OdGePoint2dArray	m_nrcPoints

double	m_linetypeScaleMultiplier

double	m_linetypeAlternateScaleMultiplier

double	m_lineweightToDcScale

OdUInt8Array	m_lweights

OdUInt16Array	m_lweights2x

OdGsCullingVolumePtr	m_pCullingVolume

OdSharedPtr< OdGiClipBoundaryWithAbstractData >	m_p3dClip

OdSiShapeConstPtrArray	m_clippingShapes

double	m_deviation [5]

int	m_nCachedDrawables

OdMutexPtr	m_mtExtents

OdGsPropertiesPtr	m_pProperties

OdDbStub *	m_pBackgroundId

OdDbStub *	m_pVisualStyleId

OdGiDrawablePtr	m_pViewportTrans

DefaultLightingType	m_defaultLightingType

OdUInt32	m_antiAliasingMode

GsViewOverlayDataContainer	m_overlayData

OdGsBaseVectorizeDevice *	m_pDevice

OdGsClientViewInfo	m_viewInfo

OdUInt32	m_giViewportId

OdGsViewLocalId	m_localId

OdGiRegenType	m_regenerationType

OdRxObjectPtr	m_pGsReserved

RenderMode	m_renderMode

DrawableHolderArray	m_drawables

OdDbStubPtrArray	m_frozenLayers

bool	m_bInInteractivityMode

double	m_dInteractivityFrameRate

Friends
class	GsViewImplHelper

class	OdGiBaseVectorizerImpl

class	OdGsBaseVectorizer

class	OdGsBaseModule

class	OdGsBaseVectorizeDevice

Detailed Description

This class implements Viewport objects in GUI display windows.

Corresponding C++ library: Gs

Definition at line 63 of file GsViewImpl.h.

Member Enumeration Documentation

◆ ProjectionMatrixFlags

enum OdGsViewImpl::ProjectionMatrixFlags

Defines which components of a projection matrix are calculated.

Enumerator
kProjectionIncludeDept
kProjectionIncludeClip
kProjectionIncludePerspective
kProjectionIncludeRotation
kProjectionIncludeAll
kProjectionIncludeAllNoDept

Definition at line 1378 of file GsViewImpl.h.

Constructor & Destructor Documentation

◆ OdGsViewImpl()

OdGsViewImpl::OdGsViewImpl ( )

Default constructor for the OdGsViewImpl class. Sets the following data members:

member Value Description m_gsViewImplFlags kDefaultLightingEnabled View implementation specific flags m_pDevice 0 Owning device m_borderColor ODRGB(0,0,0) View border color m_borderWeight 0 View border width m_frontClipDist 1.0 Front clipping distance m_backClipDist 0.0 Back clipping distance m_position OdGePoint3d::kOrigin - OdGeVector3d::kZAxis Camera position m_target OdGePoint3d::kOrigin Camera target m_upVector OdGeVector3d::kYAxis Camera "up" vector m_dcUpperRight 1.0,1.0 Upper right corner of window in device coordinates m_dcScreenMax 1.0,1.0 Maximum screen dimensions in device coordinates m_screenInvertedX false Screen inverted by x axis m_screenInvertedY true Screen inverted by x axis m_fieldWidth 1.0 Camera field width m_fieldHeight 1.0 Camera field height m_lensLength 50. Camera lens length m_eyeVecLength 1. Camera eye vector length m_linetypeScaleMultiplier 1.0 Linetype scale multiplier m_linetypeAlternateScaleMultiplier 1.0 Alternative linetype scale multiplier m_lineweightToDcScale 1.0 Lineweight scale relative to device coordinates m_nCachedDrawables 0 Number of cached drawables m_pBackgroundId NULL Identifier of a view background m_pVisualStyleId NULL Identifier of a visual style m_defaultLightingType OdGsView::kTwoLights Default lighting type m_regenerationType kOdGiStandardDisplay Regeneration type m_renderMode k2DOptimized Render mode m_xVector OdGeVector3d::kXAxis Vector that defines x axis. m_eyeVector OdGeVector3d::kZAxis Camera eye vector m_bInInteractivityMode false Flag whether to use interactivity mode m_dInteractivityFrameRate 1.0 Frame rate for the interactivity mode

This constructor also sets this view as invalid and sets clear color to kPaletteBackground.

◆ ~OdGsViewImpl()

OdGsViewImpl::~OdGsViewImpl ( )

Destructor for the OdGsViewImpl class. Calls onFinalRelease(), eraseAll() and frees device slot manager slot from viewport id, if necessary.

Member Function Documentation

◆ actualFieldHeight()

double OdGsViewImpl::actualFieldHeight ( ) const

inline

Returns actual field height variable (without considering aspect ratio).

Definition at line 2474 of file GsViewImpl.h.

◆ actualFieldWidth()

double OdGsViewImpl::actualFieldWidth ( ) const

inline

Returns actual field width variable (without considering aspect ratio).

Definition at line 2469 of file GsViewImpl.h.

◆ add()

virtual bool OdGsViewImpl::add	(	OdGiDrawable *	sceneGraph,
		OdGsModel *	model )

virtual

Adds the specified scene graph to this Viewport object.

Parameters

pSceneGraph	[in] Pointer to the root of the scene graph.
pModel	[in] Pointer to the Model object to which all scene graph notifications are to be directed.

Remarks: This function is intended to be used as follows:

Construct a scene graph of OdGiDrawable objects. Each object draws its children with OdGiGeometry::draw().
With this function, add the root of the scene graph and the OdGsModel that handles notifications to this Viewport object.

Implements OdGsView.

◆ addClippingShape()

void OdGsViewImpl::addClippingShape ( const OdSiShape * p )

inline

Adds a clipping shape to the array of clipping shapes.

Parameters

pClippingShape [in] Pointer to the clipping shape to add.

Definition at line 2479 of file GsViewImpl.h.

◆ annotationScaleId()

OdDbStub * OdGsViewImpl::annotationScaleId ( ) const

Retrieves the Object ID of the annotation scale object associated with this view.

◆ antiAliasingMode()

OdUInt32 OdGsViewImpl::antiAliasingMode ( ) const

inlinevirtual

Returns anti-aliasing mode for current Viewport object.

Implements OdGsView.

Definition at line 2344 of file GsViewImpl.h.

◆ backClip()

virtual double OdGsViewImpl::backClip ( ) const

virtual

Returns the back clip distance from the target of this Viewport object.

Implements OdGsView.

◆ background()

virtual OdDbStub * OdGsViewImpl::background ( ) const

virtual

Returns current background object ID for this view.

See also: <link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Implements OdGsView.

◆ baseDevice() [1/2]

OdGsBaseVectorizeDevice * OdGsViewImpl::baseDevice ( )

inline

Returns the OdGsBaseVectorizeDevice associated with this Viewport object.

Definition at line 1142 of file GsViewImpl.h.

◆ baseDevice() [2/2]

const OdGsBaseVectorizeDevice * OdGsViewImpl::baseDevice ( ) const

inline

Returns the OdGsBaseVectorizeDevice associated with this Viewport object.

Definition at line 1147 of file GsViewImpl.h.

◆ beginInteractivity()

virtual void OdGsViewImpl::beginInteractivity ( double frameRateInHz )

virtual

Puts this Viewport object into interactive state.

Parameters

frameRateInHz [in] Frames/second.

Remarks: A frame rate of 0.0 specifies the default frame rate.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implements OdGsView.

◆ cachedDrawables()

int OdGsViewImpl::cachedDrawables ( ) const

inline

Returns the number of cached drawables for this view object.

Definition at line 1526 of file GsViewImpl.h.

◆ calcDeviation()

double OdGsViewImpl::calcDeviation	(	const OdGiDeviationType	type,
		const OdGePoint3d &	pt ) const

Calculates and returns recommended maximum deviation of the current vectorization for the specified deviation type.

Parameters

deviationType	[in] Deviation type.
pointOnCurve	[in] Point on curve. Used only if 'bRecalculate' is true.

Remarks: deviationType must be one of the following:

Value kOdGiMaxDevForCircle 0
kOdGiMaxDevForCurve 1
kOdGiMaxDevForBoundary 2
kOdGiMaxDevForIsoline 3 kOdGiMaxDevForFacet 4

◆ center()

const OdGePoint2d & OdGsViewImpl::center ( ) const

◆ clearColor()

ClearColor OdGsViewImpl::clearColor ( ) const

Retrieves the clear color of this view.

◆ clearFrozenLayers()

virtual void OdGsViewImpl::clearFrozenLayers ( )

virtual

Thaws all Layer objects in this Viewport object.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implements OdGsView.

◆ clearLinetypeCache()

virtual void OdGsViewImpl::clearLinetypeCache ( )

pure virtual

Clears linetype cache.

Implemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >, and OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >.

◆ clientViewInfo()

virtual void OdGsViewImpl::clientViewInfo ( OdGsClientViewInfo & viewInfo ) const

virtual

Returns the ClientViewInfo for this Viewport object.

Parameters

clientViewInfo [out] Receives the ClientViewInfo.

Reimplemented from OdGsView.

◆ clippingShapes()

const OdSiShapeConstPtrArray & OdGsViewImpl::clippingShapes ( ) const

inline

Retrieves the array of pointers to clipping shapes.

Definition at line 2492 of file GsViewImpl.h.

◆ cloneView()

virtual OdGsViewPtr OdGsViewImpl::cloneView	(	bool	cloneViewParameters = true,
		bool	cloneGeometry = false )

virtual

Clones this view object.

Parameters

cloneViewParameters	[in] If this flag is set, view parameters will be cloned.
cloneGeometry	[in] If this flag is set, geometry will be cloned.

Returns: Returns a SmartPointer to the newly created object.

Implements OdGsView.

◆ contextualColors()

const OdGiContextualColors * OdGsViewImpl::contextualColors ( ) const

inline

Returns pointer to context-dependent colors storage.

Remarks: This pointer could be null if contextual colors doesn't specified by context.

Definition at line 2272 of file GsViewImpl.h.

◆ cullingVolume()

OdGsCullingVolumePtr OdGsViewImpl::cullingVolume ( ) const

Returns culling volume associated with current view.

See also: initCullingVolume setCullingVolume

◆ cullingVolumeIntersectWith()

virtual OdGsCullingVolume::IntersectionStatus OdGsViewImpl::cullingVolumeIntersectWith ( const OdGsCullingPrimitive & prim ) const

virtual

Complete intersection test between culling volume associated with current view and culling primitive.

Returns: Returns kIntersectIn intersection status if culling volume is not initialized.

Remarks

Return value intersection statuses:

Value Description kIntersectNot 0 No intersection detected. kIntersectOk 1 Intersects with culling volume boundary. kIntersectIn 2 Culling volume primitive is completely inside culling volume boundary.

Parameters

prim	[in] Input primitive for culling detection.

See also: isCullingVolumeInitialized cullingVolumeIntersectWithOpt

◆ cullingVolumeIntersectWithOpt()

virtual bool OdGsViewImpl::cullingVolumeIntersectWithOpt ( const OdGsCullingPrimitive & prim ) const

virtual

Optimized intersection test between culling volume associated with current view and culling primitive.

Returns: Returns true if culling volume is not initialized.

Parameters

prim	[in] Input primitive for culling detection.

See also: isCullingVolumeInitialized cullingVolumeIntersectWith

◆ cullingVolumeTransformBy()

virtual void OdGsViewImpl::cullingVolumeTransformBy ( const OdGeMatrix3d & xfm )

virtual

Applies transformation for culling volume associated with current view.

Parameters

xfm	[in] Transformation matrix.

See also: initCullingVolume

◆ dcLowerLeft()

const OdGePoint2d & OdGsViewImpl::dcLowerLeft ( ) const

inline

Retrieves lower left point of this viewport in device coordinates.

Definition at line 1664 of file GsViewImpl.h.

◆ dcScreenMax()

const OdGePoint2d & OdGsViewImpl::dcScreenMax ( ) const

inline

Retrieves screen minimum point in device coordinates.

Definition at line 1659 of file GsViewImpl.h.

◆ dcScreenMin()

const OdGePoint2d & OdGsViewImpl::dcScreenMin ( ) const

inline

Retrieves screen minimum point in device coordinates.

Definition at line 1654 of file GsViewImpl.h.

◆ dcUpperRight()

const OdGePoint2d & OdGsViewImpl::dcUpperRight ( ) const

inline

Retrieves upper right point of this viewport in device coordinates.

Definition at line 1669 of file GsViewImpl.h.

◆ defaultLightingEnabled()

bool OdGsViewImpl::defaultLightingEnabled ( ) const

inline

Checks whether default lighting is enabled.

Returns: true if default lighting is enabled, false otherwise.

See also: <link tv_working_with_lights, Work with Lights>

Definition at line 2325 of file GsViewImpl.h.

◆ defaultLightingType()

OdGsView::DefaultLightingType OdGsViewImpl::defaultLightingType ( ) const

inline

Returns default lighting type which can be one of the following:

Value Description kOneLight 0 Single front light. kTwoLights 1 Front and back lights. kBackLight 2 Single back light.

See also: <link tv_working_with_lights, Work with Lights>

Definition at line 2330 of file GsViewImpl.h.

◆ device()

virtual OdGsDevice * OdGsViewImpl::device ( ) const

virtual

Returns the GsDevice object associated with this Viewport object.

See also: <link tv_working_with_base_classes_device, Work with Visualize Graphics Devices>

Implements OdGsView.

◆ doInversePerspectivePt()

bool OdGsViewImpl::doInversePerspectivePt ( OdGePoint3d & point ) const

Applies the inverse of the current perspective transformation to the specified point.

Parameters

point [in/out] Any 3D point.

Remarks: The point is transformed from normalized device coordinates to EyeSpace coordinates

Returns: true the point was transformed; i.e., a perspective transform is active, and the point was neither too close or behind the camera.

◆ dolly() [1/2]

virtual void OdGsViewImpl::dolly ( const OdGeVector3d & dollyVector )

virtual

Translates the camera position and target by the specified Camera Coordinate dolly amount.

Parameters

dollyVector [in] Camera Coordinate dolly vector.

Remarks: Camera Coordinates are relative to the view of a target from a camera. The Y-axis is along up vector. The Z-axis is along the vector from camera position to the target. The X-axis is the cross product Y-axis x Z-axis

Implements OdGsView.

◆ dolly() [2/2]

virtual void OdGsViewImpl::dolly	(	double	xDolly,
		double	yDolly,
		double	zDolly )

virtual

Translates the camera position and target by the specified Camera Coordinate dolly amount.

Parameters

xDolly	[in] Camera Coordinate X dolly amount.
yDolly	[in] Camera Coordinate Y dolly amount.
zDolly	[in] Camera Coordinate Z dolly amount.

Remarks: Camera Coordinates are relative to the view of a target from a camera.
The Y-axis is along up vector. The Z-axis is along the vector from camera position to the target. The X-axis is the cross product Y-axis x Z-axis

Implements OdGsView.

◆ doPerspectivePt()

bool OdGsViewImpl::doPerspectivePt ( OdGePoint3d & point ) const

Applies the current perspective transformation to the specified point.

Parameters

point [in/out] Any 3D point.

Remarks: The point is transformed from EyeSpace coordinates to normalized device coordinates.

Returns: true if the point was transformed; i.e., a perspective transform is active, and the point was neither too close or behind the camera.

◆ drawableAt()

OdGiDrawablePtr OdGsViewImpl::drawableAt ( DrawableHolder & drawableHolder )

protected

Returns the OdGiDrawable associated with the specified DrawableHolder object.

Parameters

drawableHolder [in] Drawable holder.

◆ drawablesFilterFunction()

OdIntPtr OdGsViewImpl::drawablesFilterFunction ( ) const

Retrieves internal drawable filtration function ID.

◆ enableAntiAliasing()

void OdGsViewImpl::enableAntiAliasing ( OdUInt32 nMode )

inlinevirtual

Enable or disable anti-aliasing in current Viewport object.

Parameters

nLevel [in] Anti-aliasing mode (set as 3 by default). Set as 0 to disable anti-aliasing.

Implements OdGsView.

Definition at line 2335 of file GsViewImpl.h.

◆ enableDefaultLighting()

virtual void OdGsViewImpl::enableDefaultLighting	(	bool	bEnable,
		DefaultLightingType	lightType = kTwoLights )

virtual

Enables default lighting for this view.

Parameters

bEnable	[in] New default lighting state.
lightType	[in] New default lighting type.

See also: <link tv_working_with_lights, Work with Lights>

Implements OdGsView.

◆ enableSSAO()

void OdGsViewImpl::enableSSAO ( bool bEnable )

inlinevirtual

Enables or disables ambient occlusion in current Viewport object.

Parameters

bEnable [in] Ambient occlusion mode (set as true by default). Set as false to disable ambient occlusion.

Implements OdGsView.

Definition at line 2349 of file GsViewImpl.h.

◆ enableStereo()

virtual void OdGsViewImpl::enableStereo ( bool enabled )

virtual

Controls stereo viewing for this Viewport object.

Parameters

enable [in] Controls stereo viewing.

Implements OdGsView.

◆ endInteractivity()

virtual void OdGsViewImpl::endInteractivity ( )

virtual

Removes this Viewport object from the interactive state.

Parameters

frameRateInHz [in] Frames/second.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implements OdGsView.

◆ erase()

virtual bool OdGsViewImpl::erase ( OdGiDrawable * sceneGraph )

virtual

Removes the specified scene graph from this Viewport object.

Parameters

sceneGraph [in] Pointer to the root of the scene graph.

Implements OdGsView.

◆ eraseAll()

virtual void OdGsViewImpl::eraseAll ( )

virtual

Removes all scene graphs from this Viewport object.

Parameters

sceneGraph [in] Root of scene graph.

Implements OdGsView.

◆ exceededBounds()

virtual bool OdGsViewImpl::exceededBounds ( )

virtual

Checks whether view parameters have exceeded their boundaries since the last call to this function.

Returns: true if any view parameters have exceeded their boundaries since the last call to this function, false otherwise.

Remarks: The following calls are monitored:

dolly() orbit() pan() roll() setBackClip() setFrontClip() setView() zoom()

Implements OdGsView.

◆ extentsInView()

virtual bool OdGsViewImpl::extentsInView	(	const OdGePoint3d &	minPt,
		const OdGePoint3d &	maxPt ) const

virtual

Returns true if and only if specified WCS box is visible completely or partially inside current view frustum.

Parameters

minPt	[in] minimal WCS box point.
maxPt	[in] maximal WCS box point.

Implements OdGsView.

◆ extentsToPixels()

OdGsOverlayId OdGsViewImpl::extentsToPixels	(	OdGsDCRect &	rc,
		const OdGeExtents3d &	worldExt,
		const OdGsBaseModel *	pModel,
		OdDb::LineWeight	extendByLineweight = OdDb::kLnWt000 ) const

◆ eyeToScreenMatrix() [1/2]

OdGeMatrix3d OdGsViewImpl::eyeToScreenMatrix	(	double	nearClipPlaneDist,
		double	farClipPlaneDist,
		OdGsOverlayId	overlayId ) const

protected

◆ eyeToScreenMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::eyeToScreenMatrix ( OdGsOverlayId nOverlay = kGsMainOverlay ) const

Returns the transformation matrix from EyeSpace to ScreenSpace for this Viewport object.

Parameters

nOverlay [in] Graphics system overlay index.

See also: <link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ eyeToWorldMatrix()

const OdGeMatrix3d & OdGsViewImpl::eyeToWorldMatrix ( ) const

inline

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

Definition at line 2379 of file GsViewImpl.h.

◆ eyeVector()

const OdGeVector3d & OdGsViewImpl::eyeVector ( ) const

inline

Retrieves eye vector of the camera. Eye vector is the vector from camera position to the target.

Definition at line 1467 of file GsViewImpl.h.

◆ fieldHeight()

virtual double OdGsViewImpl::fieldHeight ( ) const

virtual

Returns the WCS projection plane (field) height for this Viewport object.

Implements OdGsView.

◆ fieldWidth()

virtual double OdGsViewImpl::fieldWidth ( ) const

virtual

Returns the WCS projection plane (field) width for this Viewport object.

Implements OdGsView.

◆ flush()

virtual void OdGsViewImpl::flush ( )

virtual

Flushes the graphic pipeline and renders this Viewport object.

Remarks: This function should be called only during interactivty.

Implements OdGsView.

◆ focalLength()

double OdGsViewImpl::focalLength ( ) const

Returns the WCS (ECS) focal length of the lens for this view object.

◆ focusPoint()

OdGePoint3d OdGsViewImpl::focusPoint ( ) const

Returns focus point of the camera.

◆ freezeLayer()

virtual void OdGsViewImpl::freezeLayer ( OdDbStub * layerID )

virtual

Freezes the specified Layer object in this Viewport object.

Parameters

layerID [in] Layer to freeze.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implements OdGsView.

◆ frontClip()

virtual double OdGsViewImpl::frontClip ( ) const

virtual

Returns the front clip distance from the target of this Viewport object.

Implements OdGsView.

◆ frozenLayers() [1/2]

OdUInt32 OdGsViewImpl::frozenLayers ( ) const

inline

Returns count of frozen layers in this view.

Definition at line 1235 of file GsViewImpl.h.

◆ frozenLayers() [2/2]

void OdGsViewImpl::frozenLayers ( OdDbStubPtrArray & frozenLayers ) const

inline

Returns the frozen layers for this view object.

Parameters

frozenLayers [out] Receives an array of frozen layer Object IDs.

Remarks: If called without the frozenLayers argument, returns true if and only if there are any frozen layers.

Definition at line 1246 of file GsViewImpl.h.

◆ getClippingPlanes()

void OdGsViewImpl::getClippingPlanes	(	double &	nearClipPlaneDist,
		double &	farClipPlaneDist,
		OdGsOverlayId	overlayId,
		OdUInt32	projectionFlags ) const

protected

◆ getDeviation()

virtual double OdGsViewImpl::getDeviation	(	const OdGiDeviationType	deviationType,
		const OdGePoint3d &	pointOnCurve,
		bool	bRecalculate = false ) const

virtual

Retrieves the recommended maximum deviation of the current vectorization for the specified deviation type.

Parameters

deviationType	[in] Deviation type.
pointOnCurve	[in] Point on curve. Used only if 'bRecalculate' is true.
bRecalculate	[in] Flag that specifies whether to recalculate deviation value with the provided point on curve.

Remarks: deviationType must be one of the following:

Value kOdGiMaxDevForCircle 0
kOdGiMaxDevForCurve 1
kOdGiMaxDevForBoundary 2
kOdGiMaxDevForIsoline 3 kOdGiMaxDevForFacet 4

Reimplemented in CFxRVTMaterialView.

◆ getFrozenLayersDiff()

virtual const OdDbStubPtrArray & OdGsViewImpl::getFrozenLayersDiff ( ) const

virtual

Returns array of calculated during propagateLayersChanges() call frozen layer differences.

◆ getGsModulePtr()

const OdGsBaseModule * OdGsViewImpl::getGsModulePtr ( ) const

inline

Retrieves pointer to the associated GS module.

Definition at line 2267 of file GsViewImpl.h.

◆ getLinetypeGenerationCriteria()

double OdGsViewImpl::getLinetypeGenerationCriteria ( ) const

Returns the WCS value below which linetype generation is not used.

Remarks: If the WCS length an entire linetype pattern is less than the returned value, then the linetype will be rendered as continuous.

◆ getLinetypeScaleMultiplier()

double OdGsViewImpl::getLinetypeScaleMultiplier ( ) const

Retrieves a multiplier that is used to scale all linetypes in this Viewport object.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

◆ getLweight()

OdUInt32 OdGsViewImpl::getLweight ( int nLineweight ) const

inline

Returns lineweight from lineweights array.

Returns: Lineweight.

Definition at line 1639 of file GsViewImpl.h.

◆ getLweightsEnum()

const OdUInt8Array & OdGsViewImpl::getLweightsEnum ( ) const

inline

Retrieves an array of lineweights.

Definition at line 1644 of file GsViewImpl.h.

◆ getLweightsEnum2()

const OdUInt16Array & OdGsViewImpl::getLweightsEnum2 ( ) const

inline

Retrieves an array of lineweights in alternative format.

Definition at line 1649 of file GsViewImpl.h.

◆ getModel()

virtual OdGsModel * OdGsViewImpl::getModel ( const OdGiDrawable * pDrawable ) const

virtual

Returns OdGsModel object associated with specified OdGiDrawable object in this Viewport object.

Parameters

pDrawable [in] Pointer onto OdGiDrawable object.

Implements OdGsView.

◆ getModelList()

virtual OdGsModelArray OdGsViewImpl::getModelList ( ) const

virtual

Returns array of OdGsModel objects associated with this Viewport object.

Implements OdGsView.

◆ getNumPixelsInUnitSquare()

virtual void OdGsViewImpl::getNumPixelsInUnitSquare	(	const OdGePoint3d &	givenWorldpt,
		OdGePoint2d &	pixelArea,
		bool	includePerspective = true ) const

virtual

Returns the display pixel density at the specified point for this Viewport object.

Parameters

givenWorldpt	[in] WCS center of the unit square.
pixelArea	[out] Receives the pixel density.
includePerspective	[in] Enable perspective inclusion into pixel density calculation.

Remarks: Pixel density is measured in pixels per WCS unit. This function can be used to determine if the geometry generated for an object will be smaller than the size of a pixel.

Implements OdGsView.

◆ getRegenType()

virtual OdGiRegenType OdGsViewImpl::getRegenType ( ) const

inlinevirtual

Retrieves regeneration type of this view.

Definition at line 1457 of file GsViewImpl.h.

◆ getRootNode()

OdGsNode * OdGsViewImpl::getRootNode ( DrawableHolder & holder )

protected

◆ getSnapShot()

virtual void OdGsViewImpl::getSnapShot	(	OdGiRasterImagePtr &	pImage,
		const OdGsDCRect &	region )

virtual

Returns image of current view buffer.

Parameters

pImage	[out] Pointer for image to return.
region	[in] Rectangle specifies region to return.

Remarks: Implementation can throw eNotImplementedYet exception if current vectorization module doesn't support snap shots.

Implements OdGsView.

◆ getStereoParameters()

virtual void OdGsViewImpl::getStereoParameters	(	double &	magnitude,
		double &	parallax ) const

virtual

Returns the stereo parameters for this Viewport Object.

Parameters

magnitude	[out] Receives the view separation [0.0 .. 2.0].
parallax	[out] Receives the plane of zero parallax adjustment [0.0 .. 2.0].

Remarks: magnitude controls view eye separation, and hence the stereo effect. A magnitude of 1.0 is the default value. A magnitude of 0.0 produces no stereo effect. A magnitude of 2.0 produces a double stereo effect. parallax adjusts the zero parallax plane. A parallax of 1.0 is the default value. An object centered at the target will be half-in and half-out of the screen. A parallax of 0.0 moves the object into the screen. A parallax of 2.0 move the object out of the screen.

Implements OdGsView.

◆ getUnrotatedFieldSize()

void OdGsViewImpl::getUnrotatedFieldSize	(	double &	fieldWidth,
		double &	fieldHeight ) const

protected

◆ getUpVector()

const OdGeVector3d & OdGsViewImpl::getUpVector ( ) const

inline

Retrieves up vector of the camera (y-axis). Up vector defines which orientation is "upward" for camera.

Definition at line 1477 of file GsViewImpl.h.

◆ getViewLocalId()

OdGsViewLocalId & OdGsViewImpl::getViewLocalId ( )

inline

Definition at line 1539 of file GsViewImpl.h.

◆ getViewport() [1/3]

virtual void OdGsViewImpl::getViewport	(	OdGePoint2d &	lowerLeft,
		OdGePoint2d &	upperRight ) const

virtual

Returns the size and position of this Viewport object.

Parameters

lowerLeft	[out] Receives the lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[out] Receives the upper-right corner in nomalized device coordinates [0.0 .. 1.0].
screenRect	[out] Receives the screen rectangle in device coordinates (pixels).

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right.; The View object may be partly or completely off screen.

Implements OdGsView.

◆ getViewport() [2/3]

virtual void OdGsViewImpl::getViewport ( OdGsDCRect & screenRect ) const

virtual

Returns the size and position of this Viewport object.

Parameters

lowerLeft	[out] Receives the lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[out] Receives the upper-right corner in nomalized device coordinates [0.0 .. 1.0].
screenRect	[out] Receives the screen rectangle in device coordinates (pixels).

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right.; The View object may be partly or completely off screen.

Implements OdGsView.

◆ getViewport() [3/3]

virtual void OdGsViewImpl::getViewport ( OdGsDCRectDouble & screenRec ) const

virtual

Returns the size and position of this Viewport object.

Parameters

screenRect [out] Receives the screen rectangle in device coordinates (pixels).

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right. The View object may be partly or completely off screen.

Reimplemented from OdGsView.

◆ getViewportBorderProperties()

virtual void OdGsViewImpl::getViewportBorderProperties	(	ODCOLORREF &	color,
		int &	width ) const

virtual

Returns the color and width of the border for this Viewport object.

Parameters

color	[out] Receives the border color.
width	[out] Receives the border width in pixels.

Implements OdGsView.

◆ getViewportObjectId()

OdDbStub * OdGsViewImpl::getViewportObjectId ( ) const

inline

Returns the Object ID of the OdDbViewport object associated with this object.

Definition at line 1137 of file GsViewImpl.h.

◆ getViewportPropertiesForType()

OdGsPropertiesPtr OdGsViewImpl::getViewportPropertiesForType ( OdGsProperties::PropertiesType type ) const

Retrieves viewport properties by the specified property type.

Parameters

type	[in] Property type to get.

◆ getViewportPropertiesRoot()

OdGsPropertiesPtr OdGsViewImpl::getViewportPropertiesRoot ( ) const

Retrieves viewport properties.

◆ hasLweights()

bool OdGsViewImpl::hasLweights ( ) const

inline

Checks whether this object has lineweights.

Returns: true if an array of lineweights is not empty, false otherwise.

Definition at line 1625 of file GsViewImpl.h.

◆ hasViewport3dClipping()

bool OdGsViewImpl::hasViewport3dClipping ( ) const

inline

Returns true if and only if 3d clipping set for this Viewport object.

Definition at line 2464 of file GsViewImpl.h.

◆ hide()

virtual void OdGsViewImpl::hide ( )

virtual

Hides this Viewport object.

Implements OdGsView.

◆ includeFrozenLayersVisibilityInViewExtents()

void OdGsViewImpl::includeFrozenLayersVisibilityInViewExtents ( bool bEnable )

inline

Enables including of view object frozen layers visibility in view extents.

Parameters

bEnable [in] Enables or disables frozen layers visibility inclusion.

Definition at line 2288 of file GsViewImpl.h.

◆ init()

virtual void OdGsViewImpl::init	(	OdGsBaseVectorizeDevice *	pDevice,
		const OdGsClientViewInfo *	pViewInfo = 0,
		bool	enableLayerVisibilityPerView = false )

virtual

Initializes this Viewport object.

Parameters

pDevice	[in] Pointer to the OdGsBaseVectorizeDevice associated with this Viewport object.
pViewInfo	[in] Pointer to the Client View Information for this Viewport object.
enableLayerVisibilityPerView	[in] Layer visibility per viewport is supported, if and only if true.

◆ initCullingVolume()

virtual void OdGsViewImpl::initCullingVolume ( )

virtual

Initialize culling volume, associated with current view.

Remarks: Default implementation initializes culling volume for overall view, and transforms overall view culling volume for all viewports inside overall view space (only if viewports has orthogonal projection). This method can be overrided into user device for adjust described behaviour. If this method overrided as empty function (not create culling volume inside) - all culling functionality will be disabled.

See also: isCullingVolumeInitialized cullingVolumeIntersectWithOpt cullingVolumeIntersectWith

◆ initDeviation()

void OdGsViewImpl::initDeviation ( )

Starts calculation of initial deviation values for all deviation types.

◆ initLights()

virtual void OdGsViewImpl::initLights ( OdRxIterator * pLightsIterator )

virtual

Returns an iterator to traverse the lights attached to this Viewport object.

Parameters

pLightsIterator [in] Pointer to the lights iterator.

Implements OdGsView.

◆ interactivityFrameRate()

virtual double OdGsViewImpl::interactivityFrameRate ( ) const

virtual

Returns interactivity frame rate.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implements OdGsView.

◆ invalidate() [1/4]

virtual void OdGsViewImpl::invalidate ( )

virtual

Marks the entire area of this View for refreshing.

Implements OdGsView.

◆ invalidate() [2/4]

virtual void OdGsViewImpl::invalidate	(	const OdGeExtents3d &	worldExt,
		const OdGsBaseModel *	pModel,
		OdDb::LineWeight	extendByLineweight = OdDb::kLnWt000 )

virtual

◆ invalidate() [3/4]

virtual void OdGsViewImpl::invalidate ( const OdGsDCRect & rect )

virtual

Marks for refresh the specified region of this Viewport object.

Parameters

rect	[in] Screen rectangle in device coordinates (pixels).

Implements OdGsView.

◆ invalidate() [4/4]

void OdGsViewImpl::invalidate	(	const OdGsUpdateExtents &	extents,
		const OdGsBaseModel *	pModel )

inline

Marks a part of area (represented by provided extents) of this view as invalid.

Parameters

extents	[in] Part of view for invalidation.
pModel	[in] Pointer to a model.

Definition at line 2374 of file GsViewImpl.h.

◆ invalidateCachedViewportGeometry() [1/2]

virtual void OdGsViewImpl::invalidateCachedViewportGeometry ( )

virtual

Marks for regeneration all subViewportDraw() geometry for this Viewport object.

Implements OdGsView.

◆ invalidateCachedViewportGeometry() [2/2]

void OdGsViewImpl::invalidateCachedViewportGeometry ( OdUInt32 mask )

Marks subViewportDraw geometry for regeneration.

Parameters

mask	[in] Mask.

◆ invalidateRegion()

void OdGsViewImpl::invalidateRegion ( const OdGiPathNode & path )

Marks a part of area (represented by provided path node) of this view as invalid.

Parameters

path	[in] Path node for invalidation.

◆ invalidRects()

OdGsDCRectArray OdGsViewImpl::invalidRects ( OdGsOverlayId nOverlay = kGsMainOverlay ) const

◆ isAccumulateVpChanges()

bool OdGsViewImpl::isAccumulateVpChanges ( ) const

inline

Definition at line 2429 of file GsViewImpl.h.

◆ isBackClipped()

virtual bool OdGsViewImpl::isBackClipped ( ) const

virtual

Checks whether back clipping is enabled for this Viewport object.

Returns: true if back clipping is enabled for this Viewport object, false otherwise.

Implements OdGsView.

◆ isCheckValid()

bool OdGsViewImpl::isCheckValid ( ) const

inlineprotected

Definition at line 2298 of file GsViewImpl.h.

◆ isCompletelyVisible()

bool OdGsViewImpl::isCompletelyVisible ( ) const

inline

Definition at line 2439 of file GsViewImpl.h.

◆ isCullingVolumeInitialized()

virtual bool OdGsViewImpl::isCullingVolumeInitialized ( ) const

virtual

Checks whether culling volume associated with current view is initialized.

Returns: true if culling volume associated with current view is initialized, false otherwise.

Remarks: Culling volume consider associated with current view if pointer to culling volume is not null.

See also: initCullingVolume setCullingVolume cullingVolume

◆ isDependentGeometryView()

bool OdGsViewImpl::isDependentGeometryView ( ) const

inline

Definition at line 2257 of file GsViewImpl.h.

◆ isDependentViewportView()

bool OdGsViewImpl::isDependentViewportView ( ) const

inline

Definition at line 2252 of file GsViewImpl.h.

◆ isFrontClipped()

virtual bool OdGsViewImpl::isFrontClipped ( ) const

virtual

Checks whether front clipping is enabled for this Viewport object.

Returns: true if front clipping is enabled for this Viewport object, false otherwise.

Implements OdGsView.

◆ isFrozenLayersVisibilityIncludedInViewExtents()

bool OdGsViewImpl::isFrozenLayersVisibilityIncludedInViewExtents ( ) const

inline

Returns true if view object frozen layers visibility should be included in view extents.

Returns: true if view object frozen layers should be included in view extents.

Definition at line 2293 of file GsViewImpl.h.

◆ isHelperView()

bool OdGsViewImpl::isHelperView ( ) const

inline

Definition at line 2262 of file GsViewImpl.h.

◆ isInInteractivity()

virtual bool OdGsViewImpl::isInInteractivity ( ) const

virtual

Checks whether this Viewport object is in interactive state.

Returns: true if this View is in interactivity mode, false otherwise.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implements OdGsView.

◆ isInvalid()

bool OdGsViewImpl::isInvalid ( ) const

inlineprotected

Definition at line 2308 of file GsViewImpl.h.

◆ isLayerVisible()

bool OdGsViewImpl::isLayerVisible ( OdDbStub * layerId ) const

Checks whether the specified layer is visibile in this view.

Parameters

layerId [in] Persistent object identifier of a layer.

Returns: true if the specified layer is visibile, false otherwise.

◆ isLegacyHiddenMode()

virtual bool OdGsViewImpl::isLegacyHiddenMode ( ) const

virtual

◆ isLegacyWireframeMode()

virtual bool OdGsViewImpl::isLegacyWireframeMode ( ) const

virtual

◆ isLocalViewportIdCompatible()

virtual bool OdGsViewImpl::isLocalViewportIdCompatible ( const OdGsViewImpl * pView ) const

virtual

◆ isNonRectClipped()

bool OdGsViewImpl::isNonRectClipped ( ) const

inline

Checks whether there is non-rectangular clipping region.

Returns: true if array of points for non-rectangular clipping region is not empty, false otherwise.

Definition at line 2363 of file GsViewImpl.h.

◆ isPerspective()

virtual bool OdGsViewImpl::isPerspective ( ) const

virtual

Returns true if and only if the projection type for this Viewport object is kPerspective.

Implements OdGsView.

◆ isPlotTransparency()

virtual bool OdGsViewImpl::isPlotTransparency ( ) const

virtual

Checks transparency is plotted for this view.

Returns: true if transparency is plotted for this view, false otherwise.

◆ isRegenOnDrawForbidden()

bool OdGsViewImpl::isRegenOnDrawForbidden ( ) const

inline

Definition at line 2419 of file GsViewImpl.h.

◆ isRotated()

bool OdGsViewImpl::isRotated ( ) const

inline

Checks whether viewport is rotated.

Returns: true if viewport rotation is 90 or 270 degrees, false otherwise.

Definition at line 2368 of file GsViewImpl.h.

◆ isShowFrozenLayers()

bool OdGsViewImpl::isShowFrozenLayers ( )

inlinevirtual

If show frozen layers flag is true then kDrawLayerOff|kDrawLayerFrozen flags will be force set before of vectorization.

Returns: true if show frozen layers mode is on, false otherwise.

Definition at line 2449 of file GsViewImpl.h.

◆ isSnapping()

bool OdGsViewImpl::isSnapping ( ) const

inline

Definition at line 2409 of file GsViewImpl.h.

◆ isStereoEnabled()

virtual bool OdGsViewImpl::isStereoEnabled ( ) const

virtual

Checks whether stereo viewing is enabled for this Viewport object.

Returns: true if stereo viewing is enabled for this Viewport object, false otherwise.

Implements OdGsView.

◆ isSupportLegacyHiddenMode()

virtual bool OdGsViewImpl::isSupportLegacyHiddenMode ( ) const

virtual

◆ isSupportLegacyWireframeMode()

virtual bool OdGsViewImpl::isSupportLegacyWireframeMode ( ) const

virtual

◆ isSupportPlotStyles()

bool OdGsViewImpl::isSupportPlotStyles ( ) const

inline

Checks whether this view supports plot styles rendering.

Returns: true if current view supports plot styles rendering, false otherwise.

Definition at line 2283 of file GsViewImpl.h.

◆ isValid()

virtual bool OdGsViewImpl::isValid ( ) const

virtual

Checks whether this Viewport shows the correct image.

Returns: true if this Viewport object is showing the correct image, false otherwise.

Remarks: This implies the following: No part of GUI area is flagged for refresh. All rasterizations are complete The rendering pipeline has been flushed.

Implements OdGsView.

◆ isValidViewportId()

bool OdGsViewImpl::isValidViewportId ( const OdUInt32 vpId ) const

Checks whether the passed viewport identifier is valid.

Parameters

vpId	[in] Viewport ID.

Returns: true if the specified viewport identifier is valid, false otherwise.

◆ isViewportBorderVisible()

virtual bool OdGsViewImpl::isViewportBorderVisible ( ) const

virtual

Checks whether border is visible for this Viewport object.

Returns: true if the border is visible for this Viewport object, false otherwise.

Implements OdGsView.

◆ isViewportOnScreen()

bool OdGsViewImpl::isViewportOnScreen ( ) const

Check whether this viewport is displayed on screen.

Returns: true if this view object is not off-screen.

◆ isViewRegenerated()

virtual bool OdGsViewImpl::isViewRegenerated ( ) const

virtual

Checks whether view is regenerated.

Returns: true if view is regenerated, false otherwise.

◆ isVisible()

virtual bool OdGsViewImpl::isVisible ( )

virtual

Checks whether this Viewport object is visible.

Returns: true if this Viewport object is not hidden, false otherwise.

Implements OdGsView.

◆ lensLength()

virtual double OdGsViewImpl::lensLength ( ) const

virtual

Returns the perspective lens length for this Viewport object.

Implements OdGsView.

◆ lensLengthFromFOV()

static double OdGsViewImpl::lensLengthFromFOV ( double fovAngle )

static

Utility function to recompute field of view angle into lens length.

Parameters

fovAngle [in] Field of view angle in radians.

Returns: Returns lens length in millimeters.

Remarks: Input angle must be in range between 4 and 179 degrees inclusively.

◆ lensLengthToFOV()

static double OdGsViewImpl::lensLengthToFOV ( double lensLength )

static

Utility function to recompute lens length into field of view angle.

Parameters

lensLength [in] Lens length in millimeters.

Returns: Returns field of view angle in radians.

◆ linetypeAlternateScaleMultiplier()

double OdGsViewImpl::linetypeAlternateScaleMultiplier ( ) const

virtual

Retrieves alternate linetype scale multiplier.

Implements OdGsView.

◆ linetypeScaleMultiplier()

virtual double OdGsViewImpl::linetypeScaleMultiplier ( ) const

virtual

Returns current linetype scale multiplier value.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implements OdGsView.

◆ lineweightToDcScale()

virtual double OdGsViewImpl::lineweightToDcScale ( ) const

virtual

Returns the scale factor for displaying Lineweights in this Viewport object.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implements OdGsView.

◆ lineweightToPixels() [1/2]

double OdGsViewImpl::lineweightToPixels ( double lineweight ) const

Returns the number of pixels corresponding to the specified lineweight for this view object.

Parameters

lineweight [in] Lineweight.

◆ lineweightToPixels() [2/2]

int OdGsViewImpl::lineweightToPixels ( OdDb::LineWeight lineweight ) const

Returns the number of pixels corresponding to the specified lineweight for this view object.

Parameters

lineweight [in] Lineweight.

◆ loadClientViewState()

virtual bool OdGsViewImpl::loadClientViewState ( OdGsFiler * pFiler )

virtual

Restores client view state from filer object. Must be implemented in client views.

Parameters

pFiler [in] Filer object.

Returns: true.

◆ loadViewState()

virtual bool OdGsViewImpl::loadViewState ( OdGsFiler * pFiler )

virtual

Restores view state from filer object.

Parameters

pFiler [in] Filer object.

Returns: true if view state is successfully loaded, false if metafile or client view could not be read.

◆ localViewportId()

OdUInt32 OdGsViewImpl::localViewportId ( const OdGsBaseModel * pModel ) const

inline

Returns local viewport ID from the passed model.

Parameters

pModel [in] Pointer to GS model.

Definition at line 1534 of file GsViewImpl.h.

◆ mode()

virtual RenderMode OdGsViewImpl::mode ( ) const

virtual

Sets the render mode for this Viewport object.

Remarks: mode 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.

Implements OdGsView.

◆ numLweights()

OdUInt32 OdGsViewImpl::numLweights ( ) const

inline

Returns number of lineweights in lineweights array.

Returns: Array length if lineweights is not empty, or zero otherwise.

Definition at line 1632 of file GsViewImpl.h.

◆ numRootDrawables()

virtual int OdGsViewImpl::numRootDrawables ( ) const

virtual

Retrieves a quantity of root drawables for this viewport.

Implements OdGsView.

◆ objectToDeviceMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::objectToDeviceMatrix ( ) const

virtual

Returns the matrix that transforms coordinates from model space to screen space for this Viewport object.

Implements OdGsView.

Reimplemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >, and OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >.

◆ objectToDeviceMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::objectToDeviceMatrix ( OdGsOverlayId nOverlay ) const

Returns the matrix that transforms coordinates from model space to screen space for this Viewport object.

Parameters

nOverlay [in] Graphics system overlay index.

See also: <link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ ODRX_DECLARE_MEMBERS()

OdGsViewImpl::ODRX_DECLARE_MEMBERS ( OdGsViewImpl )

◆ onFinalRelease()

void OdGsViewImpl::onFinalRelease ( )

protected

Notification function called whenever this ViewImpl object is about to be released.

◆ onWorldToEyeChanged()

void OdGsViewImpl::onWorldToEyeChanged ( )

protected

Notification function called whenever the World to Eye transformation matrix has been changed.

◆ orbit()

virtual void OdGsViewImpl::orbit	(	double	xOrbit,
		double	yOrbit )

virtual

Orbits the camera about the target by the specified amounts.

Parameters

xOrbit	[in] X-axis Orbit.
yOrbit	[in] Y-axis Orbit.

Remarks: the camera moves on the surface a sphere whose center the camera target and whose radius is the distance from the camera position to its target The camera is first rotated about an axis parallel to the X-axis and passing through the target.
The camera is next rotated about an axis parallel to the Y-axis and passing through the target. Camera Coordinates are relative to the view of a target from a camera.
The Y-axis is along up vector. The Z-axis is along the vector from camera position to the target. The X-axis is the cross product Y-axis x Z-axis All angles are expressed in radians.

Implements OdGsView.

◆ pan()

virtual void OdGsViewImpl::pan	(	double	xPan,
		double	yPan )

virtual

Rotates the target about the camera the specified amounts.

Parameters

xPan	[in] X-axis pan.
yPan	[in] Y-axis pan.

Remarks: The target moves on the surface a sphere whose center the camera position and whose radius is the distance from the camera position to its target. The target is first rotated about an axis parallel to the X-axis and passing through the camera.
The target is next rotated about an axis parallel to the Y-axis and passing through the camera.
Camera Coordinates are relative to the view of a target from a camera. The Y-axis is along up vector. The Z-axis is along the vector from camera position to the target. The X-axis is the cross product Y-axis x Z-axis All angles are expressed in radians.

Implements OdGsView.

◆ partialUpdateExtentsEnlargement()

virtual int OdGsViewImpl::partialUpdateExtentsEnlargement ( ) const

virtual

Returns partial update rectange extension in pixels.

Remarks: This extension required for devices which support visual styles to avoid artifacts caused by silhouettes or line extensions.

◆ perspectiveMatrix()

OdGeMatrix3d OdGsViewImpl::perspectiveMatrix ( ) const

Returns the perspective transformation matrix for this view object.

◆ pointInView()

virtual bool OdGsViewImpl::pointInView ( const OdGePoint3d & pt ) const

virtual

Returns true if and only if specified point is visible inside current view frustum.

Parameters

pt	[in] WCS point for check.

Implements OdGsView.

◆ pointInViewport()

virtual bool OdGsViewImpl::pointInViewport ( const OdGePoint2d & screenPoint ) const

virtual

Checks whether the specified point is inside viewport area.

Parameters

screenPoint [in] Check point in device coordinate space.

Returns: true if the passed point is inside the viewport, false otherwise.

Implements OdGsView.

◆ position()

virtual OdGePoint3d OdGsViewImpl::position ( ) const

virtual

Returns the WCS camera position for this Viewport object.

Implements OdGsView.

◆ projectionMatrix() [1/3]

virtual OdGeMatrix3d OdGsViewImpl::projectionMatrix ( ) const

virtual

Returns the matrix that transforms view space to normalized device space for this Viewport object.

Implements OdGsView.

◆ projectionMatrix() [2/3]

OdGeMatrix3d OdGsViewImpl::projectionMatrix	(	double	nearClipPlaneDist,
		double	farClipPlaneDist,
		OdUInt32	projectionFlags ) const

protected

◆ projectionMatrix() [3/3]

OdGeMatrix3d OdGsViewImpl::projectionMatrix	(	OdUInt32	nIncludes,
		OdGsOverlayId	nOverlay = kGsMainOverlay ) const

Returns the matrix that transforms view space to normalized device space for this Viewport object. This method takes into account which components should be included for the matrix and for which overlay to compute the matrix.

Parameters

nIncludes	[in] Specifies which data should be included in the matrix, see ProjectionMatrixFlags.
nOverlay	[in] Graphics system overlay index.

See also: <link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ propagateInvalidVpFlag()

virtual void OdGsViewImpl::propagateInvalidVpFlag ( )

protectedvirtual

◆ propagateLayersChanges()

virtual void OdGsViewImpl::propagateLayersChanges ( )

protectedvirtual

◆ registerOverlay()

virtual void OdGsViewImpl::registerOverlay ( const OdGsModel * pModel )

virtual

Register the overlay for the specified model.

Parameters

pModel [in] Model which overlay should be registered.

◆ removeClippingShape()

void OdGsViewImpl::removeClippingShape ( const OdSiShape * p )

inline

Removes a clipping shape from the array of clipping shapes.

Parameters

pClippingShape [in] Pointer to the clipping shape to remove.

Definition at line 2485 of file GsViewImpl.h.

◆ roll()

virtual void OdGsViewImpl::roll ( double rollAngle )

virtual

Rotates the camera by the specified amount about the eye vector.

Parameters

rollAngle [in] Camera CCW roll angle.

Remarks: Positive angles rotate the camera counterclockwise about the eye vector when viewed from the camera position to the target. This corresponds to a clockwise rotation of the up vector. Camera Coordinates are relative to the view of a target from a camera. The Y-axis is along up-vector. The Z-axis (eye vector) is along the vector from camera position to the target. The X-axis is the cross product Y-axis x Z-axis. All angles are expressed in radians.

Implements OdGsView.

◆ rootDrawableAt()

virtual OdGiDrawablePtr OdGsViewImpl::rootDrawableAt	(	int	i,
		OdGsModelPtr *	pModelReturn = 0 ) const

virtual

Retrieves a smart pointer to transient root drawable at the specified index.

Parameters

i	[in] Index of the drawable to return.
pModelReturn	[in/out] If not NULL, receives a pointer to model of associated drawable holder.

Implements OdGsView.

◆ rootDrawableIdAt()

virtual OdDbStub * OdGsViewImpl::rootDrawableIdAt	(	int	i,
		OdGsModelPtr *	pModelReturn = 0 ) const

virtual

Retrieves a persistent object identifier of the root drawable at the specified index.

Parameters

i	[in] Index of the drawable to return.
pModelReturn	[in/out] If not NULL, receives a pointer to model of associated drawable holder.

Implements OdGsView.

◆ rotationMatrix()

const OdGeMatrix3d & OdGsViewImpl::rotationMatrix ( ) const

Retrieves viewport rotation matrix depending on viewport rotation. This method returns matrix for viewport rotation by 0, 90, 180 and 270 degrees.

◆ safeCast() [1/2]

const OdGsViewImpl * OdGsViewImpl::safeCast ( const OdGsView * pView )

inlinestatic

Returns the specified OdGsView pointer as a pointer to an OdGsViewImpl object.

Parameters

pView [in] Pointer to an OdGsView object.

Definition at line 2404 of file GsViewImpl.h.

◆ safeCast() [2/2]

OdGsViewImpl * OdGsViewImpl::safeCast ( OdGsView * pView )

inlinestatic

Returns the specified OdGsView pointer as a pointer to an OdGsViewImpl object.

Parameters

pView [in] Pointer to an OdGsView object.

Definition at line 2399 of file GsViewImpl.h.

◆ saveClientViewState()

virtual bool OdGsViewImpl::saveClientViewState ( OdGsFiler * pFiler ) const

virtual

Stores client view state into filer object. Must be implemented in client views.

Parameters

pFiler [out] Filer object.

Returns: true.

◆ saveViewState()

virtual bool OdGsViewImpl::saveViewState ( OdGsFiler * pFiler ) const

virtual

Stores current view state into filer object.

Parameters

pFiler [out] Filer object.

Returns: true if view state is successfully saved, false if metafile or client view could not be saved.

◆ sceneDept() [1/2]

virtual bool OdGsViewImpl::sceneDept	(	double &	zNear,
		double &	zFar ) const

protectedvirtual

Reimplemented in OdGsBaseVectorizeView.

◆ sceneDept() [2/2]

virtual bool OdGsViewImpl::sceneDept	(	double &	zNear,
		double &	zFar,
		OdGsOverlayId	nOverlay ) const

protectedvirtual

Returns the minimum and maximum z-values for this view object.

Parameters

zNear	[out] Receives the minimum z-value.
zFar	[out] Receives the maximum z-value.
nOverlay	[in] Overlay buffer index.

Returns: Returns true if and only if this view object has z-values associated with it.

Reimplemented in OdGsBaseVectorizeView.

◆ screenMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::screenMatrix ( ) const

virtual

Returns the matrix that transforms normalized device space to screen space for this Viewport object.

Implements OdGsView.

◆ screenMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::screenMatrix	(	double	nearClipPlaneDist,
		double	farClipPlaneDist ) const

protected

◆ screenRect() [1/2]

void OdGsViewImpl::screenRect	(	OdGePoint2d &	lowerLeft,
		OdGePoint2d &	upperRight ) const

Retrieves screen points that represent a DCS rectangle.

Parameters

lowerLeft	[out] Receives lower-left corner.
upperRight	[out] Receives upper-right corner.

◆ screenRect() [2/2]

void OdGsViewImpl::screenRect	(	OdGsDCPoint &	lowerLeft,
		OdGsDCPoint &	upperRight ) const

Retrieves screen points that represent a DCS rectangle.

Parameters

lowerLeft	[out] Receives lower-left corner.
upperRight	[out] Receives upper-right corner.

◆ screenRectNorm()

void OdGsViewImpl::screenRectNorm ( OdGsDCRect & normalizedRect ) const

Retrieves screen DCS rectangle.

Parameters

normalizedRect [out] Receives a rectangle in normalized device coordinates.

◆ select() [1/2]

virtual void OdGsViewImpl::select	(	const OdGePoint2d *	aPtDc,
		int	numPoints,
		OdGsSelectionReactor *	pReactor,
		SelectionMode	mode = kCrossing )

pure virtual

Runs selection procedure inside this Viewport object.

Parameters

aPtDc	[in] Selection points in device coordinate space.
numPoints	[in] Count of selection points.
pReactor	[in] Selection callback pointer.
mode	[in] Selection mode.

See also: <link tv_working_with_features_selections, Work with Selections>

Implemented in OdGsBaseVectorizeView.

◆ select() [2/2]

virtual void OdGsViewImpl::select	(	const OdGsDCPoint *	points,
		int	numPoints,
		OdGsSelectionReactor *	pReactor,
		SelectionMode	mode = kCrossing )

virtual

Evokes the specified OdGsSelectionReactor object for the specified polygon in this VectorizeView object.

Parameters

points	[in] Array of points.
numPoints	[in] Number of points.
pReactor	[in] Pointer to the reactor.
mode	[in] Selection mode.

Implements OdGsView.

◆ setAccumulateVpChanges()

void OdGsViewImpl::setAccumulateVpChanges ( bool bSet )

inlineprotected

Definition at line 2434 of file GsViewImpl.h.

◆ setAlternateLinetypeScaleMultiplier()

virtual void OdGsViewImpl::setAlternateLinetypeScaleMultiplier ( double linetypeAlternateScaleMultiplier )

virtual

Sets a multiplier that could be used as an alternate scale factor for linetypes in this Viewport object.

Parameters

linetypeAlternateScaleMultiplier [in] Alternate linetype scale multiplier.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implements OdGsView.

◆ setBackClip()

virtual void OdGsViewImpl::setBackClip ( double distance )

virtual

Sets the back clip distance from the target of this Viewport object.

Parameters

distance [in] Back clip distance.

Implements OdGsView.

◆ setBackground()

virtual void OdGsViewImpl::setBackground ( OdDbStub * backgroundId )

virtual

Sets background object for this view.

Parameters

backgroundId [in] New background object ID.

See also: <link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Implements OdGsView.

◆ setCenter()

void OdGsViewImpl::setCenter ( const OdGePoint2d & center )

◆ setCheckValid()

void OdGsViewImpl::setCheckValid ( bool bValue ) const

inlineprotected

Definition at line 2303 of file GsViewImpl.h.

◆ setClearColor()

virtual void OdGsViewImpl::setClearColor ( ClearColor color )

virtual

Sets the clear color for this view.

Parameters

color [in] The clear color.

Implements OdGsView.

◆ setClippingShapes()

void OdGsViewImpl::setClippingShapes ( const OdSiShapeConstPtrArray & s )

inline

Sets the array of pointers to clipping shapes. All previously set elements in the array are overrided.

Parameters

s	[in] Array of pointers to clipping shapes.

Definition at line 2497 of file GsViewImpl.h.

◆ setCompletelyVisible()

void OdGsViewImpl::setCompletelyVisible ( bool val )

inline

Definition at line 2444 of file GsViewImpl.h.

◆ setContextualColors()

void OdGsViewImpl::setContextualColors ( OdGiContextualColors * pColors )

inline

Sets contextual colors.

Parameters

pColors [in] Pointer to the context-dependent colors storage.

Definition at line 2277 of file GsViewImpl.h.

◆ setCullingVolume()

void OdGsViewImpl::setCullingVolume ( OdGsCullingVolumePtr newVol )

Sets culling volume associated with current view.

Parameters

newVol [in] Smart pointer to new culling volume object.

See also: cullingVolume initCullingVolume

◆ setEnableBackClip()

virtual void OdGsViewImpl::setEnableBackClip ( bool enable )

virtual

Controls the back clipping of this Viewport object.

Parameters

enable [in] Enables or disables back clipping.

Implements OdGsView.

◆ setEnableFrontClip()

virtual void OdGsViewImpl::setEnableFrontClip ( bool enable )

virtual

Controls the front clipping of this Viewport object.

Parameters

enable [in] Enables or disables front clipping.

Implements OdGsView.

◆ setFrontClip()

virtual void OdGsViewImpl::setFrontClip ( double distance )

virtual

Sets the front clip distance from the target of this Viewport object.

Parameters

distance [in] Front clip distance.

Implements OdGsView.

◆ setInvalid()

void OdGsViewImpl::setInvalid ( bool bValue ) const

inlineprotected

Definition at line 2313 of file GsViewImpl.h.

◆ setInversion()

void OdGsViewImpl::setInversion	(	bool	invertedX,
		bool	invertedY )

Specifies whether view should be inverted by x- or y- axis.

Parameters

invertedX	[in] Specifies whether to invert the x-axis.
invertedY	[in] Specifies whether to invert the y-axis.

Remarks: Since layout view can be rotated to 90, 180 or 270 degrees (for printing), views linked to viewports of this layout must be rotated accordingly. To determine viewport's rotation angle by coordinates it's corner points it's necessary to know whether overall layout's window coordinates are inverted.
For example, overall layout's output rectangle can be (0,0)-(100,100) or (0,100)-(100,0). This means invertedX == invertedY == false in the first case and invertedX = false, invertedY == true in the second. Vieport with coordinates (10,10)-(90,90) inside this layout will be considered unrotated in the first case or rotated to 270 degrees in the second case.

◆ setLegacyHiddenMode()

virtual void OdGsViewImpl::setLegacyHiddenMode ( bool bSet )

virtual

◆ setLegacyWireframeMode()

virtual void OdGsViewImpl::setLegacyWireframeMode ( bool bSet )

virtual

◆ setLensLength()

virtual void OdGsViewImpl::setLensLength ( double lensLength )

virtual

Sets the perspective lens length for this Viewport object.

Parameters

lensLength [in] Perspective lens length.

Implements OdGsView.

◆ setLinetypeScaleMultiplier()

virtual void OdGsViewImpl::setLinetypeScaleMultiplier ( double linetypeScaleMultiplier )

virtual

Sets a multiplier that is used to scale all linetypes in this Viewport object.

Parameters

linetypeScaleMultiplier [in] Linetype scale multiplier.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implements OdGsView.

◆ setLineweightEnum()

virtual void OdGsViewImpl::setLineweightEnum	(	int	numLineweights,
		const OdUInt8 *	lineweights,
		const OdUInt16 *	altSourceLwds )

virtual

Sets the lineweights for this Viewport object.

Parameters

numLineweights	[in] Number of Lineweights.
lineweights	[in] Array of Lineweights.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implements OdGsView.

◆ setLineweightToDcScale()

virtual void OdGsViewImpl::setLineweightToDcScale ( double scale )

virtual

Sets the scale factor for displaying Lineweights in this Viewport object.

Parameters

scale [in] Scale factor.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implements OdGsView.

◆ setMode()

virtual void OdGsViewImpl::setMode ( RenderMode mode )

virtual

Sets the render mode for this Viewport object.

Parameters

mode	[in] Render mode.

Remarks: mode 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.

Implements OdGsView.

◆ setModeOverride()

bool OdGsViewImpl::setModeOverride ( RenderMode mode )

Sets the render mode override for this Viewport object.

Parameters

mode	[in] Render mode.

Remarks: mode 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.

◆ setPerspectiveEnabled()

void OdGsViewImpl::setPerspectiveEnabled ( bool bValue ) const

inlineprotected

Definition at line 2318 of file GsViewImpl.h.

◆ setPlotTransparency()

virtual void OdGsViewImpl::setPlotTransparency ( bool bSet )

virtual

Specifies whether to plot transparency in this view.

Parameters

bSet	[in] Flag that specifies whether to plot transparency.

◆ setRegenOnDrawForbidden()

void OdGsViewImpl::setRegenOnDrawForbidden ( bool val )

inline

Definition at line 2424 of file GsViewImpl.h.

◆ setShowFrozenLayers()

void OdGsViewImpl::setShowFrozenLayers ( bool bSet )

inlinevirtual

If show frozen layers flag is true then kDrawLayerOff|kDrawLayerFrozen flags will be force set before of vectorization.

Parameters

bSet	[in] show frozen layers mode status.

Definition at line 2454 of file GsViewImpl.h.

◆ setSnapping()

void OdGsViewImpl::setSnapping ( bool val )

inline

Definition at line 2414 of file GsViewImpl.h.

◆ setStereoParameters()

virtual void OdGsViewImpl::setStereoParameters	(	double	magnitude,
		double	parallax )

virtual

Sets the stereo parameters for this Viewport Object.

Parameters

magnitude	[in] View separation [0.0 .. 2.0].
parallax	[in] Adjusts the plane of zero parallax [0.0 .. 2.0].

Remarks: magnitude controls view eye separation, and hence the stereo effect. A magnitude of 1.0 is the default value. A magnitude of 0.0 produces no stereo effect. A magnitude of 2.0 produces a double stereo effect. parallax adjusts the zero parallax plane. A parallax of 1.0 is the default value. An object centered at the target will be half-in and half-out of the screen. A parallax of 0.0 moves the object into the screen. A parallax of 2.0 move the object out of the screen.

Implements OdGsView.

◆ setView()

virtual void OdGsViewImpl::setView	(	const OdGePoint3d &	position,
		const OdGePoint3d &	target,
		const OdGeVector3d &	upVector,
		double	fieldWidth,
		double	fieldHeight,
		Projection	projection = kParallel )

virtual

Sets the camera parameters for this Viewport object.

Parameters

position	[in] Camera position.
target	[in] Camera target.
upVector	[in] Camera up vector.
fieldWidth	[in] Projection plane (field) width.
fieldHeight	[in] Projection plane (field) height.
projectionType	[in] Projection type.

Remarks: This method defines the transformation from WCS coordinates to normalized device coordinates. All parameters are in WCS coordinates. projectionType must be one of the following:

Value kParallel 0 kPerspective 1

Implements OdGsView.

◆ setViewport() [1/3]

virtual void OdGsViewImpl::setViewport	(	const OdGePoint2d &	lowerLeft,
		const OdGePoint2d &	upperRight )

virtual

Sets the size and position of this Viewport object.

Parameters

lowerLeft	[in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0].

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right. The View object can be partly or completely off screen.

Implements OdGsView.

◆ setViewport() [2/3]

virtual void OdGsViewImpl::setViewport ( const OdGsDCRect & screenRect )

virtual

Sets the size and position of this Viewport object.

Parameters

screenRect [in] Screen rectangle in device coordinates (pixels).

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right.; The View object can be partly or completely off screen.

Implements OdGsView.

◆ setViewport() [3/3]

virtual void OdGsViewImpl::setViewport ( const OdGsDCRectDouble & screenRec )

virtual

Sets the size and position of this Viewport object.

Parameters

screenRect [in] Screen rectangle in device coordinates (pixels).

Remarks: (0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right. The View object can be partly or completely off screen.

Reimplemented from OdGsView.

◆ setViewport3dClipping()

virtual void OdGsViewImpl::setViewport3dClipping	(	const OdGiClipBoundary *	pBoundary,
		const OdGiAbstractClipBoundary *	pClipInfo = NULL )

virtual

Defines the 3d clipping for this Viewport object.

Parameters

pBoundary	[in] 3d clipping boundary.
pClipInfo	[in] Optional 3d clipping boundary extended data.

Reimplemented from OdGsView.

◆ setViewportBorderProperties()

virtual void OdGsViewImpl::setViewportBorderProperties	(	ODCOLORREF	color,
		int	width )

virtual

Sets the color and width of the border for this Viewport object.

Parameters

color	[in] Border color.
width	[in] Border width in pixels.

Implements OdGsView.

◆ setViewportBorderVisibility()

virtual void OdGsViewImpl::setViewportBorderVisibility ( bool visible )

virtual

Controls the border visibility for this Viewport object.

Parameters

visible [in] Controls visibility.

Implements OdGsView.

◆ setViewportClipRegion() [1/2]

virtual void OdGsViewImpl::setViewportClipRegion	(	int	numContours,
		const int *	numVertices,
		const OdGePoint2d *	vertices )

virtual

Defines a polygonal clip region for this Viewport object.

Parameters

numCoutours	[in] Number of polygonal contours.
numVertices	[in] Array of the number of vertices in each polygonal contour.
vertices	[in] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

◆ setViewportClipRegion() [2/2]

virtual void OdGsViewImpl::setViewportClipRegion	(	int	numContours,
		int const *	numVertices,
		OdGsDCPoint const *	vertices )

virtual

Defines a polygonal clip region for this Viewport object.

Parameters

numCoutours	[in] Number of polygonal contours.
numVertices	[in] Array of the number of vertices in each polygonal contour.
vertices	[in] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

◆ setVisualStyle() [1/2]

virtual void OdGsViewImpl::setVisualStyle ( const OdGiVisualStyle & visualStyle )

virtual

Sets visual style for this view.

Parameters

visualStyle [in] New visual style data.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implements OdGsView.

Reimplemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >, and OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >.

◆ setVisualStyle() [2/2]

virtual void OdGsViewImpl::setVisualStyle ( OdDbStub * visualStyleId )

virtual

Sets visual style object for this view.

Parameters

visualStyleId [in] New visual style object ID.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implements OdGsView.

◆ show()

virtual void OdGsViewImpl::show ( )

virtual

Un-hides this Viewport object.

Implements OdGsView.

◆ ssaoMode()

bool OdGsViewImpl::ssaoMode ( ) const

inlinevirtual

Returns ambient occlusion mode for current Viewport object.

Returns: true if ambient occlusion enabled for current view or false otherwise.

Implements OdGsView.

Definition at line 2358 of file GsViewImpl.h.

◆ target()

virtual OdGePoint3d OdGsViewImpl::target ( ) const

virtual

Returns the WCS camera target for this Viewport object.

Implements OdGsView.

◆ thawLayer()

virtual void OdGsViewImpl::thawLayer ( OdDbStub * layerID )

virtual

Thaws the specified Layer object in this Viewport object.

Parameters

layerID [in] Layer to thaw.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implements OdGsView.

◆ unregisterOverlay()

virtual void OdGsViewImpl::unregisterOverlay ( const OdGsModel * pModel )

virtual

Unregister the overlay for the specified model.

Parameters

pModel [in] Model which overlay should be unregistered.

◆ unrotatedFieldHeight()

double OdGsViewImpl::unrotatedFieldHeight ( ) const

Returns field height of unrotated viewport considering window aspect ration.

Remarks: When viewport is not rotated (or rotated 180) +--------------—* m_dcScreenMax | | | | | | fieldHeight | | unrotatedFieldHeight | | |m_dcScreenMin | --------------—+ fieldWidth unrotatedFieldWidth

When viewport is rotated to 90 or 270: m_dcScreenMin --------------—+ | | | | | | fieldHeight | | unrotatedFieldWidth | | | | +--------------—* m_dcScreenMax fieldWidth unrotatedFieldHeight

◆ unrotatedFieldWidth()

double OdGsViewImpl::unrotatedFieldWidth ( ) const

Returns field width of unrotated viewport considering window aspect ration.

Remarks: When viewport is not rotated (or rotated 180) +--------------—* m_dcScreenMax | | | | | | fieldHeight | | unrotatedFieldHeight | | |m_dcScreenMin | --------------—+ fieldWidth unrotatedFieldWidth

When viewport is rotated to 90 or 270: m_dcScreenMin --------------—+ | | | | | | fieldHeight | | unrotatedFieldWidth | | | | +--------------—* m_dcScreenMax fieldWidth unrotatedFieldHeight

◆ updateViewportProperties()

bool OdGsViewImpl::updateViewportProperties ( OdUInt32 incFlags )

Updates viewport properties specified by the passed flags.

Parameters

incFlags [in] Flags that specify which properties to update.

Returns: true if updated properties are not NULL, false otherwise.

◆ updateViewProps()

virtual void OdGsViewImpl::updateViewProps ( bool bFullUpdate = true )

protectedvirtual

◆ upVector()

virtual OdGeVector3d OdGsViewImpl::upVector ( ) const

virtual

Returns the WCS camera up vector for this Viewport object.

Implements OdGsView.

◆ usesDept()

virtual bool OdGsViewImpl::usesDept	(	double *	pMinDeptSupported = 0,
		double *	pMaxDeptSupported = 0 ) const

protectedvirtual

Returns the minimum and maximum depth of this view object.

Parameters

pMinDeptSupported	[out] Receives the minimum depth supported.
pMaxDeptSupported	[out] Receives the maximum depth supported.

Returns: Returns true if and only if this view object supports depth.

Remarks: The default implementation of this function does nothing but return false.

◆ viewExtents()

virtual bool OdGsViewImpl::viewExtents ( OdGeBoundBlock3d & extents ) const

pure virtual

Returns the eye coordinate system extents of this view object.

Parameters

extents [out] Receives the extents.

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

Implemented in OdGsBaseVectorizeView.

◆ viewingMatrix()

virtual OdGeMatrix3d OdGsViewImpl::viewingMatrix ( ) const

virtual

Returns the matrix that transforms world space to view space for this Viewport object.

Implements OdGsView.

◆ viewParameters()

virtual void OdGsViewImpl::viewParameters ( OdGsView * pView ) const

virtual

Sets the view parameters of the specified OdGsView object to that of this Viewport object.

Parameters

pView [out] Receives the view parameters.

Implements OdGsView.

◆ viewport3dClipping()

virtual const OdGiClipBoundary * OdGsViewImpl::viewport3dClipping ( const OdGiAbstractClipBoundary ** ppClipInfo = NULL ) const

virtual

Returns the current 3d clipping for this Viewport object.

Parameters

ppClipInfo [out] Optional 3d clipping boundary extended data.

Reimplemented from OdGsView.

◆ viewport3dClippingObject()

OdGiClipBoundaryWithAbstractData * OdGsViewImpl::viewport3dClippingObject ( )

inline

Returns the current 3d clipping for this Viewport object as single object.

Definition at line 2459 of file GsViewImpl.h.

◆ viewportClipRegion() [1/2]

virtual void OdGsViewImpl::viewportClipRegion	(	OdIntArray &	counts,
		OdGePoint2dArray &	vertices ) const

virtual

Returns a polygonal clip region for this Viewport object.

Parameters

counts	[out] Array of the number of vertices in each polygonal contour.
vertices	[out] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

◆ viewportClipRegion() [2/2]

virtual void OdGsViewImpl::viewportClipRegion	(	OdIntArray &	counts,
		OdGsDCPointArray &	dcPts ) const

virtual

Returns a polygonal clip region for this Viewport object.

Parameters

counts	[out] Array of the number of vertices in each polygonal contour.
vertices	[out] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

◆ viewportDcCorners()

void OdGsViewImpl::viewportDcCorners	(	OdGePoint2d &	lower_left,
		OdGePoint2d &	upper_right ) const

Retrieves viewport points in normalized device coordinates.

Parameters

lowerLeft	[out] Receives lower-left corner.
upperRight	[out] Receives upper-right corner.

◆ viewportId()

OdUInt32 OdGsViewImpl::viewportId ( ) const

inline

Returns the OdGi Viewport ID for this vectorizer.

Remarks: The value returned has no relationship to the CVPORT system variable.

Definition at line 1122 of file GsViewImpl.h.

◆ viewportRotation()

short OdGsViewImpl::viewportRotation ( ) const

Checks how viewport is rotated.

Returns: a value that represents degrees of viewport rotation. This method returns one of the following values: 0, 90, 180, 270.

◆ visualStyle() [1/2]

virtual OdDbStub * OdGsViewImpl::visualStyle ( ) const

virtual

Returns current visual style object ID for this view.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implements OdGsView.

◆ visualStyle() [2/2]

virtual bool OdGsViewImpl::visualStyle ( OdGiVisualStyle & vs ) const

virtual

Returns current visual style for this view.

Parameters

visualStyle [out] OdGiVisualStyle structure to fill by current visual style data.

Returns: true if OdGiVisualStyle structure is filled by visual style data.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implements OdGsView.

◆ windowAspect()

double OdGsViewImpl::windowAspect ( ) const

Returns the width to height ratio for this view object.

◆ worldToDeviceMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::worldToDeviceMatrix ( ) const

virtual

Returns a matrix that transforms coordinates from world space to screen space for this Viewport object.

Remarks: This is equivalent to the concatenation of the viewingMatrix, projectionMatrix, and screenMatrix.

Implements OdGsView.

◆ worldToDeviceMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::worldToDeviceMatrix ( OdGsOverlayId nOverlay ) const

Returns a matrix that transforms coordinates from world space to screen space for this Viewport object.

Parameters

nOverlay [in] Graphics system overlay index.

Remarks: This is equivalent to the concatenation of the viewingMatrix, projectionMatrix, and screenMatrix.

See also: <link tv_graphSysOverlays, Work with Graphic System Overlays>

◆ worldToEyeMatrix()

const OdGeMatrix3d & OdGsViewImpl::worldToEyeMatrix ( ) const

inline

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

Definition at line 2389 of file GsViewImpl.h.

◆ xVector()

const OdGeVector3d & OdGsViewImpl::xVector ( ) const

inline

Retrieves x vector that defines camera x-axis.

Definition at line 1472 of file GsViewImpl.h.

◆ zoom()

virtual void OdGsViewImpl::zoom ( double zoomFactor )

virtual

Scales the focal length of the camera by the specified amount.

Parameters

zoomFactor [in] Zoom factor.

Implements OdGsView.

◆ zoomExtents()

virtual void OdGsViewImpl::zoomExtents	(	const OdGePoint3d &	minPt,
		const OdGePoint3d &	maxPt )

virtual

Scales the camera to completely include specified WCS box inside view frustum.

Parameters

minPt	[in] minimal WCS box point.
maxPt	[in] maximal WCS box point.

Implements OdGsView.

◆ zoomWindow()

virtual void OdGsViewImpl::zoomWindow	(	const OdGePoint2d &	lowerLeft,
		const OdGePoint2d &	upperRight )

virtual

Scales the camera to completely include specified screen area.

Parameters

lowerLeft	[in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0].

Implements OdGsView.

Friends And Related Symbol Documentation

◆ GsViewImplHelper

friend class GsViewImplHelper

friend

Definition at line 2245 of file GsViewImpl.h.

◆ OdGiBaseVectorizerImpl

friend class OdGiBaseVectorizerImpl

friend

Definition at line 2246 of file GsViewImpl.h.

◆ OdGsBaseModule

friend class OdGsBaseModule

friend

Definition at line 2248 of file GsViewImpl.h.

◆ OdGsBaseVectorizeDevice

friend class OdGsBaseVectorizeDevice

friend

Definition at line 2249 of file GsViewImpl.h.

◆ OdGsBaseVectorizer

friend class OdGsBaseVectorizer

friend

Definition at line 2247 of file GsViewImpl.h.

Member Data Documentation

◆ m_antiAliasingMode

OdUInt32 OdGsViewImpl::m_antiAliasingMode

protected

Definition at line 2187 of file GsViewImpl.h.

◆ m_backClipDist

double OdGsViewImpl::m_backClipDist

protected

Definition at line 2144 of file GsViewImpl.h.

◆ m_bInInteractivityMode

bool OdGsViewImpl::m_bInInteractivityMode

protected

Definition at line 2242 of file GsViewImpl.h.

◆ m_borderColor

ODCOLORREF OdGsViewImpl::m_borderColor

protected

Definition at line 2141 of file GsViewImpl.h.

◆ m_borderWeight

int OdGsViewImpl::m_borderWeight

protected

Definition at line 2142 of file GsViewImpl.h.

◆ m_center

OdGePoint2d OdGsViewImpl::m_center

protected

Definition at line 2162 of file GsViewImpl.h.

◆ m_clippingShapes

OdSiShapeConstPtrArray OdGsViewImpl::m_clippingShapes

protected

Definition at line 2175 of file GsViewImpl.h.

◆ m_dcLowerLeft

OdGePoint2d OdGsViewImpl::m_dcLowerLeft

protected

Definition at line 2149 of file GsViewImpl.h.

◆ m_dcScreenMax

OdGePoint2d OdGsViewImpl::m_dcScreenMax

protected

Definition at line 2148 of file GsViewImpl.h.

◆ m_dcScreenMin

OdGePoint2d OdGsViewImpl::m_dcScreenMin

protected

Definition at line 2147 of file GsViewImpl.h.

◆ m_dcUpperRight

OdGePoint2d OdGsViewImpl::m_dcUpperRight

protected

Definition at line 2150 of file GsViewImpl.h.

◆ m_defaultLightingType

DefaultLightingType OdGsViewImpl::m_defaultLightingType

protected

Definition at line 2186 of file GsViewImpl.h.

◆ m_deviation

double OdGsViewImpl::m_deviation[5]

protected

Definition at line 2177 of file GsViewImpl.h.

◆ m_dInteractivityFrameRate

double OdGsViewImpl::m_dInteractivityFrameRate

protected

Definition at line 2243 of file GsViewImpl.h.

◆ m_drawables

DrawableHolderArray OdGsViewImpl::m_drawables

protected

Definition at line 2238 of file GsViewImpl.h.

◆ m_eyeToWorld

OdGeMatrix3d OdGsViewImpl::m_eyeToWorld

mutableprotected

Definition at line 2163 of file GsViewImpl.h.

◆ m_eyeVecLength

double OdGsViewImpl::m_eyeVecLength

protected

Definition at line 2155 of file GsViewImpl.h.

◆ m_eyeVector

OdGeVector3d OdGsViewImpl::m_eyeVector

protected

Definition at line 2160 of file GsViewImpl.h.

◆ m_fieldHeight

double OdGsViewImpl::m_fieldHeight

protected

Definition at line 2153 of file GsViewImpl.h.

◆ m_fieldWidth

double OdGsViewImpl::m_fieldWidth

protected

Definition at line 2152 of file GsViewImpl.h.

◆ m_frontClipDist

double OdGsViewImpl::m_frontClipDist

protected

Definition at line 2143 of file GsViewImpl.h.

◆ m_frozenLayers

OdDbStubPtrArray OdGsViewImpl::m_frozenLayers

protected

Definition at line 2240 of file GsViewImpl.h.

◆ m_frozenLayersDiff

OdDbStubPtrArray OdGsViewImpl::m_frozenLayersDiff

protected

Definition at line 2138 of file GsViewImpl.h.

◆ m_giViewportId

OdUInt32 OdGsViewImpl::m_giViewportId

protected

Definition at line 2229 of file GsViewImpl.h.

◆ m_gsViewImplFlags

OdUInt32 OdGsViewImpl::m_gsViewImplFlags

mutableprotected

Definition at line 2140 of file GsViewImpl.h.

◆ m_lastFrozenLayers

OdDbStubPtrArray OdGsViewImpl::m_lastFrozenLayers

protected

Definition at line 2135 of file GsViewImpl.h.

◆ m_lensLength

double OdGsViewImpl::m_lensLength

protected

Definition at line 2154 of file GsViewImpl.h.

◆ m_linetypeAlternateScaleMultiplier

double OdGsViewImpl::m_linetypeAlternateScaleMultiplier

protected

Definition at line 2169 of file GsViewImpl.h.

◆ m_linetypeScaleMultiplier

double OdGsViewImpl::m_linetypeScaleMultiplier

protected

Definition at line 2168 of file GsViewImpl.h.

◆ m_lineweightToDcScale

double OdGsViewImpl::m_lineweightToDcScale

protected

Definition at line 2170 of file GsViewImpl.h.

◆ m_localId

OdGsViewLocalId OdGsViewImpl::m_localId

protected

Definition at line 2230 of file GsViewImpl.h.

◆ m_lweights

OdUInt8Array OdGsViewImpl::m_lweights

protected

Definition at line 2171 of file GsViewImpl.h.

◆ m_lweights2x

OdUInt16Array OdGsViewImpl::m_lweights2x

protected

Definition at line 2172 of file GsViewImpl.h.

◆ m_mtExtents

OdMutexPtr OdGsViewImpl::m_mtExtents

mutableprotected

Definition at line 2180 of file GsViewImpl.h.

◆ m_nCachedDrawables

int OdGsViewImpl::m_nCachedDrawables

protected

Definition at line 2179 of file GsViewImpl.h.

◆ m_nrcCounts

OdIntArray OdGsViewImpl::m_nrcCounts

protected

Definition at line 2166 of file GsViewImpl.h.

◆ m_nrcPoints

OdGePoint2dArray OdGsViewImpl::m_nrcPoints

protected

Definition at line 2167 of file GsViewImpl.h.

◆ m_overlayData

GsViewOverlayDataContainer OdGsViewImpl::m_overlayData

mutableprotected

Definition at line 2223 of file GsViewImpl.h.

◆ m_p3dClip

OdSharedPtr<OdGiClipBoundaryWithAbstractData> OdGsViewImpl::m_p3dClip

protected

Definition at line 2174 of file GsViewImpl.h.

◆ m_pBackgroundId

OdDbStub* OdGsViewImpl::m_pBackgroundId

protected

Definition at line 2183 of file GsViewImpl.h.

◆ m_pCullingVolume

OdGsCullingVolumePtr OdGsViewImpl::m_pCullingVolume

protected

Definition at line 2173 of file GsViewImpl.h.

◆ m_pDevice

OdGsBaseVectorizeDevice* OdGsViewImpl::m_pDevice

protected

Definition at line 2227 of file GsViewImpl.h.

◆ m_pGsReserved

OdRxObjectPtr OdGsViewImpl::m_pGsReserved

protected

Definition at line 2233 of file GsViewImpl.h.

◆ m_pModule

OdGsBaseModulePtr OdGsViewImpl::m_pModule

protected

Definition at line 2137 of file GsViewImpl.h.

◆ m_position

OdGePoint3d OdGsViewImpl::m_position

protected

Definition at line 2157 of file GsViewImpl.h.

◆ m_pProperties

OdGsPropertiesPtr OdGsViewImpl::m_pProperties

protected

Definition at line 2182 of file GsViewImpl.h.

◆ m_pViewportTrans

OdGiDrawablePtr OdGsViewImpl::m_pViewportTrans

protected

Definition at line 2185 of file GsViewImpl.h.

◆ m_pVisualStyleId

OdDbStub* OdGsViewImpl::m_pVisualStyleId

protected

Definition at line 2184 of file GsViewImpl.h.

◆ m_regenerationType

OdGiRegenType OdGsViewImpl::m_regenerationType

protected

Definition at line 2231 of file GsViewImpl.h.

◆ m_renderMode

RenderMode OdGsViewImpl::m_renderMode

protected

Definition at line 2236 of file GsViewImpl.h.

◆ m_screenInvertedX

bool OdGsViewImpl::m_screenInvertedX

protected

Definition at line 2145 of file GsViewImpl.h.

◆ m_screenInvertedY

bool OdGsViewImpl::m_screenInvertedY

protected

Definition at line 2146 of file GsViewImpl.h.

◆ m_target

OdGePoint3d OdGsViewImpl::m_target

protected

Definition at line 2158 of file GsViewImpl.h.

◆ m_upVector

OdGeVector3d OdGsViewImpl::m_upVector

protected

Definition at line 2159 of file GsViewImpl.h.

◆ m_viewInfo

OdGsClientViewInfo OdGsViewImpl::m_viewInfo

protected

Definition at line 2228 of file GsViewImpl.h.

◆ m_worldToEye

OdGeMatrix3d OdGsViewImpl::m_worldToEye

mutableprotected

Definition at line 2164 of file GsViewImpl.h.

◆ m_xVector

OdGeVector3d OdGsViewImpl::m_xVector

protected

Definition at line 2161 of file GsViewImpl.h.

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

GsViewImpl.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ ProjectionMatrixFlags

Constructor & Destructor Documentation

◆ OdGsViewImpl()

◆ ~OdGsViewImpl()

Member Function Documentation

◆ actualFieldHeight()

◆ actualFieldWidth()

◆ add()

◆ addClippingShape()

◆ annotationScaleId()

◆ antiAliasingMode()

◆ backClip()

◆ background()

◆ baseDevice() [1/2]

◆ baseDevice() [2/2]

◆ beginInteractivity()

◆ cachedDrawables()

◆ calcDeviation()

◆ center()

◆ clearColor()

◆ clearFrozenLayers()

◆ clearLinetypeCache()

◆ clientViewInfo()

◆ clippingShapes()

◆ cloneView()

◆ contextualColors()

◆ cullingVolume()

◆ cullingVolumeIntersectWith()

◆ cullingVolumeIntersectWithOpt()

◆ cullingVolumeTransformBy()

◆ dcLowerLeft()

◆ dcScreenMax()

◆ dcScreenMin()

◆ dcUpperRight()

◆ defaultLightingEnabled()

◆ defaultLightingType()

◆ device()

◆ doInversePerspectivePt()

◆ dolly() [1/2]

◆ dolly() [2/2]

◆ doPerspectivePt()

◆ drawableAt()

◆ drawablesFilterFunction()

◆ enableAntiAliasing()

◆ enableDefaultLighting()

◆ enableSSAO()

◆ enableStereo()

◆ endInteractivity()

◆ erase()

◆ eraseAll()

◆ exceededBounds()

◆ extentsInView()

◆ extentsToPixels()

◆ eyeToScreenMatrix() [1/2]

◆ eyeToScreenMatrix() [2/2]

◆ eyeToWorldMatrix()

◆ eyeVector()

◆ fieldHeight()

◆ fieldWidth()

◆ flush()

◆ focalLength()

◆ focusPoint()

◆ freezeLayer()

◆ frontClip()

◆ frozenLayers() [1/2]

◆ frozenLayers() [2/2]

◆ getClippingPlanes()

◆ getDeviation()

◆ getFrozenLayersDiff()

◆ getGsModulePtr()

◆ getLinetypeGenerationCriteria()